java.lang.Object
- org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
- - org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractListHolderStateObject<T>

All Implemented Interfaces:

ListHolderStateObject<T>, StateObject

Direct Known Subclasses:

AbstractFromClauseStateObject, AbstractIdentificationVariableDeclarationStateObject, CaseExpressionStateObject, ConcatExpressionStateObject, ConstructorExpressionStateObject, GroupByClauseStateObject, InExpressionStateObject, OrderByClauseStateObject
```
public abstract class AbstractListHolderStateObject<T extends StateObject>
extends AbstractStateObject
implements ListHolderStateObject<T>
```
The abstraction definition of a StateObject that holds onto a list of children, the methods defined in ListHolderStateObject are automatically handled here.

Since:

2.4

Version:

2.4

Author:

Pascal Filion

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<S extends T> S`	`addItem(S item)`	Adds the given `StateObject` as a child of this one.
`void`	`addItems(List<? extends T> items)`	Adds the given list of `StateObjects` as children of this one.
`void`	`addListChangeListener(String listName, IListChangeListener<T> listener)`	Registers the given `IListChangeListener` for the specified list.
`boolean`	`canMoveDown(T stateObject)`	Determines whether the given `StateObject` can be moved down by one position in the list owned by its parent.
`boolean`	`canMoveUp(T stateObject)`	Determines whether the given `StateObject` can be moved up by one position in the list owned by its parent.
`T`	`getItem(int index)`	Returns the `StateObject` at the given positions from the list
`boolean`	`hasItems()`	Determines whether this `StateObject` has any children.
`ListIterable<? extends T>`	`items()`	Returns an `ListIterable` over the children.
`int`	`itemsSize()`	Returns the number of children this list holder has.
`T`	`moveDown(T item)`	Moves the given `StateObject` down by one position in the list owned by its parent.
`T`	`moveUp(T item)`	Moves the given `StateObject` up by one position in the list owned by its parent.
`void`	`removeItem(T stateObject)`	Removes the given `StateObject` from the list of children.
`void`	`removeItems(Collection<T> items)`	Removes the given `StateObject` from the list of children.
`void`	`removeListChangeListener(String listName, IListChangeListener<T> listener)`	Unregisters the given `IListChangeListener` that was registered for the specified list.

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject
addPropertyChangeListener, children, decorate, equals, findIdentificationVariable, getDeclaration, getDecorator, getExpression, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, getType, getType, getTypeHelper, getTypeRepository, hashCode, isDecorated, isEquivalent, removePropertyChangeListener, setExpression, setParent, toString, toString, toText

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject
accept, addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getExpression, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, isEquivalent, removePropertyChangeListener, setParent, toString, toText

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

Class AbstractListHolderStateObject<T extends StateObject>

Method Summary

Methods inherited from class org.eclipse.persistence.jpa.jpql.tools.model.query.AbstractStateObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.jpa.jpql.tools.model.query.StateObject

Method Detail

addItem

addItems

addListChangeListener

canMoveDown

canMoveUp

getItem

hasItems

items

itemsSize

moveDown

moveUp

removeItem

removeItems

removeListChangeListener