KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > swixml > converters > StringConverter


1 /*--
2  $Id: StringConverter.java,v 1.1 2004/03/01 07:56:03 wolfpaulus Exp $
3
4  Copyright (C) 2003-2004 Wolf Paulus.
5  All rights reserved.
6
7  Redistribution and use in source and binary forms, with or without
8  modification, are permitted provided that the following conditions
9  are met:
10
11  1. Redistributions of source code must retain the above copyright
12  notice, this list of conditions, and the following disclaimer.
13
14  2. Redistributions in binary form must reproduce the above copyright
15  notice, this list of conditions, and the disclaimer that follows
16  these conditions in the documentation and/or other materials provided
17  with the distribution.
18
19  3. The end-user documentation included with the redistribution,
20  if any, must include the following acknowledgment:
21         "This product includes software developed by the
22          SWIXML Project (http://www.swixml.org/)."
23  Alternately, this acknowledgment may appear in the software itself,
24  if and wherever such third-party acknowledgments normally appear.
25
26  4. The name "Swixml" must not be used to endorse or promote products
27  derived from this software without prior written permission. For
28  written permission, please contact <info_AT_swixml_DOT_org>
29
30  5. Products derived from this software may not be called "Swixml",
31  nor may "Swixml" appear in their name, without prior written
32  permission from the Swixml Project Management.
33
34  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
35  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
36  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
37  DISCLAIMED. IN NO EVENT SHALL THE SWIXML PROJECT OR ITS
38  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
41  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
42  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
44  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
45  SUCH DAMAGE.
46  ====================================================================
47
48  This software consists of voluntary contributions made by many
49  individuals on behalf of the Swixml Project and was originally
50  created by Wolf Paulus <wolf_AT_swixml_DOT_org>. For more information
51  on the Swixml Project, please see <http://www.swixml.org/>.
52 */
53 package org.swixml.converters;
54
55 import org.jdom.Attribute;
56 import org.swixml.Converter;
57 import org.swixml.Parser;
58 import org.swixml.Localizer;
59
60
61 /**
62  * The StringConverter class defines / describes
63  *
64  *
65  *
66  * @author <a HREF="mailto:wolf@paulus.com">Wolf Paulus</a>
67  * @version $Revision: 1.1 $
68  *
69  */
70 public class StringConverter implements Converter {
71   /** converter's return type */
72   public static final Class JavaDoc TEMPLATE = String JavaDoc.class;
73
74   /**
75    * Convert the value of the given <code>Attribute</code> object into an output object of the
76    * specified type.
77    *
78    * @param type <code>Class</code> Data type to which the Attribute's value should be converted
79    * @param attr <code>Attribute</code> the attribute, providing the value to be converted.
80    *
81    */
82   public Object JavaDoc convert( Class JavaDoc type, final Attribute attr, Localizer localizer ) throws Exception JavaDoc {
83     //
84 // Localize Strings but only if Attribute calls for localization.
85 //
86 if ( Parser.LOCALIZED_ATTRIBUTES.contains( attr.getName().toLowerCase() ))
87       if (attr.getAttributeType() == Attribute.CDATA_TYPE )
88          return localizer.getString( attr.getValue() );
89     return attr.getValue();
90   }
91
92   /**
93    * A <code>Converters</code> conversTo method informs about the Class type the converter
94    * is returning when its <code>convert</code> method is called
95    * @return <code>Class</code> - the Class the converter is returning when its convert method is called
96    */
97   public Class JavaDoc convertsTo() {
98     return TEMPLATE;
99   }
100 }
101
Popular Tags