|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.openjpa.lib.conf.Value
public abstract class Value
A configuration value.
Constructor Summary | |
---|---|
Value()
Default constructor. |
|
Value(String prop)
Constructor. |
Method Summary | |
---|---|
String |
alias(String str)
Alias the given setting. |
protected String |
alias(String str,
String[] aliases,
boolean nullNotFound)
Alias the given setting. |
protected void |
assertChangeable()
Asserts if this receiver can be changed. |
Object |
clone()
|
boolean |
equals(Object other)
Use original value instead of
current value because they are one and the same
for non-dynamic Values and ensures that modifying dynamic Values do not
impact equality or hashCode contract. |
String[] |
getAliases()
Aliases for the value in the form key1, value1, key2, value2, ... |
String |
getDefault()
The default value for the property as a string. |
String |
getInstantiatingGetter()
The name of the getter method for the instantiated value of this property(as opposed to the string value) |
protected abstract String |
getInternalString()
Return the internal string form of this value. |
ValueListener |
getListener()
Listener for value changes. |
String |
getLoadKey()
The key under which this value was loaded, or null. |
String |
getOriginalValue()
Gets the original value. |
String |
getProperty()
The property name that will be used when setting or getting this value in a Map . |
Class |
getScope()
A class defining the scope in which this value is defined. |
String |
getString()
Return a stringified version of this value. |
abstract Class |
getValueType()
Returns the type of the property that this Value represents. |
int |
hashCode()
Use original value instead of
current value because they are one and the same
for non-dynamic Values and ensures that modifying dynamic Values do not
impact equality or hashCode contract. |
boolean |
isAliasListComprehensive()
Whether or not the alias list defines all possible settings for this value. |
boolean |
isDynamic()
Affirms if this receiver can be mutated even when the configuration it belongs to has been frozen . |
void |
setAlias(String key,
String value)
Replaces an existing alias, or adds the given alias to the front of the alias list if it does not already exist. |
protected String[] |
setAlias(String key,
String value,
String[] aliases)
Set an alias into a current alias list, returning the new list. |
void |
setAliases(String[] aliases)
Aliases for the value in the form key1, value1, key2, value2, ... |
void |
setAliasListComprehensive(boolean aliasListIsComprehensive)
Whether or not the alias list defines all possible settings for this value. |
void |
setDefault(String def)
The default value for the propert as a string. |
void |
setDynamic(boolean flag)
Sets if this receiver can be mutated even when the configuration it belongs to has been frozen . |
void |
setInstantiatingGetter(String getter)
The name of the getter method for the instantiated value of this property(as opposed to the string value). |
protected abstract void |
setInternalObject(Object obj)
Set this value from an object. |
protected abstract void |
setInternalString(String str)
Set this value from the given string. |
void |
setListener(ValueListener listen)
Listener for value changes. |
void |
setLoadKey(String loadKey)
The key under which this value was loaded, or null. |
void |
setObject(Object obj)
Set this value as an object. |
void |
setProperty(String prop)
The property name that will be used when setting or getting this value in a Map . |
void |
setScope(Class cls)
A class defining the scope in which this value is defined. |
void |
setString(String val)
Set this value from the given string. |
String |
unalias(String str)
Unalias the given setting. |
protected String |
unalias(String str,
String[] aliases,
boolean nullNotFound)
Unalias the given setting. |
void |
valueChanged()
Subclasses should call this method when their internal value changes. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Value()
public Value(String prop)
setProperty(java.lang.String)
Method Detail |
---|
public String getProperty()
Map
.
public void setProperty(String prop)
Map
.
public String getLoadKey()
public void setLoadKey(String loadKey)
public String[] getAliases()
public void setAliases(String[] aliases)
To avoid potential side-effects, this method copies the array passed in.
public void setAlias(String key, String value)
protected String[] setAlias(String key, String value, String[] aliases)
public boolean isAliasListComprehensive()
public void setAliasListComprehensive(boolean aliasListIsComprehensive)
public String alias(String str)
protected String alias(String str, String[] aliases, boolean nullNotFound)
public String unalias(String str)
protected String unalias(String str, String[] aliases, boolean nullNotFound)
public String getDefault()
public void setDefault(String def)
public String getInstantiatingGetter()
public void setInstantiatingGetter(String getter)
this.
, then the getter will be looked up on the value
instance itself. Otherwise, the getter will be looked up on the
configuration instance.
public Class getScope()
public void setScope(Class cls)
public String getString()
public void setString(String val)
originalString
being null), then the
value is remembered as original. This original value is used
for equality and hashCode computation if this Value is
dynamic
.
public void setObject(Object obj)
originalString
being null), then the
value is remembered as original. This original value is used
for equality and hashCode computation if this Value is
dynamic
.
public String getOriginalValue()
public abstract Class getValueType()
protected abstract String getInternalString()
protected abstract void setInternalString(String str)
protected abstract void setInternalObject(Object obj)
public ValueListener getListener()
public void setListener(ValueListener listen)
public void valueChanged()
protected void assertChangeable()
public void setDynamic(boolean flag)
frozen
.
public boolean isDynamic()
frozen
.
public int hashCode()
original value
instead of
current value
because they are one and the same
for non-dynamic Values and ensures that modifying dynamic Values do not
impact equality or hashCode contract.
hashCode
in class Object
public boolean equals(Object other)
original value
instead of
current value
because they are one and the same
for non-dynamic Values and ensures that modifying dynamic Values do not
impact equality or hashCode contract.
equals
in class Object
public Object clone()
clone
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This documentation is deprecated and will be removed in the next release of WebLogic Server.