| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
org.enhydra.zeus.binding.BaseBinding | +--org.enhydra.zeus.binding.ContainerProperty
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 Container
Object.
Constructor Summary | |
ContainerProperty(String name, int accessModifier) This will create a new ContainerProperty with
the specified information. | |
ContainerProperty(String name) 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. |
String | getAccessModifierString() This will return the Java String representation
of this Property 's access modifier. |
Object | getDefaultValue() This will retrieve the default value associated with this property, or null if there is not one. |
List | getProperties() This will return a list of all the Property 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(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(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 |
Constructor Detail |
public ContainerProperty(String name, int accessModifier)
This will create a new ContainerProperty
with
the specified information.
String
name of this property.int constant for the
property's access modifier.- See Also:
{@link Property#ACCESS_PRIVATE}
, {@link Property#ACCESS_PROTECTED}
, {@link Property#ACCESS_PUBLIC}
public ContainerProperty(String name)
This will create a new ContainerProperty
with
the specified information. The property will be, by default,
Property.ACCESS_PRIVATE
.
String
name of this property.Method Detail |
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.
Property
to add.public void clearProperties()
This will clear all the properties for this Container
.
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
.
int
- constant for access level modifier.public 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".
String
- Java representationpublic 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(java.lang.Object)
.
Object
- default value of the property.public 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
.
List
- properties for this
Container
.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).
boolean
- whether or not this Property
represents a Collection.
public boolean removeProperty(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.
String
name of
Property
to remove.boolean
- indicates whether
the specified named Property
was found and removed.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
).
int
constant for access level.public void setDefaultValue(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!
Object
to be used as default value.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.
true
is multiple values can be stored,
or else false
.Association Links |
{@link Property}
objects this
Container
holds.
| |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |