org.pageseeder.berlioz.furi

Class VariableType

java.lang.Object

org.pageseeder.berlioz.furi.VariableType

public final class VariableType
extends Object

Defines a variable type. The variable type may be used for any purpose. It is just a mechanism to qualify variables further than merely by name. Systems may choose to use a variable type to indicate a particular behaviour for the variable or to enforce a particular type of value.

Since:

Berlioz 0.9.32

Version:

Berlioz 0.9.32

Author:

Christophe Lauret

Constructor Summary

Constructors

Constructor and Description
VariableType(String name) Create a new variable type.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getName() Return the name of this variable type.
int	hashCode()
protected static boolean	isValidName(String name) Indicates whether the name of this variable type is valid.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableType

public VariableType(String name)

Create a new variable type.

Parameters:

name - The name of the variable

Throws:

NullPointerException - If the specified name is null.

IllegalArgumentException - If the specified name is an empty string.

Method Detail

getName

public String getName()

Return the name of this variable type.

Returns:

The name of this variable type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isValidName

protected static boolean isValidName(String name)

Indicates whether the name of this variable type is valid.

Parameters:

name - The name of the variable.

Returns:

true if the name is valid; false otherwise.