|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsim.util.Properties
sim.util.SimpleProperties
A very simple class for getting and setting object properties. You create this class by passing in the object you'd like to modify. The only properties that are considered are ones which are simple (or boxed) booleans, bytes, shorts, ints, longs, floats, doubles, characters, or strings. Alternatively, you can get a class like this by calling Properties.getProperties(...), which will return either a SimpleProperties or a CollectionProperties, depending on which is appropriate and the flags you have passed in.
A property Foo exists in a class if there is a getFoo() or isFoo() method. ReadWrite properties are ones for which there is ALSO a setFoo(prop) method. If the property is a numerical one, you can also provide a domain in the form of a function called domFoo(), which returns either an array of Objects or a sim.util.Interval. If no domain function exists, or if the domain function returns null, then it is assumed the property has no domain (it can take on any value).
The idea behind domains is to make it easy to create graphical interfaces (sliders, pop-up menus) for the user to set properties, where it's often convenient to know beforehand what values the property can be set to in order to construct the GUI widget appropriately. Here are the domain rules (other than null).
This class allows you to set and get properties on the object via boxing the property (java.lang.Integer for int, for example). You can also pass in a String, and SimpleProperties will parse the appropriate value out of the string automatically without you having to bother checking the type.
If any errors arise from generating the properties, setting them, or getting their values, then the error is printed to the console, but is not thrown: instead typically null is returned.
If the object provided to SimpleProperties is sim.util.Proxiable, then SimpleProperties will call propertiesProxy() on that object to get the "true" object whose properties are to be inspected. This makes it possible for objects to create filter objects which only permit access to certain properties. Generally speaking, such proxies (and indeed any object whose properties will be inspected) should be public, non-anonymous classes. For example, imagine that you've got get/set methods on some property Foo, but you only want SimpleProperties to recognize the get method. Furthermore you have another property called Bar that you want hidden entirely. You can easily do this by making your class Proxiable and providing an inner-class proxy like this:
import sim.util.Proxiable; public class MyClass extends Proxiable { int foo; float bar; public int getFoo() { return foo; } public void setFoo(int val) { foo = val; } public float getBar() { return bar; } public void setBar(float val) { bar = val; } public class MyProxy { public int getFoo() { return foo; } } public Object propertiesProxy() { return new MyProxy(); } }
Field Summary |
Fields inherited from class sim.util.Properties |
object |
Constructor Summary | |
SimpleProperties(java.lang.Object o)
Gathers all properties for the object, including ones defined in superclasses. |
|
SimpleProperties(java.lang.Object o,
boolean includeSuperclasses,
boolean includeGetClass)
Gathers all properties for the object, possibly including ones defined in superclasses. |
|
SimpleProperties(java.lang.Object o,
boolean includeSuperclasses,
boolean includeGetClass,
boolean includeDomains)
Gathers all properties for the object, possibly including ones defined in superclasses. |
Method Summary | |
java.lang.Object |
getDomain(int index)
Returns the domain of the property at the given index. |
java.lang.String |
getName(int index)
Returns the name of the given property. |
java.lang.Class |
getType(int index)
Returns the return type of the property (see the TYPE_... |
java.lang.Object |
getValue(int index)
Returns the current value of the property. |
boolean |
isReadWrite(int index)
Returns whether or not the property can be written as well as read Returns false if the index is out of the range [0 ... |
boolean |
isVolatile()
Returns true if the number or order of properties could change at any time |
int |
numProperties()
Returns the number of properties discovered |
Methods inherited from class sim.util.Properties |
betterToString, getObject, getProperties, getProperties, getTypeConversion, isComposite, setValue, setValue, typeToName |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SimpleProperties(java.lang.Object o)
public SimpleProperties(java.lang.Object o, boolean includeSuperclasses, boolean includeGetClass)
public SimpleProperties(java.lang.Object o, boolean includeSuperclasses, boolean includeGetClass, boolean includeDomains)
Method Detail |
public boolean isVolatile()
Properties
isVolatile
in class Properties
public int numProperties()
numProperties
in class Properties
public java.lang.String getName(int index)
getName
in class Properties
public boolean isReadWrite(int index)
isReadWrite
in class Properties
public java.lang.Class getType(int index)
getType
in class Properties
public java.lang.Object getValue(int index)
getValue
in class Properties
public java.lang.Object getDomain(int index)
Properties
getDomain
in class Properties
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |