org.fuin.xmlcfg4j

Class Variable

java.lang.Object

org.fuin.xmlcfg4j.Variable

public final class Variable
extends java.lang.Object

Represents a variable definition (name and value).

Constructor Summary

Constructors

Constructor and Description
Variable(@NotEmpty java.lang.String name, @NotEmpty java.lang.String value) Constructor with name and value.
Variable(@NotEmpty java.lang.String name, @NotNull java.net.URL url, @NotEmpty java.lang.String encoding) Constructor with name and URL.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEncoding() Returns the encoding to use for reading the value from the URL.
java.lang.String	getEncodingOrDefault() Returns the encoding to use for reading the value from the URL.
@NotEmpty java.lang.String	getName() Returns the name.
java.net.URL	getURL() Returns the URL.
java.lang.String	getValue() Returns the value.
int	hashCode()
void	init(java.util.Map<java.lang.String,java.lang.String> vars) Replaces variables (if defined) in the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Variable

public Variable(@NotEmpty
                @NotEmpty java.lang.String name,
                @NotEmpty
                @NotEmpty java.lang.String value)

Constructor with name and value.

Parameters:

name - Name to set.

value - Value to set.

Variable

public Variable(@NotEmpty
                @NotEmpty java.lang.String name,
                @NotNull
                @NotNull java.net.URL url,
                @NotEmpty
                @NotEmpty java.lang.String encoding)

Constructor with name and URL.

Parameters:

name - Name to set.

url - URL that references a text resource.

encoding - Encoding of the text resource the URL points to.

Method Detail

getName

@NotEmpty
public final @NotEmpty java.lang.String getName()

Returns the name.

Returns:

Current name.

getValue

public final java.lang.String getValue()

Returns the value. If no value but an URL is defined, the value will be loaded once from the URL. Later calls will only return the cached value.

Returns:

Value or null.

getURL

public final java.net.URL getURL()

Returns the URL.

Returns:

URL or null.

getEncoding

public final java.lang.String getEncoding()

Returns the encoding to use for reading the value from the URL.

Returns:

Encoding or null.

getEncodingOrDefault

public final java.lang.String getEncodingOrDefault()

Returns the encoding to use for reading the value from the URL. If no encoding is defined this method returns 'utf-8' as default.

Returns:

Encoding - Never null.

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.

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object