org.fuin.xmlcfg4j

Class AbstractElement

java.lang.Object

org.fuin.xmlcfg4j.AbstractElement

Direct Known Subclasses:

AbstractNamedElement

public abstract class AbstractElement
extends java.lang.Object

Basic functionality used by all configuration sub classes.

Constructor Summary

Constructors

Constructor and Description
AbstractElement()

Method Summary

Modifier and Type	Method and Description
void	addVariable(@NotNull Variable variable) Adds a variable to the element.
java.util.List<Variable>	getVariables() Returns a list of variables.
@NotNull java.util.Map<java.lang.String,java.lang.String>	getVarMap() Returns the map of variables defined by this object and it's parents.
protected void	inheritVariables(java.util.Map<java.lang.String,java.lang.String> parentVars) Derives all variables from a parent map plus the ones defined in the object itself.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractElement

public AbstractElement()

Method Detail

inheritVariables

protected final void inheritVariables(@Nullable
                                      java.util.Map<java.lang.String,java.lang.String> parentVars)

Derives all variables from a parent map plus the ones defined in the object itself.

Parameters:

parentVars - Variables defined by the parent.

getVarMap

@NotNull
public final @NotNull java.util.Map<java.lang.String,java.lang.String> getVarMap()

Returns the map of variables defined by this object and it's parents.

Returns:

Unmodifiable map of variables.

addVariable

public final void addVariable(@NotNull
                              @NotNull Variable variable)

Adds a variable to the element.

Parameters:

variable - Variable to add.

getVariables

@Nullable
public final java.util.List<Variable> getVariables()

Returns a list of variables.

Returns:

Variables.