KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > xml > factory > objects > BooleanObjectDescription


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  * BooleanObjectDescription.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: BooleanObjectDescription.java,v 1.3 2005/11/14 10:59:16 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>Boolean</code> object.
48  *
49  * @author Thomas Morgner
50  */
51 public class BooleanObjectDescription extends AbstractObjectDescription {
52
53     /**
54      * Creates a new object description.
55      */
56     public BooleanObjectDescription() {
57         super(Boolean JavaDoc.class);
58         setParameterDefinition("value", String JavaDoc.class);
59     }
60
61     /**
62      * Creates a new <code>Boolean</code> based on the settings of this description object.
63      *
64      * @return A <code>Boolean</code>.
65      */
66     public Object JavaDoc createObject() {
67         final String JavaDoc o = (String JavaDoc) getParameter("value");
68         return Boolean.valueOf(o);
69     }
70
71     /**
72      * Sets the description object parameters to match the supplied object
73      * (which should be an instance of <code>Boolean</code>.
74      *
75      * @param o the object.
76      * @throws ObjectFactoryException if there is a problem while reading the
77      * properties of the given object.
78      */
79     public void setParameterFromObject(final Object JavaDoc o) throws ObjectFactoryException {
80         if (!(o instanceof Boolean JavaDoc)) {
81             throw new ObjectFactoryException("The given object is no java.lang.Boolean. ");
82         }
83         setParameter("value", String.valueOf(o));
84     }
85
86     /**
87      * Tests for equality.
88      *
89      * @param o the object to test.
90      *
91      * @return A boolean.
92      */
93     public boolean equals(final Object JavaDoc o) {
94         if (this == o) {
95             return true;
96         }
97         if (!(o instanceof AbstractObjectDescription)) {
98             return false;
99         }
100
101         final AbstractObjectDescription abstractObjectDescription = (AbstractObjectDescription) o;
102
103         if (Boolean.TYPE.equals(abstractObjectDescription.getObjectClass())) {
104             return true;
105         }
106         if (Boolean JavaDoc.class.equals(abstractObjectDescription.getObjectClass())) {
107             return true;
108         }
109         return false;
110     }
111
112     /**
113      * Returns a hash code.
114      *
115      * @return A hash code.
116      */
117     public int hashCode() {
118         return getObjectClass().hashCode();
119     }
120
121 }
122
Popular Tags