Source for org.jfree.xml.factory.objects.CharacterObjectDescription

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class library for the Java(tm) platform
   3:  * ========================================================================
   4:  *
   5:  * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
   6:  * 
   7:  * Project Info:  http://www.jfree.org/jcommon/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  * 
  27:  * -------------------------------
  28:  * CharacterObjectDescription.java
  29:  * -------------------------------
  30:  * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
  31:  *
  32:  * Original Author:  Thomas Morgner;
  33:  * Contributor(s):   David Gilbert (for Object Refinery Limited);
  34:  *
  35:  * $Id: CharacterObjectDescription.java,v 1.3 2005/11/14 10:59:44 mungady Exp $
  36:  *
  37:  * Changes (from 19-Feb-2003)
  38:  * -------------------------
  39:  * 19-Feb-2003 : Added standard header and Javadocs (DG);
  40:  * 29-Apr-2003 : Distilled from the JFreeReport project and moved into JCommon
  41:  *
  42:  */
  43: 
  44: package org.jfree.xml.factory.objects;
  45: 
  46: /**
  47:  * An object-description for a <code>Character</code> object.
  48:  *
  49:  * @author Thomas Morgner
  50:  */
  51: public class CharacterObjectDescription extends AbstractObjectDescription {
  52: 
  53:     /**
  54:      * Creates a new object description.
  55:      */
  56:     public CharacterObjectDescription() {
  57:         super(Character.class);
  58:         setParameterDefinition("value", String.class);
  59:     }
  60: 
  61:     /**
  62:      * Creates a new object (<code>Character</code>) based on this description object.
  63:      *
  64:      * @return The <code>Character</code> object.
  65:      */
  66:     public Object createObject() {
  67:         final String o = (String) getParameter("value");
  68:         if (o == null) {
  69:             return null;
  70:         }
  71:         if (o.length() > 0) {
  72:             return new Character(o.charAt(0));
  73:         }
  74:         else {
  75:             return null;
  76:         }
  77:     }
  78: 
  79:     /**
  80:      * Sets the parameters of this description object to match the supplied object.
  81:      *
  82:      * @param o  the object (should be an instance of <code>Character</code>).
  83:      * @throws ObjectFactoryException if there is a
  84:      * problem while reading the properties of the given object.
  85:      */
  86:     public void setParameterFromObject(final Object o) throws ObjectFactoryException {
  87:         if (!(o instanceof Character)) {
  88:             throw new ObjectFactoryException("The given object is no java.lang.Character.");
  89:         }
  90: 
  91:         setParameter("value", String.valueOf(o));
  92:     }
  93: 
  94:     /**
  95:      * Tests for equality.
  96:      * 
  97:      * @param o  the object to test.
  98:      * 
  99:      * @return A boolean.
 100:      */
 101:     public boolean equals(final Object o) {
 102:         if (this == o) {
 103:             return true;
 104:         }
 105:         if (!(o instanceof AbstractObjectDescription)) {
 106:             return false;
 107:         }
 108: 
 109:         final AbstractObjectDescription abstractObjectDescription = (AbstractObjectDescription) o;
 110: 
 111:         if (Character.TYPE.equals(abstractObjectDescription.getObjectClass())) {
 112:             return true;
 113:         }
 114:         if (Character.class.equals(abstractObjectDescription.getObjectClass())) {
 115:             return true;
 116:         }
 117:         return false;
 118:     }
 119: 
 120:     /**
 121:      * Returns a hash code for the object.
 122:      * 
 123:      * @return The hash code.
 124:      */
 125:     public int hashCode() {
 126:         return getObjectClass().hashCode();
 127:     }
 128: 
 129: }