csbase.logic.algorithms.parameters

Class BooleanParameter

java.lang.Object

csbase.logic.algorithms.parameters.Parameter<V>

csbase.logic.algorithms.parameters.SimpleParameter<Boolean>

csbase.logic.algorithms.parameters.BooleanParameter

All Implemented Interfaces:

Serializable, Comparable<Parameter<Boolean>>

public final class BooleanParameter
extends SimpleParameter<Boolean>

Parâmetro do tipo booleano.

Author:

lmoreira

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE A representação textual do tipo do parâmetro.

Constructor Summary

Constructors

Constructor and Description
BooleanParameter(String name, String label, String description, boolean defaultValue, boolean isVisible, String commandLinePattern, String falseCommand, String trueCommand) Cria um parâmetro booleano.

Method Summary

Modifier and Type	Method and Description
BooleanParameterValidator	createParameterValidator() Cria o validador do parâmetro.
protected String	getCommandValue(CommandLineContext context) Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.
Object	getExpressionValue() Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).
String	getFalseCommand() Obtém o valor da linha de comando quando o parâmetro tem como valor falso.
String	getTrueCommand() Obtém o valor da linha de comando quando o parâmetro tem como valor verdadeiro.
String	getType() Obtém um texto que representa o tipo deste parâmetros.
void	setValueAsText(String parameterValue) Atribui o valor corrente sob a forma de string.
void	toggleValue() Alterna os valores deste parâmetro, ou seja, se estiver true, ele se tornará false e vice-versa.

Methods inherited from class csbase.logic.algorithms.parameters.SimpleParameter

addSimpleParameterListener, exportValue, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getValue, getValueAsText, ignoreIfDisabled, ignoreIfInvisible, importValue, isEnabled, isOptional, isSetDefaultValue, isVisible, removeSimpleParameterListener, resetValue, setDefaultValue, setEnabled, setIgnoreIfDisabled, setIgnoreIfInvisible, setLabel, setValue, setVisible, validate

Methods inherited from class csbase.logic.algorithms.parameters.Parameter

compareTo, equals, getName, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

A representação textual do tipo do parâmetro.

See Also:

Constant Field Values

Constructor Detail

BooleanParameter

public BooleanParameter(String name,
                        String label,
                        String description,
                        boolean defaultValue,
                        boolean isVisible,
                        String commandLinePattern,
                        String falseCommand,
                        String trueCommand)

Cria um parâmetro booleano.

Parameters:

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

label - O rótulo (Não aceita null).

description - A descrição do parâmetro (Não aceita null).

defaultValue - O valor-padrão.

isVisible - Indica se o parâmetro deve ficar visível.

commandLinePattern - O padrão para construção da linha de comando. O padrão será utilizado para escrever o trecho da linha do comando referente ao parâmetro. Esta string será passada para o método MessageFormat.format(String,Object...). O primeiro formato ({0}) é referente ao nome e o segundo formato ({1}) é referente ao valor. Se null o parâmetro não produzirá saída na linha de comando.

falseCommand - O valor da linha de comando para valor corrente igual a false (Aceita null - se for nulo o valor
será DEFAULT_FALSE_COMMAND).

trueCommand - O valor da linha de comando para valor corrente igual a true (Aceita null - se for nulo o valor
será DEFAULT_TRUE_COMMAND).

Method Detail

toggleValue

public void toggleValue()

Alterna os valores deste parâmetro, ou seja, se estiver true, ele se tornará false e vice-versa.

getExpressionValue

public Object getExpressionValue()

Obtém o valor corrente convertido para um valor que pode ser utilizado em expressões (Expression).

Specified by:

getExpressionValue in class SimpleParameter<Boolean>

Returns:

O valor corrente ou null se não tiver valor corrente ou se este parâmetro não pode participar de expressões.

getFalseCommand

public String getFalseCommand()

Obtém o valor da linha de comando quando o parâmetro tem como valor falso.

Returns:

.

getType

public String getType()

Obtém um texto que representa o tipo deste parâmetros.

Specified by:

getType in class SimpleParameter<Boolean>

Returns:

O tipo.

getTrueCommand

public String getTrueCommand()

Obtém o valor da linha de comando quando o parâmetro tem como valor verdadeiro.

Returns:

.

setValueAsText

public void setValueAsText(String parameterValue)
                    throws ParseException

Atribui o valor corrente sob a forma de string.

Se método é completar ao método SimpleParameter.getValueAsText().

Specified by:

setValueAsText in class SimpleParameter<Boolean>

Parameters:

parameterValue - O valor corrente sob a forma de string (Aceita null).

Throws:

ParseException - Se o valor passado não estiver em um formato aceito por este parâmetro.

getCommandValue

protected String getCommandValue(CommandLineContext context)

Obtém o valor corrente convertido para um valor que possa ser utilizado na linha de comando.

Overrides:

getCommandValue in class SimpleParameter<Boolean>

Parameters:

context - Contexto para geração da linha de comando.

Returns:

O valor ou null se o valor for nulo.

createParameterValidator

public BooleanParameterValidator createParameterValidator()

Cria o validador do parâmetro.

Specified by:

createParameterValidator in class SimpleParameter<Boolean>

Returns:

O validador.