csbase.logic.algorithms.parameters

Class ParameterDocumentation

java.lang.Object

csbase.logic.algorithms.parameters.ParameterDocumentation

public class ParameterDocumentation
extends Object

Classe que contém a documentação de um parâmetro.

Constructor Summary

Constructors

Constructor and Description
ParameterDocumentation() Constutor.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String attributeName, String attributeDescription) Adiciona a descrição de um atributo.
String	getAttribute(String attributeName) Obtém a descrição de um atributo, dado seu nome.
String	getDescription() Obtém a descrição do parâmetro.
String	getTitle() Obtém o título do parâmetro.
void	setDescription(String description) Define a descrição do parâmetro.
void	setTitle(String title) Define o

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterDocumentation

public ParameterDocumentation()

Constutor.

Method Detail

setTitle

public void setTitle(String title)

Define o

Parameters:

title -

getTitle

public String getTitle()

Obtém o título do parâmetro.

Returns:

o título do parâmetro.

setDescription

public void setDescription(String description)

Define a descrição do parâmetro.

Parameters:

description - a descrição do parâmetro.

getDescription

public String getDescription()

Obtém a descrição do parâmetro.

Returns:

descrição de um atributo.

getAttribute

public String getAttribute(String attributeName)

Obtém a descrição de um atributo, dado seu nome.

Parameters:

attributeName - nome do atributo.

Returns:

descrição de um atributo.

addAttribute

public void addAttribute(String attributeName,
                         String attributeDescription)

Adiciona a descrição de um atributo.

Parameters:

attributeName - nome do atributo.

attributeDescription - descrição do atributo.