InstanceContainerImpl (Jmix-ui 1.1 API)

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

All Implemented Interfaces:

HasLoader, ItemPropertyChangeNotifier, InstanceContainer<E>

Direct Known Subclasses:

CollectionContainerImpl, InstancePropertyContainerImpl, KeyValueContainerImpl
```
public class InstanceContainerImpl<E>
extends java.lang.Object
implements InstanceContainer<E>, HasLoader, ItemPropertyChangeNotifier
```

Nested Class Summary
- 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 io.jmix.core.metamodel.model.MetaClass`	`entityMetaClass`
`protected io.jmix.core.common.event.EventHub`	`events`
`protected io.jmix.core.FetchPlan`	`fetchPlan`
`protected E`	`item`
`protected io.jmix.core.entity.EntityPropertyChangeListener`	`listener`
`protected boolean`	`listenersEnabled`
`protected DataLoader`	`loader`
`protected io.jmix.core.Metadata`	`metadata`

Constructor Summary

Constructors
Constructor and Description

InstanceContainerImpl(io.jmix.core.metamodel.model.MetaClass entityMetaClass)

Constructors
Constructor and Description
`InstanceContainerImpl(io.jmix.core.metamodel.model.MetaClass entityMetaClass)`

Method Summary

All Methods Instance Methods Concrete 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.
`protected void`	`attachListener(java.lang.Object entity)`
`protected void`	`detachListener(java.lang.Object entity)`
`protected void`	`fireItemChanged(E prevItem)`
`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 `InstanceContainer.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.
`DataLoader`	`getLoader()` Returns the loader of this container.
`void`	`itemPropertyChanged(io.jmix.core.entity.EntityPropertyChangeEvent e)`
`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 item)` Sets the given entity instance to the container.
`void`	`setLoader(DataLoader loader)` Sets the loader for this container.
`java.lang.String`	`toString()`
`void`	`unmute()` Enables all event listeners.

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
getView, setView

- Field Detail
  - metadata
```
@Autowired
protected io.jmix.core.Metadata metadata
```
  - item
```
protected E item
```
  - entityMetaClass
```
protected io.jmix.core.metamodel.model.MetaClass entityMetaClass
```
  - fetchPlan
```
protected io.jmix.core.FetchPlan fetchPlan
```
  - events
```
protected io.jmix.core.common.event.EventHub events
```
  - listener
```
protected io.jmix.core.entity.EntityPropertyChangeListener listener
```
  - loader
```
protected DataLoader loader
```
  - listenersEnabled
```
protected boolean listenersEnabled
```
- Constructor Detail
  - InstanceContainerImpl
```
public InstanceContainerImpl(io.jmix.core.metamodel.model.MetaClass entityMetaClass)
```
- Method Detail
  - getItemOrNull
```
@Nullable
public E getItemOrNull()
```
    Description copied from interface: InstanceContainer
    
    Returns the contained entity instance or null if there is no entity in the container.
    
    Specified by:
    
    getItemOrNull in interface InstanceContainer<E>
  - getItem
```
public E getItem()
```
    Description copied from interface: InstanceContainer
    
    Returns the contained entity instance.
    
    Specified by:
    
    getItem in interface InstanceContainer<E>
  - 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>
  - getEntityMetaClass
```
public io.jmix.core.metamodel.model.MetaClass getEntityMetaClass()
```
    Description copied from interface: InstanceContainer
    
    Returns the meta-class of entities that can be stored in the container.
    
    Specified by:
    
    getEntityMetaClass in interface InstanceContainer<E>
  - getFetchPlan
```
@Nullable
public io.jmix.core.FetchPlan getFetchPlan()
```
    Description copied from interface: InstanceContainer
    
    Returns the view which was set by previous call to InstanceContainer.setFetchPlan(FetchPlan). The view is normally used when loading entities for this container.
    
    Specified by:
    
    getFetchPlan in interface InstanceContainer<E>
  - setFetchPlan
```
public void setFetchPlan(io.jmix.core.FetchPlan fetchPlan)
```
    Description copied from interface: InstanceContainer
    
    Sets a view to be used when loading entities for this container.
    
    Specified by:
    
    setFetchPlan in interface InstanceContainer<E>
  - addItemPropertyChangeListener
```
public io.jmix.core.common.event.Subscription addItemPropertyChangeListener(java.util.function.Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)
```
    Description copied from interface: InstanceContainer
    
    Adds listener to InstanceContainer.ItemPropertyChangeEvents.
    
    Specified by:
    
    addItemPropertyChangeListener in interface InstanceContainer<E>
  - addItemChangeListener
```
public io.jmix.core.common.event.Subscription addItemChangeListener(java.util.function.Consumer<InstanceContainer.ItemChangeEvent<E>> listener)
```
    Description copied from interface: InstanceContainer
    
    Adds listener to InstanceContainer.ItemChangeEvents.
    
    Specified by:
    
    addItemChangeListener in interface InstanceContainer<E>
  - attachListener
```
protected void attachListener(java.lang.Object entity)
```
  - detachListener
```
protected void detachListener(java.lang.Object entity)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getLoader
```
@Nullable
public DataLoader getLoader()
```
    Description copied from interface: HasLoader
    
    Returns the loader of this container.
    
    Specified by:
    
    getLoader in interface HasLoader
  - setLoader
```
public void setLoader(DataLoader loader)
```
    Description copied from interface: HasLoader
    
    Sets the loader for this container.
    
    Specified by:
    
    setLoader in interface HasLoader
  - fireItemChanged
```
protected void fireItemChanged(@Nullable
                               E prevItem)
```
  - itemPropertyChanged
```
public void itemPropertyChanged(io.jmix.core.entity.EntityPropertyChangeEvent e)
```
    Specified by:
    
    itemPropertyChanged in interface ItemPropertyChangeNotifier
  - mute
```
public void mute()
```
    Description copied from interface: InstanceContainer
    
    Disables all event listeners on container data change.
    Can be used with InstanceContainer.unmute() for bulk data modification as a perfomance optimization.
    
    Specified by:
    
    mute in interface InstanceContainer<E>
  - unmute
```
public void unmute()
```
    Description copied from interface: InstanceContainer
    
    Enables all event listeners. No events are fired on this call.
    
    Specified by:
    
    unmute in interface InstanceContainer<E>

Class InstanceContainerImpl<E>

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

metadata

item

entityMetaClass

fetchPlan

events

listener

loader

listenersEnabled

Constructor Detail

InstanceContainerImpl

Method Detail

getItemOrNull

getItem

setItem

getEntityMetaClass

getFetchPlan

setFetchPlan

addItemPropertyChangeListener

addItemChangeListener

attachListener

detachListener

toString

getLoader

setLoader

fireItemChanged

itemPropertyChanged

mute

unmute