Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditor.EditorEntity

All Superinterfaces:

Observable<Entity>, Observer<Entity>

Enclosing interface:

EntityEditor

public static interface EntityEditor.EditorEntity
extends Observable<Entity>

Provides access to the entity instance being edited.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.common.reactive.observer.Observer

Observer.Builder<T,B extends Observer.Builder<T,B>>

Method Summary

Modifier and Type	Method	Description
Observer<Entity>	changing()	Throwing a CancelException from a listener will cancel the change.
Entity	get()
void	refresh()	Refreshes the active Entity from the database, discarding all changes.
void	replace(Entity entity)	Replaces the entity without notifying that it is changing.
void	set(@Nullable Entity entity)	Populates this editor entity with the values from the given entity or sets the default value for all attributes in case it is null.

Methods inherited from interface is.codion.common.reactive.observer.Observable

getOrThrow, getOrThrow, is, isNot, isNull, isNullable, optional

Methods inherited from interface is.codion.common.reactive.observer.Observer

addConsumer, addListener, addWeakConsumer, addWeakListener, observer, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener, when, when

Method Details

get

Entity get()

Specified by:

get in interface Observable<Entity>

Returns:

an immutable copy of the entity being edited

set

void set(@Nullable Entity entity)

Populates this editor entity with the values from the given entity or sets the default value for all attributes in case it is null.

Use EntityEditor.clear() in order to clear the editor of all values.

Notifies that the entity is about to change via changing()

Parameters:

entity - the entity to set, if null, then defaults are set

Throws:

IllegalArgumentException - in case the entity is not of the correct type

See Also:

• EntityEditor.EditorValue.defaultValue()
• EntityEditor.EditorValue.persist()
• ValueAttributeDefinition.defaultValue()
• changing()

changing

Observer<Entity> changing()

Throwing a CancelException from a listener will cancel the change.

Returns:

an observer notified each time the entity is about to be changed via set(Entity) or EntityEditor.defaults().

See Also:

• set(Entity)
• EntityEditor.defaults()

replace

void replace(Entity entity)

Replaces the entity without notifying that it is changing.

refresh

void refresh()

Refreshes the active Entity from the database, discarding all changes. If the active Entity is new then calling this method has no effect.

See Also:

• EntityEditor.exists()