InstanceContainer (Jmix-ui 1.0 API)

All Known Subinterfaces:

CollectionContainer<E>, CollectionPropertyContainer<E>, InstancePropertyContainer<E>, KeyValueCollectionContainer, KeyValueContainer

All Known Implementing Classes:

CollectionContainerImpl, CollectionPropertyContainerImpl, InstanceContainerImpl, InstancePropertyContainerImpl, KeyValueCollectionContainerImpl, KeyValueContainerImpl
```
public interface InstanceContainer<E>
```
The root interface in the data containers hierarchy. Data containers represent a thin layer between visual components and entity instances and collections.
InstanceContainer holds a single entity instance.

See Also:

CollectionContainer

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`InstanceContainer.ItemChangeEvent<T>` Event sent when the entity instance selected in the container is replaced with another instance or null.
`static class`	`InstanceContainer.ItemPropertyChangeEvent<T>` Event sent on changing a property value of the contained entity instance.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`io.jmix.core.common.event.Subscription`	`addItemChangeListener(java.util.function.Consumer<InstanceContainer.ItemChangeEvent<E>> listener)` Adds listener to `InstanceContainer.ItemChangeEvent`s.
`io.jmix.core.common.event.Subscription`	`addItemPropertyChangeListener(java.util.function.Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)` Adds listener to `InstanceContainer.ItemPropertyChangeEvent`s.
`io.jmix.core.metamodel.model.MetaClass`	`getEntityMetaClass()` Returns the meta-class of entities that can be stored in the container.
`io.jmix.core.FetchPlan`	`getFetchPlan()` Returns the view which was set by previous call to `setFetchPlan(FetchPlan)`.
`E`	`getItem()` Returns the contained entity instance.
`E`	`getItemOrNull()` Returns the contained entity instance or null if there is no entity in the container.
`default io.jmix.core.FetchPlan`	`getView()` Deprecated. replaced by `getFetchPlan()`
`void`	`mute()` Disables all event listeners on container data change.
`void`	`setFetchPlan(io.jmix.core.FetchPlan fetchPlan)` Sets a view to be used when loading entities for this container.
`void`	`setItem(E entity)` Sets the given entity instance to the container.
`default void`	`setView(io.jmix.core.FetchPlan view)` Deprecated. replaced by `setFetchPlan(FetchPlan)`
`void`	`unmute()` Enables all event listeners.

- Method Detail
  - getItem
```
E getItem()
```
    Returns the contained entity instance.
    
    Throws:
    
    java.lang.IllegalStateException - if there is no entity in the container
  - setItem
```
void setItem(@Nullable
             E entity)
```
    Sets the given entity instance to the container.
  - getItemOrNull
```
@Nullable
E getItemOrNull()
```
    Returns the contained entity instance or null if there is no entity in the container.
  - getEntityMetaClass
```
io.jmix.core.metamodel.model.MetaClass getEntityMetaClass()
```
    Returns the meta-class of entities that can be stored in the container.
  - getView
```
@Nullable
 @Deprecated
default io.jmix.core.FetchPlan getView()
```
    Deprecated. replaced by getFetchPlan()
  - getFetchPlan
```
@Nullable
io.jmix.core.FetchPlan getFetchPlan()
```
    Returns the view which was set by previous call to setFetchPlan(FetchPlan). The view is normally used when loading entities for this container.
  - setView
```
@Deprecated
default void setView(io.jmix.core.FetchPlan view)
```
    Deprecated. replaced by setFetchPlan(FetchPlan)
  - setFetchPlan
```
void setFetchPlan(io.jmix.core.FetchPlan fetchPlan)
```
    Sets a view to be used when loading entities for this container.
  - addItemPropertyChangeListener
```
io.jmix.core.common.event.Subscription addItemPropertyChangeListener(java.util.function.Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)
```
    Adds listener to InstanceContainer.ItemPropertyChangeEvents.
  - addItemChangeListener
```
io.jmix.core.common.event.Subscription addItemChangeListener(java.util.function.Consumer<InstanceContainer.ItemChangeEvent<E>> listener)
```
    Adds listener to InstanceContainer.ItemChangeEvents.
  - mute
```
void mute()
```
    Disables all event listeners on container data change.
    Can be used with unmute() for bulk data modification as a perfomance optimization.
  - unmute
```
void unmute()
```
    Enables all event listeners. No events are fired on this call.

Interface InstanceContainer<E>

Nested Class Summary

Method Summary

Method Detail

getItem

setItem

getItemOrNull

getEntityMetaClass

getView

getFetchPlan

setView

setFetchPlan

addItemPropertyChangeListener

addItemChangeListener

mute

unmute