Source for org.jfree.xml.generator.model.PropertyType

   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:  * PropertyType.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: PropertyType.java,v 1.2 2005/10/18 13:32:37 mungady Exp $
  36:  *
  37:  * Changes 
  38:  * -------
  39:  * 12-Nov-2003 : Initial version (TM);
  40:  * 26-Nov-2003 : Updated header and Javadocs (DG);
  41:  * 
  42:  */
  43:  
  44: package org.jfree.xml.generator.model;
  45: 
  46: /**
  47:  * An enumeration over the defined property types.
  48:  * <p>
  49:  * Attribute types are mapped into xml attributes - this is used for
  50:  * primitive data or enumeration classes.
  51:  * <p>
  52:  * Element types are used to define complex classes, a new xml tag will
  53:  * be introduced for every element type.
  54:  * <p>
  55:  * The lookup properties are defined elsewhere and are referenced using
  56:  * the defined name during the class building process. 
  57:  */
  58: public final class PropertyType {
  59:     
  60:     /** A property that is described using an attribute in the XML. */
  61:     public static final PropertyType ATTRIBUTE = new PropertyType("ATTRIBUTE");
  62:     
  63:     /** A property that is described using an XML element. */
  64:     public static final PropertyType ELEMENT = new PropertyType("ELEMENT");
  65:     
  66:     /** A property that is... */
  67:     public static final PropertyType LOOKUP = new PropertyType("LOOKUP");
  68: 
  69:     /** The property type name. */
  70:     private final String myName; // for debug only
  71: 
  72:     /**
  73:      * Private constructor prevents new types being created.
  74:      * 
  75:      * @param name  the type name.
  76:      */
  77:     private PropertyType(final String name) {
  78:         this.myName = name;
  79:     }
  80: 
  81:     /**
  82:      * Returns a string representing the type.
  83:      * 
  84:      * @return a string.
  85:      */
  86:     public String toString() {
  87:         return this.myName;
  88:     }
  89:     
  90: }