public final class ChangeInfo
extends java.lang.Object
HashStructure
or ListStructure
.Modifier and Type | Field and Description |
---|---|
static int |
HASH_STRUCTURE
Structure type returned from
getParentStructureType()
indicating that the parent structure was a HashStructure . |
static int |
LIST_STRUCTURE
Structure type returned from
getParentStructureType()
indicating that the parent structure was a ListStructure . |
static int |
PLACEHOLDER_VALUE_ADDED
Change type returned from
getChangeType() indicating that
a placeholder value was added. |
static int |
UNKNOWN_STRUCTURE
Structure type returned from
getParentStructureType()
indicating that the parent structure was an unknown structure. |
static int |
VALUE_ADDED
Change type returned from
getChangeType() indicating that
a persistent value was added. |
static int |
VALUE_MODIFIED
Change type returned from
getChangeType() indicating that
a persistent value was modified. |
static int |
VALUE_REMOVED
Change type returned from
getChangeType() indicating that
a value was removed. |
Modifier and Type | Method and Description |
---|---|
int |
getChangeType()
Returns the type of change represented by this ChangeInfo.
|
java.lang.Object |
getNewValue()
Returns the new value as an Object.
|
java.lang.Boolean |
getNewValueAsBoolean()
Returns the new value as a boolean.
|
double |
getNewValueAsDouble()
Returns the new value as a double.
|
float |
getNewValueAsFloat()
Returns the new value as a float.
|
HashStructure |
getNewValueAsHashStructure()
Returns the new value as a
HashStructure . |
int |
getNewValueAsInt()
Returns the new value as an int.
|
ListStructure |
getNewValueAsListStructure()
Returns the new value as a
ListStructure . |
long |
getNewValueAsLong()
Returns the new value as a long.
|
java.lang.String |
getNewValueAsString()
Returns the new value as a String.
|
java.net.URL |
getNewValueAsURL()
Returns the new value as an URL.
|
java.lang.Object |
getOldValue()
Returns the old value as an object.
|
java.lang.Boolean |
getOldValueAsBoolean()
Returns the old value as a boolean.
|
double |
getOldValueAsDouble()
Returns the old value as a double.
|
float |
getOldValueAsFloat()
Returns the old value as a float.
|
HashStructure |
getOldValueAsHashStructure()
Returns the old value as a
HashStructure . |
int |
getOldValueAsInt()
Returns the old value as an int.
|
ListStructure |
getOldValueAsListStructure()
Returns the old value as a
ListStructure . |
long |
getOldValueAsLong()
Returns the old value as a long.
|
java.lang.String |
getOldValueAsString()
Returns the old value as a String.
|
java.net.URL |
getOldValueAsURL()
Returns the old value as an URL.
|
HashStructure |
getParentAsHashStructure()
Returns the parent as a
HashStructure . |
ListStructure |
getParentAsListStructure()
Returns the parent as a
ListStructure . |
int |
getParentStructureType()
Returns the type of parent structure on which this ChangeInfo
applies.
|
java.lang.String |
getPropertyLocalName()
Returns the short, unqualified name of the property for which this
ChangeInfo applies.
|
java.lang.String |
getPropertyName()
Returns the fully qualified (
slash-delimited )
name of the property for which this ChangeInfo applies. |
boolean |
isEventForList(java.lang.String listStructureName)
Convenience method for determining whether this ChangeInfo
represents a change event that occurred within a ListStructure
with the specified fully-qualified
listStructureName . |
java.lang.String |
toString()
Converts the ChangeInfo into a string that can be used for
debugging or logging change events.
|
public static final int VALUE_MODIFIED
getChangeType()
indicating that
a persistent value was modified.public static final int VALUE_ADDED
getChangeType()
indicating that
a persistent value was added.public static final int PLACEHOLDER_VALUE_ADDED
getChangeType()
indicating that
a placeholder value was added.public static final int VALUE_REMOVED
getChangeType()
indicating that
a value was removed. The removed value may have been persistent
or placeholder.public static final int HASH_STRUCTURE
getParentStructureType()
indicating that the parent structure was a HashStructure
.public static final int LIST_STRUCTURE
getParentStructureType()
indicating that the parent structure was a ListStructure
.public static final int UNKNOWN_STRUCTURE
getParentStructureType()
indicating that the parent structure was an unknown structure.
This probably reflects an internal error of some kind.public int getChangeType()
VALUE_MODIFIED
,
VALUE_ADDED
, PLACEHOLDER_VALUE_ADDED
, and
VALUE_REMOVED
.public int getParentStructureType()
HASH_STRUCTURE
or
LIST_STRUCTURE
.public java.lang.String getPropertyName()
slash-delimited
)
name of the property for which this ChangeInfo applies. If the
property involves an item within a ListStructure
, the
property name will include a numerical index to indicate which
item in the ListStructure was changed.public java.lang.String getPropertyLocalName()
getPropertyName()
returns "foo/bar/someFlag", getPropertyLocalName will return
"someFlag".public boolean isEventForList(java.lang.String listStructureName)
listStructureName
.
Returns true
if this ChangeInfo occurred within
the specified list; false
otherwise.public HashStructure getParentAsHashStructure()
HashStructure
. Returns null
if the parent is not a HashStructure.public ListStructure getParentAsListStructure()
ListStructure
. Returns null
if the parent is not a ListStructure.public java.lang.Object getOldValue()
public java.lang.Boolean getOldValueAsBoolean()
public java.lang.String getOldValueAsString()
public int getOldValueAsInt()
java.lang.NumberFormatException
- if the value cannot be converted to an int.public long getOldValueAsLong()
java.lang.NumberFormatException
- if the value cannot be converted to a long.public float getOldValueAsFloat()
java.lang.NumberFormatException
- if the value cannot be converted to a float.public double getOldValueAsDouble()
java.lang.NumberFormatException
- if the value cannot be converted to a double.public java.net.URL getOldValueAsURL()
null
if the
old value is not an URL.public HashStructure getOldValueAsHashStructure()
HashStructure
. Returns
null
if the old value is not a HashStructure.public ListStructure getOldValueAsListStructure()
ListStructure
. Returns
null
if the old value is not a ListStructure.public java.lang.String getNewValueAsString()
public java.lang.Object getNewValue()
public int getNewValueAsInt()
java.lang.NumberFormatException
- if the value cannot be converted to an int.public long getNewValueAsLong()
java.lang.NumberFormatException
- if the value cannot be converted to a long.public float getNewValueAsFloat()
java.lang.NumberFormatException
- if the value cannot be converted to a float.public double getNewValueAsDouble()
java.lang.NumberFormatException
- if the value cannot be converted to a double.public java.lang.Boolean getNewValueAsBoolean()
public java.net.URL getNewValueAsURL()
null
if the
old value is not an URL.public HashStructure getNewValueAsHashStructure()
HashStructure
. Returns
null
if the new value is not a HashStructure.public ListStructure getNewValueAsListStructure()
ListStructure
. Returns
null
if the new value is not a ListStructure.public java.lang.String toString()
toString
in class java.lang.Object