ObservableCollection (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.utils.ObservableCollection<T>

Type Parameters:

T - The type of the elements contained in this collection.

All Implemented Interfaces:

ICollection<T>, IEnumerable<T>, IObservableCollection<T>, Iterable<T>, Collection<T>
```
public class ObservableCollection<T>
extends Object
implements IObservableCollection<T>, ICollection<T>
```
A simple default implementation of an IObservableCollection that is backed by an ordinary Collection.

Field Summary
- Fields inherited from interface com.yworks.yfiles.utils.ICollection
  EMPTY

Constructor Summary

Constructors
Constructor and Description
`ObservableCollection()` Creates a new instance using a `ArrayList` as the backing store.
`ObservableCollection(Collection<T> items)` Creates a new instance using a provided collection as the backing store.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(T item)` Adds the item the the collection and triggers the `ItemAdded` event.
`void`	`addItemAddedListener(IEventHandler<ItemEventArgs<T>> itemAddedEvent)` Adds the given listener for the `ItemAdded` event that occurs when an item has been added to this collection.
`void`	`addItemChangedListener(IEventHandler<ItemEventArgs<T>> itemChangedEvent)` Adds the given listener for the `ItemChanged` event that occurs when an item has been changed inside this collection.
`void`	`addItemRemovedListener(IEventHandler<ItemEventArgs<T>> itemRemovedEvent)` Adds the given listener for the `ItemRemoved` event that occurs when an item has been removed from this collection.
`void`	`clear()` Clears this collection, triggering an `ItemRemoved` event for each element removed.
`boolean`	`contains(Object item)` Checks for containment of the item in this collection.
`void`	`copyTo(T[] array, int arrayIndex)` Copies the items to the given array.
`IEnumerator<T>`	`enumerator()` Returns an enumerator over the elements in this collection.
`Collection<T>`	`getItems()` Returns the collection used internally as the backing store.
`protected void`	`onItemAdded(T item)` Callback method that will trigger the `ItemAdded` event.
`protected void`	`onItemChanged(T item)` Callback method that will trigger the `ItemChanged` event.
`protected void`	`onItemRemoved(T item)` Callback method that will trigger the `ItemRemoved` event.
`Stream<T>`	`parallelStream()` Returns a parallel `Stream` using the elements of this enumerable.
`void`	`publishItemChanged(T item)` Method that may be called by client code to trigger an `ItemChanged` event.
`boolean`	`remove(Object item)` Tries to remove the item from the collection and triggers the `ItemRemoved` event.
`void`	`removeItemAddedListener(IEventHandler<ItemEventArgs<T>> itemAddedEvent)` Removes the given listener for the `ItemAdded` event that occurs when an item has been added to this collection.
`void`	`removeItemChangedListener(IEventHandler<ItemEventArgs<T>> itemChangedEvent)` Removes the given listener for the `ItemChanged` event that occurs when an item has been changed inside this collection.
`void`	`removeItemRemovedListener(IEventHandler<ItemEventArgs<T>> itemRemovedEvent)` Removes the given listener for the `ItemRemoved` event that occurs when an item has been removed from this collection.
`int`	`size()` Returns the number of elements in this collection.
`Stream<T>`	`stream()` Returns a sequential `Stream` using the elements of this enumerable.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yworks.yfiles.utils.ICollection
addAll, containsAll, isEmpty, iterator, removeAll, retainAll, toArray, toArray

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable
concat, concat, create, create

Methods inherited from interface java.util.Collection
equals, hashCode, removeIf, spliterator

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - ObservableCollection
```
public ObservableCollection()
```
    Creates a new instance using a ArrayList as the backing store.
  - ObservableCollection
```
public ObservableCollection(Collection<T> items)
```
    Creates a new instance using a provided collection as the backing store.
- Method Detail
  - add
```
public boolean add(T item)
```
    Adds the item the the collection and triggers the ItemAdded event.
    This implementation calls the onItemAdded(Object) method.
    
    Specified by:
    
    add in interface Collection<T>
    
    Parameters:
    
    item - The item to add to the collection.
  - addItemAddedListener
```
public final void addItemAddedListener(IEventHandler<ItemEventArgs<T>> itemAddedEvent)
```
    Adds the given listener for the ItemAdded event that occurs when an item has been added to this collection.
    
    Specified by:
    
    addItemAddedListener in interface IObservableCollection<T>
    
    Parameters:
    
    itemAddedEvent - The listener to add.
    
    See Also:
    
    removeItemAddedListener(IEventHandler)
  - addItemChangedListener
```
public final void addItemChangedListener(IEventHandler<ItemEventArgs<T>> itemChangedEvent)
```
    Adds the given listener for the ItemChanged event that occurs when an item has been changed inside this collection.
    
    Specified by:
    
    addItemChangedListener in interface IObservableCollection<T>
    
    Parameters:
    
    itemChangedEvent - The listener to add.
    
    See Also:
    
    removeItemChangedListener(IEventHandler)
  - addItemRemovedListener
```
public final void addItemRemovedListener(IEventHandler<ItemEventArgs<T>> itemRemovedEvent)
```
    Adds the given listener for the ItemRemoved event that occurs when an item has been removed from this collection.
    
    Specified by:
    
    addItemRemovedListener in interface IObservableCollection<T>
    
    Parameters:
    
    itemRemovedEvent - The listener to add.
    
    See Also:
    
    removeItemRemovedListener(IEventHandler)
  - clear
```
public void clear()
```
    Clears this collection, triggering an ItemRemoved event for each element removed.
    
    Specified by:
    
    clear in interface Collection<T>
    
    See Also:
    
    onItemRemoved(Object)
  - contains
```
public boolean contains(Object item)
```
    Checks for containment of the item in this collection.
    
    Specified by:
    
    contains in interface Collection<T>
    
    Parameters:
    
    item - The item to check.
    
    Returns:
    
    Whether the item is contained in this collection.
  - copyTo
```
public final void copyTo(T[] array,
                         int arrayIndex)
```
    Copies the items to the given array.
  - enumerator
```
public final IEnumerator<T> enumerator()
```
    Returns an enumerator over the elements in this collection.
    
    Specified by:
    
    enumerator in interface IEnumerable<T>
    
    Returns:
    
    an IEnumerator.
  - getItems
```
public final Collection<T> getItems()
```
    Returns the collection used internally as the backing store.
    Normally code should not use this method to gain access to the collection in order to modify it.
    
    Returns:
    
    The backing store of this observable collection.
  - onItemAdded
```
protected void onItemAdded(T item)
```
    Callback method that will trigger the ItemAdded event.
    
    Parameters:
    
    item - The item that has just been added to the collection.
  - onItemChanged
```
protected void onItemChanged(T item)
```
    Callback method that will trigger the ItemChanged event.
    
    Parameters:
    
    item - The item that has changed.
  - onItemRemoved
```
protected void onItemRemoved(T item)
```
    Callback method that will trigger the ItemRemoved event.
    
    Parameters:
    
    item - The item that has just been removed from the collection.
  - parallelStream
```
public Stream<T> parallelStream()
```
    Description copied from interface: ICollection
    
    Returns a parallel Stream using the elements of this enumerable.
    
    Specified by:
    
    parallelStream in interface ICollection<T>
    
    Specified by:
    
    parallelStream in interface IEnumerable<T>
    
    Specified by:
    
    parallelStream in interface Collection<T>
    
    Returns:
    
    a parallel Stream using the elements of this enumerable.
  - publishItemChanged
```
public final void publishItemChanged(T item)
```
    Method that may be called by client code to trigger an ItemChanged event.
    
    Parameters:
    
    item - The item to trigger the change event for.
    
    See Also:
    
    onItemChanged(Object)
  - remove
```
public boolean remove(Object item)
```
    Tries to remove the item from the collection and triggers the ItemRemoved event.
    
    Specified by:
    
    remove in interface ICollection<T>
    
    Specified by:
    
    remove in interface Collection<T>
    
    Parameters:
    
    item - The item to remove.
    
    Returns:
    
    Whether the item has been removed.
    
    See Also:
    
    onItemRemoved(Object)
  - removeItemAddedListener
```
public final void removeItemAddedListener(IEventHandler<ItemEventArgs<T>> itemAddedEvent)
```
    Removes the given listener for the ItemAdded event that occurs when an item has been added to this collection.
    
    Specified by:
    
    removeItemAddedListener in interface IObservableCollection<T>
    
    Parameters:
    
    itemAddedEvent - The listener to remove.
    
    See Also:
    
    addItemAddedListener(IEventHandler)
  - removeItemChangedListener
```
public final void removeItemChangedListener(IEventHandler<ItemEventArgs<T>> itemChangedEvent)
```
    Removes the given listener for the ItemChanged event that occurs when an item has been changed inside this collection.
    
    Specified by:
    
    removeItemChangedListener in interface IObservableCollection<T>
    
    Parameters:
    
    itemChangedEvent - The listener to remove.
    
    See Also:
    
    addItemChangedListener(IEventHandler)
  - removeItemRemovedListener
```
public final void removeItemRemovedListener(IEventHandler<ItemEventArgs<T>> itemRemovedEvent)
```
    Removes the given listener for the ItemRemoved event that occurs when an item has been removed from this collection.
    
    Specified by:
    
    removeItemRemovedListener in interface IObservableCollection<T>
    
    Parameters:
    
    itemRemovedEvent - The listener to remove.
    
    See Also:
    
    addItemRemovedListener(IEventHandler)
  - size
```
public final int size()
```
    Returns the number of elements in this collection.
    
    Specified by:
    
    size in interface Collection<T>
    
    Returns:
    
    The Count.
  - stream
```
public Stream<T> stream()
```
    Description copied from interface: ICollection
    
    Returns a sequential Stream using the elements of this enumerable.
    
    Specified by:
    
    stream in interface ICollection<T>
    
    Specified by:
    
    stream in interface IEnumerable<T>
    
    Specified by:
    
    stream in interface Collection<T>
    
    Returns:
    
    a sequential Stream using the elements of this enumerable.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ObservableCollection<T>

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.ICollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.yworks.yfiles.utils.ICollection

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

ObservableCollection

ObservableCollection

Method Detail

add

addItemAddedListener

addItemChangedListener

addItemRemovedListener

clear

contains

copyTo

enumerator

getItems

onItemAdded

onItemChanged

onItemRemoved

parallelStream

publishItemChanged

remove

removeItemAddedListener

removeItemChangedListener

removeItemRemovedListener

size

stream

toString