org.fuin.xmlcfg4j

Class Variables

java.lang.Object

org.fuin.xmlcfg4j.Variables

public final class Variables
extends java.lang.Object

A container for multiple variable definitions.

Constructor Summary

Constructors

Constructor and Description
Variables(@NotEmpty java.util.Collection<Variable> variables) Constructor with collection.
Variables(Variable... variables) Constructor with array.

Method Summary

Modifier and Type	Method and Description
@NotEmpty java.util.List<Variable>	asList() Returns a list of variables.
@NotEmpty java.util.Map<java.lang.String,java.lang.String>	asMap() Returns a map of key/values.
void	init(java.util.Map<java.lang.String,java.lang.String> vars) Replaces variables (if defined) in the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Variables

public Variables(@NotEmpty
                 Variable... variables)

Constructor with array.

Parameters:

variables - Array to set.

Variables

public Variables(@NotEmpty
                 @NotEmpty java.util.Collection<Variable> variables)

Constructor with collection.

Parameters:

variables - Collection to set.

Method Detail

init

public final void init(@Nullable
                       java.util.Map<java.lang.String,java.lang.String> vars)

Replaces variables (if defined) in the value.

Parameters:

vars - Variables to use.

asList

@NotEmpty
public final @NotEmpty java.util.List<Variable> asList()

Returns a list of variables.

Returns:

Unmodifiable list.

asMap

@NotEmpty
public @NotEmpty java.util.Map<java.lang.String,java.lang.String> asMap()

Returns a map of key/values.

Returns:

Unmodifiable map.