001 /* ========================================================================
002 * JCommon : a free general purpose class library for the Java(tm) platform
003 * ========================================================================
004 *
005 * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006 *
007 * Project Info: http://www.jfree.org/jcommon/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022 * USA.
023 *
024 * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025 * in the United States and other countries.]
026 *
027 * ---------------------------
028 * ColorObjectDescription.java
029 * ---------------------------
030 * (C)opyright 2003, 2004, by Thomas Morgner and Contributors.
031 *
032 * Original Author: Thomas Morgner;
033 * Contributor(s): David Gilbert (for Object Refinery Limited);
034 *
035 * $Id: ColorObjectDescription.java,v 1.4 2005/11/14 11:01:17 mungady Exp $
036 *
037 * Changes (from 19-Feb-2003)
038 * -------------------------
039 * 19-Feb-2003 : Added standard header and Javadocs (DG);
040 * 29-Apr-2003 : Distilled from the JFreeReport project and moved into JCommon
041 */
042
043 package org.jfree.xml.factory.objects;
044
045 import java.awt.Color;
046
047 import org.jfree.util.PaintUtilities;
048
049 /**
050 * An object-description for a <code>Color</code> object.
051 *
052 * @author Thomas Morgner
053 */
054 public class ColorObjectDescription extends AbstractObjectDescription {
055
056 /**
057 * Creates a new object description.
058 */
059 public ColorObjectDescription() {
060 super(Color.class);
061 setParameterDefinition("value", String.class);
062 }
063
064 /**
065 * Creates an object based on this description.
066 *
067 * @return The object.
068 */
069 public Object createObject() {
070 final String value = (String) getParameter("value");
071 return PaintUtilities.stringToColor(value);
072 }
073
074 /**
075 * Sets the parameters of this description object to match the supplied object.
076 *
077 * @param o the object (should be an instance of <code>Color</code>).
078 *
079 * @throws ObjectFactoryException if there is a problem while reading the
080 * properties of the given object.
081 */
082 public void setParameterFromObject(final Object o) throws ObjectFactoryException {
083 if (!(o instanceof Color)) {
084 throw new ObjectFactoryException("Is no instance of java.awt.Color");
085 }
086 final Color c = (Color) o;
087 setParameter("value", PaintUtilities.colorToString(c));
088 }
089 }