EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject

Method Summary

Modifier and Type	Method and Description
public <S extends T> S	addItem(S The child `StateObject` to become a child of this one return The given item item) Adds the given `StateObject` as a child of this one.
public void	addItems(List<? extends T> The `StateObjects` to become children of this one items) Adds the given list of `StateObjects` as children of this one.
public void	addListChangeListener(String The name of the list for which the listener will be notified when the content of the list has changed listName, IListChangeListener<T> The listener to be notified upon changes listener) Registers the given `IListChangeListener` for the specified list.
public boolean	Returns: `true` if the object can be moved down by one unit; `false` otherwise canMoveDown(T The `StateObject` that could potentially be moved down item) Determines whether the given `StateObject` can be moved down by one position in the list owned by its parent.
public boolean	Returns: `true` if the object can be moved up by one unit; `false` otherwise canMoveUp(T The `StateObject` that could potentially be moved up item) Determines whether the given `StateObject` can be moved up by one position in the list owned by its parent.
public T	Returns: The `StateObject` at the given position getItem(int The position of the `StateObject` to retrieve index) Returns the `StateObject` at the given positions from the list
public boolean	Returns: `true` if this `StateObject` has children; `false` otherwise hasItems() Determines whether this `StateObject` has any children.
public ListIterable<? extends T>	Returns: An `ListIterable` that is iterating over the children items() Returns an `ListIterable` over the children.
public int	Returns: The count of `StateObjects` that are children of this one itemsSize() Returns the number of children this list holder has.
public T	Returns: The given item moveDown(T The `StateObject` to move down in the list item) Moves the given `StateObject` down by one position in the list owned by its parent.
public T	Returns: The given item moveUp(T The `StateObject` to move up in the list item) Moves the given `StateObject` up by one position in the list owned by its parent.
public void	removeItem(T The child `StateObject` to not longer be a child item) Removes the given `StateObject` from the list of children.
public void	removeItems(Collection<T> The `StateObjects` to remove from this one items) Removes the given `StateObject` from the list of children.
public void	removeListChangeListener(String The name of the list for which the listener was registered listName, IListChangeListener<T> The listener to unregister listener) Unregisters the given `IListChangeListener` that was registered for the specified list.

Method Detail

addItem back to summary

addItem	back to summary
public <S extends T> S addItem(S item) Adds the given `StateObject` as a child of this one. Parameters item:S The child `StateObject` to become a child of this one return The given item

public <S extends T> S addItem(S item)

Adds the given StateObject as a child of this one.

Parameters

item:S: The child StateObject to become a child of this one return The given item

addItems back to summary

addItems	back to summary
public void addItems(List<? extends T> items) Adds the given list of `StateObjects` as children of this one. Parameters items:List<? extends T> The `StateObjects` to become children of this one

public void addItems(List<? extends T> items)

Adds the given list of StateObjects as children of this one.

Parameters

items:List<? extends T>: The StateObjects to become children of this one

addListChangeListener back to summary

addListChangeListener	back to summary
public void addListChangeListener(String listName, IListChangeListener<T> listener) Registers the given `IListChangeListener` for the specified list. The listener will be notified only when items are added, removed, moved from the list. Parameters listName:String The name of the list for which the listener will be notified when the content of the list has changed listener:IListChangeListener<T> The listener to be notified upon changes Exceptions NullPointerException: `IListChangeListener` cannot be `null` IllegalArgumentException: The listener is already registered with the list name

public void addListChangeListener(String listName, IListChangeListener<T> listener)

Registers the given IListChangeListener for the specified list. The listener will be notified only when items are added, removed, moved from the list.

Parameters

listName:String: The name of the list for which the listener will be notified when the content of the list has changed
listener:IListChangeListener<T>: The listener to be notified upon changes

Exceptions

NullPointerException:: IListChangeListener cannot be null
IllegalArgumentException:: The listener is already registered with the list name

canMoveDown back to summary

canMoveDown	back to summary
public boolean canMoveDown(T item) Determines whether the given `StateObject` can be moved down by one position in the list owned by its parent. Parameters item:T The `StateObject` that could potentially be moved down Returns:boolean `true` if the object can be moved down by one unit; `false` otherwise

public boolean canMoveDown(T item)

Determines whether the given StateObject can be moved down by one position in the list owned by its parent.

Parameters

item:T: The StateObject that could potentially be moved down

Returns:boolean

true if the object can be moved down by one unit; false otherwise

canMoveUp back to summary

canMoveUp	back to summary
public boolean canMoveUp(T item) Determines whether the given `StateObject` can be moved up by one position in the list owned by its parent. Parameters item:T The `StateObject` that could potentially be moved up Returns:boolean `true` if the object can be moved up by one unit; `false` otherwise

public boolean canMoveUp(T item)

Determines whether the given StateObject can be moved up by one position in the list owned by its parent.

Parameters

item:T: The StateObject that could potentially be moved up

Returns:boolean

true if the object can be moved up by one unit; false otherwise

getItem back to summary

getItem	back to summary
public T getItem(int index) Returns the `StateObject` at the given positions from the list Parameters index:int The position of the `StateObject` to retrieve Returns:T The `StateObject` at the given position

public T getItem(int index)

Returns the StateObject at the given positions from the list

Parameters

index:int: The position of the StateObject to retrieve

Returns:T

The StateObject at the given position

hasItems back to summary

hasItems	back to summary
public boolean hasItems() Determines whether this `StateObject` has any children. Returns:boolean `true` if this `StateObject` has children; `false` otherwise

public boolean hasItems()

Determines whether this StateObject has any children.

Returns:boolean: true if this StateObject has children; false otherwise

items back to summary

items	back to summary
public ListIterable<? extends T> items() Returns an `ListIterable` over the children. Returns:ListIterable<? extends T> An `ListIterable` that is iterating over the children

public ListIterable<? extends T> items()

Returns an ListIterable over the children.

Returns:ListIterable<? extends T>: An ListIterable that is iterating over the children

itemsSize back to summary

itemsSize	back to summary
public int itemsSize() Returns the number of children this list holder has. Returns:int The count of `StateObjects` that are children of this one

public int itemsSize()

Returns the number of children this list holder has.

Returns:int: The count of StateObjects that are children of this one

moveDown back to summary

moveDown	back to summary
public T moveDown(T item) Moves the given `StateObject` down by one position in the list owned by its parent. Parameters item:T The `StateObject` to move down in the list Returns:T The given item

public T moveDown(T item)

Moves the given StateObject down by one position in the list owned by its parent.

Parameters

item:T: The StateObject to move down in the list

Returns:T

The given item

moveUp back to summary

moveUp	back to summary
public T moveUp(T item) Moves the given `StateObject` up by one position in the list owned by its parent. Parameters item:T The `StateObject` to move up in the list Returns:T The given item

public T moveUp(T item)

Moves the given StateObject up by one position in the list owned by its parent.

Parameters

item:T: The StateObject to move up in the list

Returns:T

The given item

removeItem back to summary

removeItem	back to summary
public void removeItem(T item) Removes the given `StateObject` from the list of children. Parameters item:T The child `StateObject` to not longer be a child

public void removeItem(T item)

Removes the given StateObject from the list of children.

Parameters

item:T: The child StateObject to not longer be a child

removeItems back to summary

removeItems	back to summary
public void removeItems(Collection<T> items) Removes the given `StateObject` from the list of children. Parameters items:Collection<T> The `StateObjects` to remove from this one

public void removeItems(Collection<T> items)

Removes the given StateObject from the list of children.

Parameters

items:Collection<T>: The StateObjects to remove from this one

removeListChangeListener back to summary

removeListChangeListener	back to summary
public void removeListChangeListener(String listName, IListChangeListener<T> listener) Unregisters the given `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. Parameters listName:String The name of the list for which the listener was registered listener:IListChangeListener<T> The listener to unregister Exceptions NullPointerException: `IListChangeListener` cannot be `null` IllegalArgumentException: The listener was never registered with the list name

public void removeListChangeListener(String listName, IListChangeListener<T> listener)

Unregisters the given 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.

Parameters

listName:String: The name of the list for which the listener was registered
listener:IListChangeListener<T>: The listener to unregister

Exceptions

NullPointerException:: IListChangeListener cannot be null
IllegalArgumentException:: The listener was never registered with the list name

public Interface ListHolderStateObject<T>

Method Summary

Method Detail