org.oddjob.arooa.json

Interface ConfigurationTree

public interface ConfigurationTree

A generic form of a Configuration. This is an intermediate configuration particularly suited to moving to and from a JSON configuration.

Child configurations are grouped by names. Names would be the property names in the typical Arooa configuration:

Method Summary

Modifier and Type	Method and Description
java.util.List<ConfigurationTree>	getChildConfigurations(java.lang.String name) Get the child configuration(s) for a name.
java.util.Set<java.lang.String>	getChildNames() Get the names of child configurations.
ArooaElement	getElement() Get the element of this configuration.
java.util.Optional<java.lang.String>	getText() Get the element text, if there is any.
ArooaConfiguration	toConfiguration(SaveOperation saveMethod) Map to an ArooaConfiguration that can be parsed with an ArooaParser.

Method Detail

getElement

ArooaElement getElement()

Get the element of this configuration.

Returns:

An Element. Never Null.

getText

java.util.Optional<java.lang.String> getText()

Get the element text, if there is any.

Returns:

Optional Text.

getChildNames

java.util.Set<java.lang.String> getChildNames()

Get the names of child configurations.

Returns:

A set of names. May be empty but never null.

getChildConfigurations

java.util.List<ConfigurationTree> getChildConfigurations(java.lang.String name)

Get the child configuration(s) for a name.

Parameters:

name - The name of the child(ren)

Returns:

If the name exists then a list of at least one configuration otherwise null.

toConfiguration

ArooaConfiguration toConfiguration(SaveOperation saveMethod)

Map to an ArooaConfiguration that can be parsed with an ArooaParser.

Parameters:

saveMethod - Provide a way of saving changes to the configuration back.

Returns:

A valid ArooaConfiguration.