|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.zeus.binding.BaseBinding | +--org.enhydra.zeus.binding.ContainerProperty
ContainerProperty
implements the
,
Binding
, and
Property
interfaces, and provides
for a complex object that is itself a property.
Container
A ContainerProperty
will most commonly represent
a Java Object
that has properties of its own
(like any other Container
Object.
Field Summary | |
protected int |
accessModifier
The access level modifier for this Property |
protected java.lang.Object |
defaultValue
The default value for this Property |
protected boolean |
isCollection
Whether this Property represents a Collection |
protected java.util.List |
properties
The 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 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 objects that
this Container has. |
boolean |
isCollection()
This will indicate whether this Property represents
a Collection of values (resulting in a true
result from this method), or a singular value (resulting in a
false result). |
boolean |
removeProperty(java.lang.String propertyName)
This will remove a
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. |
void |
setIsCollection(boolean isCollection)
This will whether or not this Property
is a Collection (in other words, the property
represents a collection of values). |
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 |
protected int accessModifier
Property
protected boolean isCollection
Property
represents a Collection
protected java.lang.Object defaultValue
Property
protected java.util.List properties
Property
objects this
Container
holds.Constructor Detail |
public ContainerProperty(java.lang.String name, int accessModifier)
This will create a new ContainerProperty
with
the specified information.
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}
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
name
- the String
name of this property.Method Detail |
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
,
or Property.ACCESS_PROTECTED
. By default,
all properties will be Property.ACCESS_PUBLIC
private
(ACCESS_PRIVATE
).
setAccessModifier
in interface Property
modifier
- int
constant for access level.Property.ACCESS_PRIVATE
,
Property.ACCESS_PROTECTED
,
Property.ACCESS_PUBLIC
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
,
or Property.ACCESS_PROTECTED
.
Property.ACCESS_PUBLIC
getAccessModifier
in interface Property
int
- constant for access level modifier.Property.ACCESS_PRIVATE
,
Property.ACCESS_PROTECTED
,
Property.ACCESS_PUBLIC
public java.lang.String getAccessModifierString()
This will return the Java String
representation
of this Property
's access modifier. For
example,
would be
converted to "private".
Property.ACCESS_PRIVATE
getAccessModifierString
in interface Property
String
- Java representationProperty.ACCESS_PRIVATE
,
Property.ACCESS_PROTECTED
,
Property.ACCESS_PUBLIC
public void setIsCollection(boolean isCollection)
This will whether or not this Property
is a Collection
(in other words, the property
represents a collection of values). By default, properties
are all singular values.
setIsCollection
in interface Property
isCollection
- true
is multiple values can be stored,
or else false
.public boolean isCollection()
This will indicate whether this Property
represents
a Collection
of values (resulting in a true
result from this method), or a singular value (resulting in a
false
result).
isCollection
in interface Property
boolean
- whether or not this Property
represents a Collection.
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!
setDefaultValue
in interface Property
defaultValue
- Object
to be used as default value.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)
getDefaultValue
in interface Property
Object
- default value of the property.public void addProperty(Property property)
This will add a
to
the member variables of this Property
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.
addProperty
in interface Container
property
- Property
to add.public boolean removeProperty(java.lang.String propertyName)
This will remove a
from this Property
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.
removeProperty
in interface Container
propertyName
- String
name of
Property
to remove.boolean
- indicates whether
the specified named Property
was found and removed.public java.util.List getProperties()
This will return a list of all the
objects that
this Property
Container
has. If there are
none, this will return an empty List
.
getProperties
in interface Container
List
- properties for this
Container
.public void clearProperties()
This will clear all the properties for this Container
.
clearProperties
in interface Container
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |