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
Optional<String>	getItemTagName()	Retrieves the tag name to use while generating SAX events
Optional<Object>	getObject()	Retrieves the context object for the definition
boolean	isEdition()	Checks if the context is in edition
static DefinitionContext	newInstance()	Creates a new instance of a 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	withObject(Object object)	Set the context object

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

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