org.infinispan.commons.configuration.elements

Interface ElementDefinition<C extends ConfigurationInfo>

All Known Implementing Classes:

DefaultElementDefinition

public interface ElementDefinition<C extends ConfigurationInfo>

Defines a container for a set of configuration Attribute. It is usually represented as a top level element when serialized as XML or a top level object for JSON and is associated with a Configuration instance. An ElementDefinition can contain zero or more sub-elements representing nested configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ElementDefinition.ElementOutput An ElementOutput specifies the name and optionally the class that an element must be serialized.

Method Summary

Modifier and Type	Method and Description
boolean	isTopLevel()
default boolean	omitIfEmpty()
boolean	supports(String elementName)
ElementDefinition.ElementOutput	toExternalName(C configuration)

Method Detail

isTopLevel

boolean isTopLevel()

Returns:

true if the ElementDefinition is top-level or false if its attributes and children should be merged with the parent element when serializing.

toExternalName

ElementDefinition.ElementOutput toExternalName(C configuration)

Returns:

the ElementDefinition.ElementOutput for serialization purposes of the configuration element.

omitIfEmpty

default boolean omitIfEmpty()

supports

boolean supports(String elementName)

Returns:

true if a serialized elementName matches this ElementDefinition.