001: /*--
002: $Id: StringConverter.java,v 1.1 2004/03/01 07:56:03 wolfpaulus Exp $
003:
004: Copyright (C) 2003-2007 Wolf Paulus.
005: All rights reserved.
006:
007: Redistribution and use in source and binary forms, with or without
008: modification, are permitted provided that the following conditions
009: are met:
010:
011: 1. Redistributions of source code must retain the above copyright
012: notice, this list of conditions, and the following disclaimer.
013:
014: 2. Redistributions in binary form must reproduce the above copyright
015: notice, this list of conditions, and the disclaimer that follows
016: these conditions in the documentation and/or other materials provided
017: with the distribution.
018:
019: 3. The end-user documentation included with the redistribution,
020: if any, must include the following acknowledgment:
021: "This product includes software developed by the
022: SWIXML Project (http://www.swixml.org/)."
023: Alternately, this acknowledgment may appear in the software itself,
024: if and wherever such third-party acknowledgments normally appear.
025:
026: 4. The name "Swixml" must not be used to endorse or promote products
027: derived from this software without prior written permission. For
028: written permission, please contact <info_AT_swixml_DOT_org>
029:
030: 5. Products derived from this software may not be called "Swixml",
031: nor may "Swixml" appear in their name, without prior written
032: permission from the Swixml Project Management.
033:
034: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
035: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
036: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
037: DISCLAIMED. IN NO EVENT SHALL THE SWIXML PROJECT OR ITS
038: CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
039: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
040: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
041: USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
042: ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
043: OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
044: OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
045: SUCH DAMAGE.
046: ====================================================================
047:
048: This software consists of voluntary contributions made by many
049: individuals on behalf of the Swixml Project and was originally
050: created by Wolf Paulus <wolf_AT_swixml_DOT_org>. For more information
051: on the Swixml Project, please see <http://www.swixml.org/>.
052: */
053: package org.swixml.converters;
054:
055: import org.jdom.Attribute;
056: import org.swixml.Converter;
057: import org.swixml.Parser;
058: import org.swixml.Localizer;
059:
060: /**
061: * The StringConverter class defines / describes
062: *
063: *
064: *
065: * @author <a href="mailto:wolf@paulus.com">Wolf Paulus</a>
066: * @version $Revision: 1.1 $
067: *
068: */
069: public class StringConverter implements Converter {
070: /** converter's return type */
071: public static final Class TEMPLATE = String.class;
072:
073: /**
074: * Convert the value of the given <code>Attribute</code> object into an output object of the
075: * specified type.
076: *
077: * @param type <code>Class</code> Data type to which the Attribute's value should be converted
078: * @param attr <code>Attribute</code> the attribute, providing the value to be converted.
079: *
080: */
081: public Object convert(Class type, final Attribute attr,
082: Localizer localizer) throws Exception {
083: //
084: // Localize Strings but only if Attribute calls for localization.
085: //
086: if (Parser.LOCALIZED_ATTRIBUTES.contains(attr.getName()
087: .toLowerCase()))
088: if (attr.getAttributeType() == Attribute.CDATA_TYPE)
089: return localizer.getString(attr.getValue());
090: return attr.getValue();
091: }
092:
093: /**
094: * A <code>Converters</code> conversTo method informs about the Class type the converter
095: * is returning when its <code>convert</code> method is called
096: * @return <code>Class</code> - the Class the converter is returning when its convert method is called
097: */
098: public Class convertsTo() {
099: return TEMPLATE;
100: }
101: }
|