E - O tipo do elemento armazenado na lista.public abstract class ListParameter<E> extends SimpleParameter<List<E>>
| Modifier and Type | Field and Description |
|---|---|
protected boolean |
acceptDuplicates
Indica se o parâmetro aceita elementos repetidos,
|
protected boolean |
mustSort
Indica se os elementos precisam ser ordenados.
|
| Modifier | Constructor and Description |
|---|---|
protected |
ListParameter(String name,
String label,
String description,
List<E> defaultValue,
boolean isOptional,
boolean isVisible,
boolean mustSort,
boolean acceptDuplicates,
String commandLinePattern)
Cria o parâmetro.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
addElement(E element)
Adiciona um elemento ao valor deste parâmetro.
|
protected abstract SimpleParameterValidator<E> |
createItemValidator()
Cria o validador dos itens da lista.
|
ListParameterValidator<E> |
createParameterValidator()
Cria o validador do parâmetro.
|
protected String |
getCommandItemValue(CommandLineContext context,
E itemValue)
Obtém o valor de um ítem da lista pronto para ser utilizado na linha de
comando.
|
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). |
protected Comparator<E> |
getItemComparator()
Cria um comparador de itens da lista.
|
protected String |
getItemValueAsText(E element)
Codifica um elemento criando um texto.
|
abstract E |
getItemValueFromText(String elementAsText)
Decodifica um texto criando um elemento.
|
String |
getValueAsText()
Obtém o valor corrente sob a forma de string.
|
boolean |
mustSort()
Indica se precisa ordenar a lista de valores.
|
boolean |
removeElement(int index)
Remove um elemento específico.
|
boolean |
removeElementObj(E element)
Remove elemento específico.
|
boolean |
setElement(int index,
E newElement)
Troca um elemento por outro.
|
void |
setValueAsText(String parameterValue)
Atribui o valor corrente sob a forma de string.
|
addSimpleParameterListener, exportValue, fireValueWasChangedEvent, fireVisiblityWasChangedEvent, getCommandLine, getCommandLinePattern, getDefaultValue, getDescription, getLabel, getParameterValidator, getSimpleParameterListeners, getType, getValue, ignoreIfDisabled, ignoreIfInvisible, importValue, isEnabled, isOptional, isSetDefaultValue, isVisible, removeSimpleParameterListener, resetValue, setDefaultValue, setEnabled, setIgnoreIfDisabled, setIgnoreIfInvisible, setLabel, setValue, setVisible, validateprotected boolean mustSort
protected boolean acceptDuplicates
protected ListParameter(String name, String label, String description, List<E> defaultValue, boolean isOptional, boolean isVisible, boolean mustSort, boolean acceptDuplicates, String commandLinePattern)
name - O nome (Não aceita null).label - O rótulo (Não aceita null).description - A descrição (Não aceita null).defaultValue - O valor-padrão (Aceita null).isOptional - Indica se o parâmetro é opcional.isVisible - Indica se o parâmetro deve ficar visível.mustSort - Indica se os caminhos para os arquivos precisam ser
ordenados.acceptDuplicates - Indica se o parâmetro aceita elementos repetidos.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.public final boolean addElement(E element)
Adiciona um elemento ao valor deste parâmetro.
Gera o evento ParameterListener.valueWasChanged(Parameter).
element - O elemento (Não aceita null).true se o elemento foi adicionado com sucesso.public Object getExpressionValue()
Expression).getExpressionValue in class SimpleParameter<List<E>>null se não tiver valor corrente ou se
este parâmetro não pode participar de expressões.public String getValueAsText()
Obtém o valor corrente sob a forma de string.
Se método é completar ao método SimpleParameter.setValueAsText(String).
getValueAsText in class SimpleParameter<List<E>>null se ele não
existir.public final boolean removeElementObj(E element)
element - elementoremoveElement(int);public final boolean removeElement(int index)
Remove um elemento específico.
Gera o evento ParameterListener.valueWasChanged(Parameter).
index - O índice do elemento (A faixa aceita é de 0 a quantidade de
elementos - 1).true se o elemento foi removido com sucesso.public final boolean setElement(int index,
E newElement)
Troca um elemento por outro.
Gera o evento ParameterListener.valueWasChanged(Parameter).
index - O índice do elemento (A faixa aceita é de 0 a quantidade de
elementos - 1).newElement - O novo elemento (Aceita null).true em caso de sucesso ou false se o elemento que
estava armazenado na posição informada é igual ao elemento
fornecido.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().
setValueAsText in class SimpleParameter<List<E>>parameterValue - O valor corrente sob a forma de string (Aceita
null).ParseException - Se o valor passado não estiver em um formato aceito
por este parâmetro.public abstract E getItemValueFromText(String elementAsText) throws ParseException
elementAsText - O valor do elemento codificado (Aceita null).ParseException - Se o valor codificado não representar um elemento
que possa ser armazenado neste parâmetro.protected String getItemValueAsText(E element)
element - O elemento a ser codificado (Aceita null).null se o valor do elemento for
null).protected String getCommandValue(CommandLineContext context)
getCommandValue in class SimpleParameter<List<E>>context - Contexto para geração da linha de comando.null se o valor for nulo.protected String getCommandItemValue(CommandLineContext context, E itemValue)
context - Contexto para geração da linha de comando.itemValue - O valor (Não aceita null).public ListParameterValidator<E> createParameterValidator()
createParameterValidator in class SimpleParameter<List<E>>protected abstract SimpleParameterValidator<E> createItemValidator()
public boolean mustSort()
protected Comparator<E> getItemComparator()
Copyright © 2016. All rights reserved.