|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.persistence.jpa.jpql.model.query.ChangeSupport
public class ChangeSupport
This ChangeSupport
is responsible to notifies registered listeners upon changes made
to a StateObject
, those changes are either a property has changed (IPropertyChangeListener
)
or the content of a list has changed (IListChangeListener
).
Constructor Summary | |
---|---|
ChangeSupport(StateObject source)
Creates a new ChangeSupport . |
Method Summary | ||
---|---|---|
|
addItem(ListHolderStateObject<T> source,
java.util.List<T> items,
java.lang.String listName,
T item)
Adds the given item as a child to the given list. |
|
|
addItems(ListHolderStateObject<T> source,
java.util.List<T> list,
java.lang.String listName,
java.util.List<? extends T> items)
Adds the given items as children to the given list. |
|
void |
addListChangeListener(java.lang.String listName,
IListChangeListener<?> listener)
Registers the given IListChangeListener for the specified list. |
|
protected
|
addListener(java.util.Map<java.lang.String,java.util.List<T>> listeners,
java.lang.Class<?> listenerType,
java.lang.String name,
T listener)
Registers the given list for the specified name. |
|
void |
addPropertyChangeListener(java.lang.String propertyName,
IPropertyChangeListener<?> listener)
Registers the given IPropertyChangeListener for the specified property. |
|
|
canMoveDown(java.util.List<T> list,
T stateObject)
Determines whether the given item can be moved down by one position in the list owned by its parent. |
|
|
canMoveUp(java.util.List<T> list,
T item)
Determines whether the given item can be moved up by one position in the list owned by its parent. |
|
protected
|
fireListChangeEvent(IListChangeEvent<T> event)
|
|
void |
firePropertyChanged(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
Notifies the IPropertyChangeListeners that have been registered
with the given property name that the property has changed. |
|
boolean |
hasListChangeListeners(java.lang.String listName)
Determines whether there are at least one IListChangeListener registered to listen for
changes made to the list with the given list name. |
|
protected boolean |
hasListeners(java.util.Map<java.lang.String,?> listeners,
java.lang.String name)
Determines whether there are at least one listener registered. |
|
boolean |
hasPropertyChangeListeners(java.lang.String propertyName)
Determines whether there are at least one IPropertyChangeListener registered to listen
for changes made to the property with the given property name. |
|
protected void |
initialize(StateObject source)
Initializes this ChangeSupport . |
|
protected
|
listChangeListeners(java.lang.String listName)
|
|
|
moveDown(ListHolderStateObject<T> source,
java.util.List<T> items,
java.lang.String listName,
T item)
Moves the given StateObject down by one position in the list owned by its parent. |
|
protected
|
moveItem(ListHolderStateObject<T> source,
java.util.List<T> items,
IListChangeEvent.EventType eventType,
java.lang.String listName,
T item,
int oldIndex,
int newIndex)
Moves the given item from its current position to a new position in the list owned by its parent. |
|
|
moveUp(ListHolderStateObject<T> source,
java.util.List<T> items,
java.lang.String listName,
T item)
Moves the given item up by one position in the list owned by its parent. |
|
protected IterableListIterator<IPropertyChangeListener<?>> |
propertyChangeListeners(java.lang.String propertyName)
|
|
|
removeItem(ListHolderStateObject<T> source,
java.util.List<T> items,
java.lang.String listName,
T item)
Removes the given item from the list of children. |
|
|
removeItems(ListHolderStateObject<T> source,
java.util.List<? extends T> list,
java.lang.String listName,
java.util.Collection<? extends T> items)
Removes the given items from the list of children. |
|
void |
removeListChangeListener(java.lang.String listName,
IListChangeListener<?> listener)
Unregisters the given IListChangeListener that was registered for the specified list. |
|
protected
|
removeListener(java.util.Map<java.lang.String,java.util.List<T>> listeners,
java.lang.Class<?> listenerType,
java.lang.String name,
T listener)
Unregisters the given listener that was registered for the specified name. |
|
void |
removePropertyChangeListener(java.lang.String propertyName,
IPropertyChangeListener<?> listener)
Unregisters the given IPropertyChangeListener that was registered for the specified
property. |
|
|
replaceItem(ListHolderStateObject<T> source,
java.util.List<T> items,
java.lang.String listName,
int index,
T item)
Replaces the item at the given position by a new one. |
|
|
replaceItems(ListHolderStateObject<T> source,
java.util.List<T> items,
java.lang.String listName,
java.util.List<T> newItems)
Replaces the given list by removing any existing items and adding the items contained in the second list. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ChangeSupport(StateObject source)
ChangeSupport
.
source
- The object for which this object will take care of notifying the listeners upon
changes made to the object's internal state
java.lang.NullPointerException
- The source StateObject
cannot be null
Method Detail |
---|
public <T> void addItem(ListHolderStateObject<T> source, java.util.List<T> items, java.lang.String listName, T item)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of to which the child is addedlistName
- The name associated with the listitem
- The child to become a child of this onepublic <T> void addItems(ListHolderStateObject<T> source, java.util.List<T> list, java.lang.String listName, java.util.List<? extends T> items)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is cominglist
- The list of items to which the child is addedlistName
- The name associated with the listitems
- The child to become children of this onepublic void addListChangeListener(java.lang.String listName, IListChangeListener<?> listener)
IListChangeListener
for the specified list. The listener will be
notified only when items are added, removed, moved from the list.
listName
- The name of the list for which the listener will be notified when the content
of the list has changedlistener
- The listener to be notified upon changes
java.lang.NullPointerException
- IListChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener is already registered with the list nameprotected <T> void addListener(java.util.Map<java.lang.String,java.util.List<T>> listeners, java.lang.Class<?> listenerType, java.lang.String name, T listener)
listeners
- The list of listeners from which the given listener is addedlistenerType
- The type of the listener, which is only used in the exception's messagename
- The name of the event for which the listener is registeredlistener
- The listener to register
java.lang.NullPointerException
- IPropertyChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener is already registered with the given namepublic void addPropertyChangeListener(java.lang.String propertyName, IPropertyChangeListener<?> listener)
IPropertyChangeListener
for the specified property. The listener
will be notified only for changes to the specified property.
propertyName
- The name of the property for which the listener was registeredlistener
- The listener to be notified upon changes
java.lang.NullPointerException
- IPropertyChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener is already registered with the property namepublic <T> boolean canMoveDown(java.util.List<T> list, T stateObject)
list
- The list used to determine if the given item can be moved down in that liststateObject
- The item that could potentially be moved down
true
if the object can be moved down by one unit; false
otherwisepublic <T> boolean canMoveUp(java.util.List<T> list, T item)
list
- The list used to determine if the given item can be moved up in that listitem
- The item that could potentially be moved up
true
if the object can be moved up by one unit; false
otherwiseprotected <T> void fireListChangeEvent(IListChangeEvent<T> event)
public void firePropertyChanged(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
IPropertyChangeListeners
that have been registered
with the given property name that the property has changed.
propertyName
- The name of the property associated with the property changeoldValue
- The old value of the property that changednewValue
- The new value of the property that changedpublic boolean hasListChangeListeners(java.lang.String listName)
IListChangeListener
registered to listen for
changes made to the list with the given list name.
listName
- The name of the list to check if it has registered listeners
true
if listeners have been registered for the given list name;
false
otherwiseprotected boolean hasListeners(java.util.Map<java.lang.String,?> listeners, java.lang.String name)
name
- The name of the property or list to check if it has registered listeners
true
if listeners have been registered for the given name;
false
otherwisepublic boolean hasPropertyChangeListeners(java.lang.String propertyName)
IPropertyChangeListener
registered to listen
for changes made to the property with the given property name.
propertyName
- The name of the property to check if it has registered listeners
true
if listeners have been registered for the given property name;
false
otherwiseprotected void initialize(StateObject source)
ChangeSupport
.
source
- The object for which this object will take care of notifying the listeners upon
changes made to the object's internal state
java.lang.NullPointerException
- The source StateObject
cannot be null
protected <T> IterableListIterator<IListChangeListener<T>> listChangeListeners(java.lang.String listName)
public <T> void moveDown(ListHolderStateObject<T> source, java.util.List<T> items, java.lang.String listName, T item)
StateObject
down by one position in the list owned by its parent.
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of items to which the child is moved downlistName
- The name associated with the listitem
- The child to move down within the listprotected <T> void moveItem(ListHolderStateObject<T> source, java.util.List<T> items, IListChangeEvent.EventType eventType, java.lang.String listName, T item, int oldIndex, int newIndex)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of items to which the child is movedeventType
- The type describing how the item was moved (up or down)listName
- The name associated with the listitem
- The child to move within the listoldIndex
- The current position of the item to movenewIndex
- The new position within the listpublic <T> void moveUp(ListHolderStateObject<T> source, java.util.List<T> items, java.lang.String listName, T item)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of items to which the child is moved uplistName
- The name associated with the listitem
- The child to move up within the listprotected IterableListIterator<IPropertyChangeListener<?>> propertyChangeListeners(java.lang.String propertyName)
public <T> void removeItem(ListHolderStateObject<T> source, java.util.List<T> items, java.lang.String listName, T item)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of item to which the child is removedlistName
- The name associated with the listitem
- The child to removed from the listpublic <T> void removeItems(ListHolderStateObject<T> source, java.util.List<? extends T> list, java.lang.String listName, java.util.Collection<? extends T> items)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is cominglist
- The list of items to which the child is removedlistName
- The name associated with the listitems
- The items to removed from the listpublic void removeListChangeListener(java.lang.String listName, IListChangeListener<?> listener)
IListChangeListener
that was registered for the specified list.
The listener will no longer be notified only when items are added, removed, moved from the
list.
listName
- The name of the list for which the listener was registeredlistener
- The listener to unregister
java.lang.NullPointerException
- IListChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener was never registered with the list nameprotected <T> void removeListener(java.util.Map<java.lang.String,java.util.List<T>> listeners, java.lang.Class<?> listenerType, java.lang.String name, T listener)
listeners
- The list of listeners from which the given listener is removedlistenerType
- The type of the listener, which is only used in the exception's messagename
- The name of the event for which the listener was registeredlistener
- The listener to unregister
java.lang.NullPointerException
- IPropertyChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener was never registered with the given namepublic void removePropertyChangeListener(java.lang.String propertyName, IPropertyChangeListener<?> listener)
IPropertyChangeListener
that was registered for the specified
property. The listener will no longer be notified when the property changes.
propertyName
- The name of the property for which the listener was registeredlistener
- The listener to unregister
java.lang.NullPointerException
- IPropertyChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener was never registered with the property namepublic <T> void replaceItem(ListHolderStateObject<T> source, java.util.List<T> items, java.lang.String listName, int index, T item)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of items to which a child is replacedlistName
- The name associated with the listindex
- The position of the item to replaceitem
- The item to replace the one at the given positionpublic <T> void replaceItems(ListHolderStateObject<T> source, java.util.List<T> items, java.lang.String listName, java.util.List<T> newItems)
T
- The type of the itemssource
- The ListHolderStateObject
from where the change is comingitems
- The list of items to which the child is removedlistName
- The name associated with the listnewItems
- The items to removed from the list
|
EclipseLink 2.4.2, build 'v20130514-5956486' API Reference | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |