Top Description Inners Methods
org.eclipse.persistence.jpa.jpql.tools.model

public Interface IListChangeEvent<T>

Known Direct Implementers
org.eclipse.persistence.jpa.jpql.tools.model.ListChangeEvent
Imports
java.util.List, org.eclipse.persistence.jpa.jpql.tools.model.query.ListHolderStateObject, org.eclipse.persistence.jpa.jpql.utility.iterable.ListIterable

This is used in conjunction with IListChangeListener. It contains the information regarding the content of a list being changed.
Author
Pascal Filion
Since
2.4
Version
2.5

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
IListChangeEvent.EventType

This enumeration lists the possible modification a list can have.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The index of where the change occurred in the list
getEndIndex
()

Returns the index of where the change occurred in the list.

public IListChangeEvent.EventType

Returns:

One of the possible types of changes
getEventType
()

Returns the type of change that occurred in the list.

public List<T>

Returns:

The copy of the list that got changed
getList
()

Returns a copy of the actual list after the change has happened.

public String

Returns:

The name of the list for which IListChangeListeners have been registered with the source to be notified upon changes
getListName
()

Returns the name describing the list.

public <
The type of the source owning the list
S extends ListHolderStateObject<? extends T>
>
S

Returns:

The source of the event
getSource
()

Returns the source where the modification occurred and that fired the event.

public int

Returns:

The index of where the change occurred in the list
getStartIndex
()

Returns the index of where the change occurred in the list.

public ListIterable<T>

Returns:

The list of items associated with the EventType
items
()

Returns the list of items that have caused the original list to change.

public int

Returns:

The count of items triggering this event
itemsSize
()

Returns the number of items that caused the original list to change.

Method Detail

getEndIndexback to summary
public int getEndIndex()

Returns the index of where the change occurred in the list.

Returns:int

The index of where the change occurred in the list

getEventTypeback to summary
public IListChangeEvent.EventType getEventType()

Returns the type of change that occurred in the list.

Returns:IListChangeEvent.EventType

One of the possible types of changes

getListback to summary
public List<T> getList()

Returns a copy of the actual list after the change has happened.

Returns:List<T>

The copy of the list that got changed

getListNameback to summary
public String getListName()

Returns the name describing the list.

Returns:String

The name of the list for which IListChangeListeners have been registered with the source to be notified upon changes

getSourceback to summary
public <S extends ListHolderStateObject<? extends T>> S getSource()

Returns the source where the modification occurred and that fired the event.

Parameters
<S>
The type of the source owning the list
Returns:S

The source of the event

getStartIndexback to summary
public int getStartIndex()

Returns the index of where the change occurred in the list.

Returns:int

The index of where the change occurred in the list

itemsback to summary
public ListIterable<T> items()

Returns the list of items that have caused the original list to change. Depending on the even type:

Returns:ListIterable<T>

The list of items associated with the EventType

itemsSizeback to summary
public int itemsSize()

Returns the number of items that caused the original list to change.

Returns:int

The count of items triggering this event

org.eclipse.persistence.jpa.jpql.tools.model back to summary

public final Enum IListChangeEvent.EventType

extends Enum<IListChangeEvent.EventType>
Class Inheritance

This enumeration lists the possible modification a list can have.

Field Summary

Modifier and TypeField and Description
public static final IListChangeEvent.EventType
ADDED

Specifies the list changed by having new items inserted.

public static final IListChangeEvent.EventType
CHANGED

Specifies the entire list has changed.

public static final IListChangeEvent.EventType
MOVED_DOWN

Specifies the list changed by having some items have moved down the list.

public static final IListChangeEvent.EventType
MOVED_UP

Specifies the list changed by having some items have moved up the list.

public static final IListChangeEvent.EventType
REMOVED

Specifies the list changed by having items removed.

public static final IListChangeEvent.EventType
REPLACED

Specifies the list changed by having a single item replaced.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static IListChangeEvent.EventType
public static IListChangeEvent.EventType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ADDEDback to summary
public static final IListChangeEvent.EventType ADDED

Specifies the list changed by having new items inserted.

CHANGEDback to summary
public static final IListChangeEvent.EventType CHANGED

Specifies the entire list has changed.

MOVED_DOWNback to summary
public static final IListChangeEvent.EventType MOVED_DOWN

Specifies the list changed by having some items have moved down the list.

MOVED_UPback to summary
public static final IListChangeEvent.EventType MOVED_UP

Specifies the list changed by having some items have moved up the list.

REMOVEDback to summary
public static final IListChangeEvent.EventType REMOVED

Specifies the list changed by having items removed.

REPLACEDback to summary
public static final IListChangeEvent.EventType REPLACED

Specifies the list changed by having a single item replaced.

Constructor Detail

EventTypeback to summary
private EventType()

Method Detail

valueOfback to summary
public static IListChangeEvent.EventType valueOf(String name)
valuesback to summary
public static IListChangeEvent.EventType[] values()