|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsim.util.Properties
The abstract superclass of Property inspectors. Such a beast inspects an object and returns a list of variables for which there are get and possibly set methods.
There are two such inspectors: SimpleProperties (inspects objects for their slots) and CollectionProperties (inspects Collections, Maps, and arrays for their contents). The easiest way to get an appropriate Properties subclass instance is to simply call the static method Properties.getProperties(object to inspect, .... ). See the SimpleProperties and CollectionProperties classes for specifics about how they define what a Property is. SimpleProperties in particular will beinteresting..
Property inspectors enumerate the Properties in their provided object. SimpleProperties will enumerate each of the slots; and CollectionProperties will enumerate the elements in the corresponding array, Map, Collection, etc. You get the number of Properties with numProperties(). Properties have the following features:
Field Summary | |
protected java.lang.Object |
object
|
Constructor Summary | |
Properties()
|
Method Summary | |
java.lang.String |
betterToString(java.lang.Object obj)
Call this to get a prettier print-name for an object -- converting arrays to a nicer format, for example. |
java.lang.Object |
getDomain(int index)
Returns the domain of the property at the given index. |
abstract java.lang.String |
getName(int index)
Returns the name of the property at the given index. |
java.lang.Object |
getObject()
Returns the original object from which the properties are extracted |
static Properties |
getProperties(java.lang.Object object,
boolean expandCollections,
boolean includeSuperclasses,
boolean includeGetClass)
Returns a Properties object for the given object. |
static Properties |
getProperties(java.lang.Object object,
boolean expandCollections,
boolean includeSuperclasses,
boolean includeGetClass,
boolean includeDomains)
Returns a Properties object for the given object. |
abstract java.lang.Class |
getType(int index)
Returns the Class (or for primitive objects, the primitive TYPE) of the property at the given index. |
protected java.lang.Class |
getTypeConversion(java.lang.Class type)
|
abstract java.lang.Object |
getValue(int index)
Returns the value of the property at the given index. |
boolean |
isComposite(int index)
Returns true if the property at the given index is a "Composite" object, meaning it's not a primitive type (double, int, etc.) nor a String. |
abstract boolean |
isReadWrite(int index)
Returns true if the property at the given index is both readable and writable (as opposed to read-only). |
abstract boolean |
isVolatile()
Returns true if the number or order of properties could change at any time |
abstract int |
numProperties()
Returns the number of properties discovered in the object. |
java.lang.Object |
setValue(int index,
java.lang.Object value)
Sets the current value of the property. |
java.lang.Object |
setValue(int index,
java.lang.String value)
Sets the current value of the property to the value parsed from the given string. |
protected java.lang.String |
typeToName(java.lang.Class type)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.Object object
Constructor Detail |
public Properties()
Method Detail |
public static Properties getProperties(java.lang.Object object, boolean expandCollections, boolean includeSuperclasses, boolean includeGetClass)
public static Properties getProperties(java.lang.Object object, boolean expandCollections, boolean includeSuperclasses, boolean includeGetClass, boolean includeDomains)
public java.lang.Object getObject()
public abstract boolean isVolatile()
public abstract int numProperties()
public abstract java.lang.Object getValue(int index)
public java.lang.Object getDomain(int index)
public abstract boolean isReadWrite(int index)
public boolean isComposite(int index)
public abstract java.lang.String getName(int index)
public abstract java.lang.Class getType(int index)
public java.lang.Object setValue(int index, java.lang.Object value)
public java.lang.Object setValue(int index, java.lang.String value)
protected java.lang.Class getTypeConversion(java.lang.Class type)
public java.lang.String betterToString(java.lang.Object obj)
protected java.lang.String typeToName(java.lang.Class type)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |