org.enhydra.zeus.binding
Class ContainerProperty

java.lang.Object
  |
  +--org.enhydra.zeus.binding.BaseBinding
        |
        +--org.enhydra.zeus.binding.ContainerProperty
All Implemented Interfaces:
Binding, Container, Property

public class ContainerProperty
extends BaseBinding
implements Property, Container

ContainerProperty implements the Binding, Property, and Container interfaces, and provides for a complex object that is itself a property.

A ContainerProperty will most commonly represent a Java Object that has properties of its own (like any other ContainerObject.

Version:
1.0
Author:
Brett McLaughlin

Field Summary
protected  int accessModifier
          The access level modifier for this Property
protected  java.lang.Object defaultValue
          The default value for this Property
protected  java.util.List properties
          The Property objects this Container holds.
 
Fields inherited from class org.enhydra.zeus.binding.BaseBinding
javaType, name
 
Fields inherited from interface org.enhydra.zeus.binding.Property
ACCESS_PRIVATE, ACCESS_PROTECTED, ACCESS_PUBLIC
 
Constructor Summary
ContainerProperty(java.lang.String name)
           This will create a new ContainerProperty with the specified information.
ContainerProperty(java.lang.String name, int accessModifier)
           This will create a new ContainerProperty with the specified information.
 
Method Summary
 void addProperty(Property property)
           This will add a Property to the member variables of this Container.
 void clearProperties()
           This will clear all the properties for this Container.
 int getAccessModifier()
           This will return the access level modifier for a property.
 java.lang.String getAccessModifierString()
           This will return the Java String representation of this Property's access modifier.
 java.lang.Object getDefaultValue()
           This will retrieve the default value associated with this property, or null if there is not one.
 java.util.List getProperties()
           This will return a list of all the Property objects that this Container has.
 boolean removeProperty(java.lang.String propertyName)
           This will remove a Property from this Container, given the property's name.
 void setAccessModifier(int accessModifier)
           This will set the access level modifier for a property.
 void setDefaultValue(java.lang.Object defaultValue)
           This will set the default value of the property.
 
Methods inherited from class org.enhydra.zeus.binding.BaseBinding
getJavaType, getName, setJavaType, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.enhydra.zeus.Binding
getJavaType, getName, setJavaType, setName
 

Field Detail

accessModifier

protected int accessModifier
The access level modifier for this Property

defaultValue

protected java.lang.Object defaultValue
The default value for this Property

properties

protected java.util.List properties
The Property objects this Container holds.
Constructor Detail

ContainerProperty

public ContainerProperty(java.lang.String name,
                         int accessModifier)

This will create a new ContainerProperty with the specified information.

Parameters:
name - the String name of this property.
accessModifier - the int constant for the property's access modifier.
See Also:
{@link Property#ACCESS_PRIVATE}, {@link Property#ACCESS_PROTECTED}, {@link Property#ACCESS_PUBLIC}

ContainerProperty

public ContainerProperty(java.lang.String name)

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

Parameters:
name - the String name of this property.
Method Detail

setAccessModifier

public void setAccessModifier(int accessModifier)

This will set the access level modifier for a property. The value submitted must be in the form of an int, which should correspond to one of the constants defined (Property.ACCESS_PRIVATE, Property.ACCESS_PROTECTED, or Property.ACCESS_PUBLIC. By default, all properties will be private (ACCESS_PRIVATE).

Specified by:
setAccessModifier in interface Property
Parameters:
modifier - int constant for access level.
See Also:
Property.ACCESS_PRIVATE, Property.ACCESS_PROTECTED, Property.ACCESS_PUBLIC

getAccessModifier

public int getAccessModifier()

This will return the access level modifier for a property. The value returned will be in the form of an int, which will correspond to one of the constants defined (Property.ACCESS_PRIVATE, Property.ACCESS_PROTECTED, or Property.ACCESS_PUBLIC.

Specified by:
getAccessModifier in interface Property
Returns:
int - constant for access level modifier.
See Also:
Property.ACCESS_PRIVATE, Property.ACCESS_PROTECTED, Property.ACCESS_PUBLIC

getAccessModifierString

public java.lang.String getAccessModifierString()

This will return the Java String representation of this Property's access modifier. For example, Property.ACCESS_PRIVATE would be converted to "private".

Specified by:
getAccessModifierString in interface Property
Returns:
String - Java representation
See Also:
Property.ACCESS_PRIVATE, Property.ACCESS_PROTECTED, Property.ACCESS_PUBLIC

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

This will set the default value of the property. Since no typing is available at this point, a simple Java Object is allowed as the type supplied. As a result, any errors in mismatches between object type and allowed paramater type will occur at runtime, when class generation takes place. Supplying a value here essentially results in:

    public class Foo {

        private String myString = "some default value";

        public String getMyString() {
            return myString;
        }

        public void setMyString(String myString) {
            this.myString = myString;
        }
 
        // Other methods and properties
    }
 

Also, note that data binding users who supply their own class implementations will LOSE THIS DEFAULT VALUE, as the interface alone cannot specify a default value. So use this carefully!

Specified by:
setDefaultValue in interface Property
Parameters:
defaultValue - Object to be used as default value.

getDefaultValue

public java.lang.Object getDefaultValue()

This will retrieve the default value associated with this property, or null if there is not one. For more information on default property values, see setDefaultValue(Object).

Specified by:
getDefaultValue in interface Property
Returns:
Object - default value of the property.

addProperty

public void addProperty(Property property)

This will add a Property to the member variables of this Container.

It is important to note that this is simply an instance variable being added to (in most cases) a custom Java class definition. That variable/property doesn't have a value (although it might have a default value) until marshalling and unmarshalling occurs.

Specified by:
addProperty in interface Container
Parameters:
property - Property to add.

removeProperty

public boolean removeProperty(java.lang.String propertyName)

This will remove a Property from this Container, given the property's name. If a successful removal occurs, the boolean value true is retruned. If no Property is found with the supplied name, the boolean value false is returned.

Specified by:
removeProperty in interface Container
Parameters:
propertyName - String name of Property to remove.
Returns:
boolean - indicates whether the specified named Property was found and removed.

getProperties

public java.util.List getProperties()

This will return a list of all the Property objects that this Container has. If there are none, this will return an empty List.

Specified by:
getProperties in interface Container
Returns:
List - properties for this Container.

clearProperties

public void clearProperties()

This will clear all the properties for this Container.

Specified by:
clearProperties in interface Container


Copyright © 2001 Enhydra. All Rights Reserved.