CollectionContainerImpl (Jmix-ui 1.2 API)

java.lang.Object
- io.jmix.ui.model.impl.InstanceContainerImpl<E>
- - io.jmix.ui.model.impl.CollectionContainerImpl<E>

All Implemented Interfaces:

CollectionContainer<E>, HasLoader, ItemPropertyChangeNotifier, InstanceContainer<E>

Direct Known Subclasses:

CollectionPropertyContainerImpl, KeyValueCollectionContainerImpl
```
public class CollectionContainerImpl<E>
extends InstanceContainerImpl<E>
implements CollectionContainer<E>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface io.jmix.ui.model.CollectionContainer
  CollectionContainer.CollectionChangeEvent<T>, CollectionContainer.UnmuteEventsMode
- Nested classes/interfaces inherited from interface io.jmix.ui.model.InstanceContainer
  InstanceContainer.ItemChangeEvent<T>, InstanceContainer.ItemPropertyChangeEvent<T>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<E>`	`collection`
`protected java.util.Map<IndexKey,java.lang.Integer>`	`idMap`
`protected io.jmix.core.MetadataTools`	`metadataTools`
`protected Sorter`	`sorter`

Fields inherited from class io.jmix.ui.model.impl.InstanceContainerImpl
entityMetaClass, events, fetchPlan, item, listener, listenersEnabled, loader, metadata

Constructor Summary

Constructors
Constructor and Description

CollectionContainerImpl(io.jmix.core.metamodel.model.MetaClass metaClass)

Constructors
Constructor and Description
`CollectionContainerImpl(io.jmix.core.metamodel.model.MetaClass metaClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`io.jmix.core.common.event.Subscription`	`addCollectionChangeListener(java.util.function.Consumer<CollectionContainer.CollectionChangeEvent<E>> listener)` Adds listener to `CollectionContainer.CollectionChangeEvent`.
`protected void`	`addToCollection(E entity)`
`protected void`	`attachListener(java.util.Collection<E> entities)`
`protected void`	`buildIdMap()`
`protected void`	`clearItemIfNotExists()`
`boolean`	`containsItem(java.lang.Object entityOrId)` Returns true if the given entity exists in the container.
`protected void`	`detachListener(java.util.Collection<E> entities)`
`protected void`	`fireCollectionChanged(CollectionChangeType type, java.util.Collection<? extends E> changes)`
`E`	`getItem(java.lang.Object entityId)` Returns entity by its id.
`int`	`getItemIndex(java.lang.Object entityOrId)` Returns the index in the items list of the given entity or -1 if there is no such entity.
`E`	`getItemOrNull(java.lang.Object entityId)` Returns entity by its id or null if the container doesn't have an entity with the given id.
`java.util.List<E>`	`getItems()` Returns immutable list of contained entities.
`java.util.List<E>`	`getMutableItems()` Returns mutable list of contained entities.
`Sorter`	`getSorter()` Returns sorter object currently set for the container.
`void`	`itemPropertyChanged(io.jmix.core.entity.EntityPropertyChangeEvent e)`
`protected void`	`replaceInCollection(int idx, E entity)`
`void`	`replaceItem(E entity)` If the item with the same id exists in the container, it is replaced with the given instance.
`void`	`setItem(E item)` Sets the given entity instance to the container.
`void`	`setItems(java.util.Collection<E> entities)` Sets a collection of entities to the container.
`void`	`setSorter(Sorter sorter)` Sets sorter object.
`java.lang.String`	`toString()`
`void`	`unmute(CollectionContainer.UnmuteEventsMode mode)` Enables all event listeners.

Methods inherited from class io.jmix.ui.model.impl.InstanceContainerImpl
addItemChangeListener, addItemPropertyChangeListener, attachListener, detachListener, fireItemChanged, getEntityMetaClass, getFetchPlan, getItem, getItemOrNull, getLoader, mute, setFetchPlan, setLoader, unmute

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

Methods inherited from interface io.jmix.ui.model.InstanceContainer
addItemChangeListener, addItemPropertyChangeListener, getEntityMetaClass, getFetchPlan, getItem, getItemOrNull, getView, mute, setFetchPlan, setView, unmute

- Field Detail
  - metadataTools
```
@Autowired
protected io.jmix.core.MetadataTools metadataTools
```
  - collection
```
protected java.util.List<E> collection
```
  - idMap
```
protected java.util.Map<IndexKey,java.lang.Integer> idMap
```
  - sorter
```
protected Sorter sorter
```
- Constructor Detail
  - CollectionContainerImpl
```
public CollectionContainerImpl(io.jmix.core.metamodel.model.MetaClass metaClass)
```
- Method Detail
  - setItem
```
public void setItem(@Nullable
                    E item)
```
    Description copied from interface: InstanceContainer
    
    Sets the given entity instance to the container.
    
    Specified by:
    
    setItem in interface InstanceContainer<E>
    
    Overrides:
    
    setItem in class InstanceContainerImpl<E>
  - getItems
```
public java.util.List<E> getItems()
```
    Description copied from interface: CollectionContainer
    
    Returns immutable list of contained entities.
    
    Specified by:
    
    getItems in interface CollectionContainer<E>
  - getMutableItems
```
public java.util.List<E> getMutableItems()
```
    Description copied from interface: CollectionContainer
    
    Returns mutable list of contained entities. Changes in the list produce CollectionContainer.CollectionChangeEvent.
    
    Specified by:
    
    getMutableItems in interface CollectionContainer<E>
  - setItems
```
public void setItems(@Nullable
                     java.util.Collection<E> entities)
```
    Description copied from interface: CollectionContainer
    
    Sets a collection of entities to the container.
    
    Specified by:
    
    setItems in interface CollectionContainer<E>
  - getItem
```
public E getItem(java.lang.Object entityId)
```
    Description copied from interface: CollectionContainer
    
    Returns entity by its id.
    
    Specified by:
    
    getItem in interface CollectionContainer<E>
  - getItemOrNull
```
@Nullable
public E getItemOrNull(java.lang.Object entityId)
```
    Description copied from interface: CollectionContainer
    
    Returns entity by its id or null if the container doesn't have an entity with the given id.
    
    Specified by:
    
    getItemOrNull in interface CollectionContainer<E>
  - getItemIndex
```
public int getItemIndex(java.lang.Object entityOrId)
```
    Description copied from interface: CollectionContainer
    
    Returns the index in the items list of the given entity or -1 if there is no such entity.
    
    Specified by:
    
    getItemIndex in interface CollectionContainer<E>
    
    Parameters:
    
    entityOrId - entity instance or its id
  - containsItem
```
public boolean containsItem(java.lang.Object entityOrId)
```
    Description copied from interface: CollectionContainer
    
    Returns true if the given entity exists in the container.
    
    Specified by:
    
    containsItem in interface CollectionContainer<E>
    
    Parameters:
    
    entityOrId - entity instance or its id
  - replaceItem
```
public void replaceItem(E entity)
```
    Description copied from interface: CollectionContainer
    
    If the item with the same id exists in the container, it is replaced with the given instance. If not, the given instance is added to the items list.
    Sends CollectionContainer.CollectionChangeEvent of the SET_ITEM or ADD_ITEMS type.
    
    Specified by:
    
    replaceItem in interface CollectionContainer<E>
  - replaceInCollection
```
protected void replaceInCollection(int idx,
                                   E entity)
```
  - addToCollection
```
protected void addToCollection(E entity)
```
  - addCollectionChangeListener
```
public io.jmix.core.common.event.Subscription addCollectionChangeListener(java.util.function.Consumer<CollectionContainer.CollectionChangeEvent<E>> listener)
```
    Description copied from interface: CollectionContainer
    
    Adds listener to CollectionContainer.CollectionChangeEvent.
    
    Specified by:
    
    addCollectionChangeListener in interface CollectionContainer<E>
  - getSorter
```
@Nullable
public Sorter getSorter()
```
    Description copied from interface: CollectionContainer
    
    Returns sorter object currently set for the container.
    
    Specified by:
    
    getSorter in interface CollectionContainer<E>
  - setSorter
```
public void setSorter(Sorter sorter)
```
    Description copied from interface: CollectionContainer
    
    Sets sorter object.
    
    Specified by:
    
    setSorter in interface CollectionContainer<E>
  - unmute
```
public void unmute(CollectionContainer.UnmuteEventsMode mode)
```
    Description copied from interface: CollectionContainer
    
    Enables all event listeners. Events fired on this call depend on the passed mode.
    
    Specified by:
    
    unmute in interface CollectionContainer<E>
    
    Parameters:
    
    mode - mode
  - itemPropertyChanged
```
public void itemPropertyChanged(io.jmix.core.entity.EntityPropertyChangeEvent e)
```
    Specified by:
    
    itemPropertyChanged in interface ItemPropertyChangeNotifier
    
    Overrides:
    
    itemPropertyChanged in class InstanceContainerImpl<E>
  - fireCollectionChanged
```
protected void fireCollectionChanged(CollectionChangeType type,
                                     java.util.Collection<? extends E> changes)
```
  - attachListener
```
protected void attachListener(java.util.Collection<E> entities)
```
  - detachListener
```
protected void detachListener(java.util.Collection<E> entities)
```
  - buildIdMap
```
protected void buildIdMap()
```
  - clearItemIfNotExists
```
protected void clearItemIfNotExists()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class InstanceContainerImpl<E>

Class CollectionContainerImpl<E>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.model.CollectionContainer

Nested classes/interfaces inherited from interface io.jmix.ui.model.InstanceContainer

Field Summary

Fields inherited from class io.jmix.ui.model.impl.InstanceContainerImpl

Constructor Summary

Method Summary

Methods inherited from class io.jmix.ui.model.impl.InstanceContainerImpl

Methods inherited from class java.lang.Object

Methods inherited from interface io.jmix.ui.model.InstanceContainer

Field Detail

metadataTools

collection

idMap

sorter

Constructor Detail

CollectionContainerImpl

Method Detail

setItem

getItems

getMutableItems

setItems

getItem

getItemOrNull

getItemIndex

containsItem

replaceItem

replaceInCollection

addToCollection

addCollectionChangeListener

getSorter

setSorter

unmute

itemPropertyChanged

fireCollectionChanged

attachListener

detachListener

buildIdMap

clearItemIfNotExists

toString