org.enhydra.zeus.binding
Class AtomicProperty

java.lang.Object
  |
  +--org.enhydra.zeus.binding.BaseBinding
        |
        +--org.enhydra.zeus.binding.BaseProperty
              |
              +--org.enhydra.zeus.binding.AtomicProperty

public class AtomicProperty
extends BaseProperty

AtomicProperty implements the Binding and Property interfaces, and provides for a simple name/value property representation.

An AtomicProperty will most commonly represent simple typed values in Java, such as a String, int, or Date.

Version:
1.0
Author:
Brett McLaughlin, Steve Witten

Fields inherited from class org.enhydra.zeus.binding.BaseProperty
defaultValue, enumeration, isCollection, modifier
 
Fields inherited from class org.enhydra.zeus.binding.BaseBinding
javaName, javaType, xmlName
 
Constructor Summary
AtomicProperty(java.lang.String xmlName, java.lang.String javaType)
           This will create a new AtomicProperty with the specified information.
AtomicProperty(java.lang.String xmlName, java.lang.String javaType, java.util.BitSet modifier, java.util.Vector enumeration, java.lang.Object defaultValue)
           This will create a new AtomicProperty with the specified information.
 
Method Summary
 java.lang.String getJavaName()
           This will return the Java name of the binding.
 
Methods inherited from class org.enhydra.zeus.binding.BaseProperty
BaseProperty, getDefaultValue, getEnumeration, getModifier, getModifierString, hasDefaultValue, hasEnumeration, isCollection, setDefaultValue, setEnumeration, setIsCollection, setModifier
 
Methods inherited from class org.enhydra.zeus.binding.BaseBinding
getJavaType, getXMLName, setJavaType, setXMLName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AtomicProperty

public AtomicProperty(java.lang.String xmlName,
                      java.lang.String javaType,
                      java.util.BitSet modifier,
                      java.util.Vector enumeration,
                      java.lang.Object defaultValue)

This will create a new AtomicProperty with the specified information.

Parameters:
xmlName - the String XML name of this property.
javaType - the Java class name of the property type.
accessModifier - the int constant for the property's access modifier.
See Also:
{@link Property#ACCESS_PRIVATE}, {@link Property#ACCESS_PROTECTED}, {@link Property#ACCESS_PUBLIC}, {@link Property#STORAGE_STATIC}, {@link Property#MUTABILITY_VOLATILE}, {@link Property#MUTABILITY_FINAL}

AtomicProperty

public AtomicProperty(java.lang.String xmlName,
                      java.lang.String javaType)

This will create a new AtomicProperty with the specified information. The property will be, by default, Property.ACCESS_PRIVATE.

Parameters:
xmlName - the String XML name of this property.
javaType - the Java class name of the property type.
Method Detail

getJavaName

public java.lang.String getJavaName()

This will return the Java name of the binding. This should be the valid Java name of the binding, which is most often a variable name. This name will be the result of any conversions that have to be done if the XML name of the binding is not a valid Java identifier.

For example, for a List that is associated with an instance variable named "myList", invoking getJavaName() would return "myList." For a custom object type "Foo", associated with an instance variable "foo", invoking getJavaName() would return "foo".

It's also important to note that there are cases when this would return null. For an object that is top-level, and is not a member variable of any other object, no name will be associated with the binding.

Overrides:
getJavaName in class BaseBinding
Returns:
String - the Java name of the binding.


Copyright © 2001 Enhydra. All Rights Reserved.