Package org.ametys.runtime.model

Class DefinitionContext

java.lang.Object

org.ametys.runtime.model.DefinitionContext

public final class DefinitionContext
extends Object

Object that gives some context for definitions manipulation

Method Summary

Modifier and Type	Method	Description
DefinitionContext	cloneContext()	Creates a new instance of a DefinitionContext, with the current context values
Optional<String>	getItemTagName()	Retrieves the tag name to use while generating SAX events
Optional<ModelItem>	getModelItem()	Retrieves the model item
Optional<Object>	getObject()	Retrieves the context object for the definition
Optional<View>	getView()	Retrieves the view
boolean	isEdition()	Checks if the context is in edition
static DefinitionContext	newInstance()	Creates a new instance of a DefinitionContext
static DefinitionContext	newInstance(DefinitionContext context)	Creates a new instance of a DefinitionContext from another DefinitionContext.
DefinitionContext	withEdition(boolean isEdition)	Set to true if the context is in edition (default to false)
DefinitionContext	withItemTagName(String itemTagName)	Set the tag name to use while generating SAX events
DefinitionContext	withModelItem(ModelItem modelItem)	Sets the model item
DefinitionContext	withObject(Object object)	Set the context object
DefinitionContext	withView(View view)	Set the view

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newInstance

public static DefinitionContext newInstance()

Creates a new instance of a DefinitionContext

Returns:

the created instance

newInstance

public static DefinitionContext newInstance(DefinitionContext context)

Creates a new instance of a DefinitionContext from another DefinitionContext.

Parameters:

context - the definition context to copy

Returns:

the created instance

cloneContext

public DefinitionContext cloneContext()

Creates a new instance of a DefinitionContext, with the current context values

Returns:

the created instance

getObject

public Optional<Object> getObject()

Retrieves the context object for the definition

Returns:

the context object

withObject

public DefinitionContext withObject(Object object)

Set the context object

Parameters:

object - the context object to set

Returns:

the current DefinitionContext

isEdition

public boolean isEdition()

Checks if the context is in edition

Returns:

true if the context is in edition, false otherwise

withEdition

public DefinitionContext withEdition(boolean isEdition)

Set to true if the context is in edition (default to false)

Parameters:

isEdition - true if the context is in edition, false otherwise

Returns:

the current DefinitionContext

getItemTagName

public Optional<String> getItemTagName()

Retrieves the tag name to use while generating SAX events

Returns:

the tag name to use while generating SAX events

withItemTagName

public DefinitionContext withItemTagName(String itemTagName)

Set the tag name to use while generating SAX events

Parameters:

itemTagName - the tag name to set

Returns:

the current DefinitionContext

getModelItem

public Optional<ModelItem> getModelItem()

Retrieves the model item

Returns:

the model item

withModelItem

public DefinitionContext withModelItem(ModelItem modelItem)

Sets the model item

Parameters:

modelItem - the model item to set

Returns:

the current DefinitionContext

getView

public Optional<View> getView()

Retrieves the view

Returns:

the view

withView

public DefinitionContext withView(View view)

Set the view

Parameters:

view - the view to set

Returns:

the current DefinitionContext