|
||||||||||
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.BaseProperty
implements the Property
interface and defines behavior for a property of a Java class.
These properties have modifiers, types, and names, as well
as a value.
Binding
This base implementation of Property
defines the common
functionality for all Property
implementations, removing
a need for them to duplicate code for this functionality. All
implementations of Property
should extend this class
rather than directly implementing the Property
interface.
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 |
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 | |
BaseProperty()
|
Method Summary | |
void |
BaseProperty()
Default constructor. |
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. |
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). |
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
Constructor Detail |
public BaseProperty()
Method Detail |
public void BaseProperty()
Default constructor.
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |