|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A PropertyConsumer is an interface defining an object that is configured by a Properties object, containing property keys and values that is expected by it.
Field Summary | |
static java.lang.String |
EditorProperty
Keyword for PropertyEditor class from PropertyInfo Property object (editor). |
static java.lang.String |
initPropertiesProperty
Key in the associated propertyInfo object. |
static java.lang.String |
LabelEditorProperty
Scoped keyword for PropertyEditor class from PropertyInfo Property object, to scope the label for the property as displayed in the Inspector (label). |
static java.lang.String |
ScopedEditorProperty
Scoped keyword for PropertyEditor class from PropertyInfo Property object, same as EditorProperty with a period in front (.editor). |
Method Summary | |
java.util.Properties |
getProperties(java.util.Properties getList)
Method to fill in a Properties object, reflecting the current values of the PropertyConsumer. |
java.util.Properties |
getPropertyInfo(java.util.Properties list)
Method to fill in a Properties object with values reflecting the properties able to be set on this PropertyConsumer. |
java.lang.String |
getPropertyPrefix()
Get the property key prefix that is being used to prepend to the property keys for Properties lookups. |
void |
setProperties(java.util.Properties setList)
Method to set the properties in the PropertyConsumer. |
void |
setProperties(java.lang.String prefix,
java.util.Properties setList)
Method to set the properties in the PropertyConsumer. |
void |
setPropertyPrefix(java.lang.String prefix)
Set the property key prefix that should be used by the PropertyConsumer. |
Field Detail |
public static final java.lang.String initPropertiesProperty
public static final java.lang.String EditorProperty
public static final java.lang.String ScopedEditorProperty
public static final java.lang.String LabelEditorProperty
Method Detail |
public void setProperties(java.util.Properties setList)
setList
- a properties object that the PropertyConsumer
can use to retrieve expected properties it can use for
configuration.public void setProperties(java.lang.String prefix, java.util.Properties setList)
prefix
- a String used by the PropertyConsumer to prepend
to each property value it wants to look up -
setList.getProperty(prefix.propertyKey). If the prefix
had already been set, then the prefix passed in should
replace that previous value.setList
- a Properties object that the PropertyConsumer
can use to retrieve expected properties it can use for
configuration.public java.util.Properties getProperties(java.util.Properties getList)
getList
- a Properties object to load the PropertyConsumer
properties into. If getList equals null, then a new
Properties object should be created.
public java.util.Properties getPropertyInfo(java.util.Properties list)
list
- a Properties object to load the PropertyConsumer
properties into. If getList equals null, then a new
Properties object should be created.
public void setPropertyPrefix(java.lang.String prefix)
prefix
- the prefix String.public java.lang.String getPropertyPrefix()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |