csbase.logic.algorithms.parameters

Class EnumerationItem

java.lang.Object

csbase.logic.algorithms.parameters.EnumerationItem

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnumerationItem>

public final class EnumerationItem
extends java.lang.Object
implements java.lang.Comparable<EnumerationItem>, java.io.Serializable

Item de enumeração

O item de enumeração é o elemento do parâmetro enumeração ( EnumerationParameter). Um item de enumeração possui um identificador, um rótulo e um valor. O identificador é utilizado para criar relacionamentos com outros elementos como gatilhos e enumerações. O identificador também utilizado para verificar a igualdade entre 2 ítens de enumeração, ou seja, se 2 ítens de enumeração possuem o mesmo identificador eles são considerados iguais. O rótulo é texto que é exibido ao usuário. O valor é o texto que é utilizado na linha de comando.

Um item de enumeração pode ser habilitado/desabilitado.

Author:

lmoreira

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnumerationItem(java.lang.String id, java.lang.String name, java.lang.String value, java.lang.String description) Cria um item de enumeração.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EnumerationItem item) A ordem natural de um item de enumeração é a ordem crescente dos rótulos.
boolean	equals(java.lang.Object o)
java.lang.String	getDescription() Obtém a descrição deste item.
java.lang.String	getId() Obtém o identificador deste item.
java.lang.String	getLabel() Obtém o rótulo deste item.
java.lang.String	getValue() Obtém o valor deste item.
int	hashCode()
boolean	isVisible() Indica se um item de enumeração está visível (true) ou oculto ( false).
java.lang.String	toString() A representação com uma String do item é o seu rótulo.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumerationItem

public EnumerationItem(java.lang.String id,
               java.lang.String name,
               java.lang.String value,
               java.lang.String description)

Cria um item de enumeração.

Parameters:

id - O identificador do item (Não aceita null).

name - O nome do item (Não aceita null).

value - O valor do item (Não aceita null).

description - A descrição do item ((Aceita null).

Method Detail

compareTo

public int compareTo(EnumerationItem item)

A ordem natural de um item de enumeração é a ordem crescente dos rótulos.

Specified by:

compareTo in interface java.lang.Comparable<EnumerationItem>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDescription

public java.lang.String getDescription()

Obtém a descrição deste item.

Returns:

A descrição ou null se ela não existir.

getId

public java.lang.String getId()

Obtém o identificador deste item.

Returns:

O identificador.

getLabel

public java.lang.String getLabel()

Obtém o rótulo deste item.

Returns:

O rótulo.

getValue

public java.lang.String getValue()

Obtém o valor deste item.

Returns:

O valor.

isVisible

public boolean isVisible()

Indica se um item de enumeração está visível (true) ou oculto ( false).

Returns:

true se estiver visível ou false se estiver oculto.

toString

public java.lang.String toString()

A representação com uma String do item é o seu rótulo.

Overrides:

toString in class java.lang.Object