ToolElement (Eoulsan 2.6.1 API)

All Known Implementing Classes:

AbstractParameterToolElement, AbstractToolElement, BooleanParameterToolElement, ConditionalToolElement, DataToolElement, EmptyToolElement, FloatParameterToolElement, IntegerParameterToolElement, SelectParameterToolElement, TextParameterToolElement
```
public interface ToolElement
```
The ToolElement interface.

Since:

2.0

Author:

Sandrine Perrin

Field Summary

Fields
Modifier and Type Field Description

static String SEP
The Constant SEP.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getName()`	Gets the name.
`String`	`getShortName()`	Gets the short name.
`String`	`getValidatedName()`	Gets the name which respect Eoulsan's syntax.
`String`	`getValue()`	Gets the value.
`void`	`setValue(String value)`	Sets the value.

- Field Detail
  - SEP
```
static final String SEP
```
    The Constant SEP.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Gets the name.
    
    Returns:
    
    the name
  - getShortName
```
String getShortName()
```
    Gets the short name.
    
    Returns:
    
    the short name
  - getValidatedName
```
String getValidatedName()
```
    Gets the name which respect Eoulsan's syntax.
    
    Returns:
    
    the name
  - getValue
```
String getValue()
```
    Gets the value.
    
    Returns:
    
    the value
  - setValue
```
void setValue(String value)
       throws EoulsanException
```
    Sets the value.
    
    Parameters:
    
    value - the value
    
    Throws:
    
    EoulsanException - the eoulsan exception