Interface IToolParameters

All Superinterfaces:

Comparable<IToolParameters>, IPropertySet<String>

All Known Implementing Classes:

DefaultToolParameters

public interface IToolParameters
extends IPropertySet<String>, Comparable<IToolParameters>

Method Summary

Modifier and Type	Method	Description
int	getId()
String	getName()
String	getSerializationFormat()
String	getTool()
Collection<String>	getTrimmedProperties()
String	getValueForTrimmedProperty(String trimmedProperty)

Methods inherited from interface Comparable

compareTo

Methods inherited from interface IPropertySet

add, addAll, containsProperty, fillWith, getProperties, getSubTree, getValues, getValues

Modifier and Type	Method	Description
boolean	add(List<String> path, String value)
boolean	addAll(List<String> path, Set<String> value)
boolean	containsProperty(String path)
void	fillWith(Object o)
Collection<String>	getProperties()
IPropertySet<String>	getSubTree(List<String> subTreePrefix)
Set<String>	getValues(String path)
Set<String>	getValues(List<String> key)

Method Details

getName

String getName()

Returns:

a label, denoting the name of the tool parameters

getId

int getId()

Returns:

the id of the tool parameters

getSerializationFormat

String getSerializationFormat()

Returns:

a string that can be used as XML tag or JSON key for exporting results

getTool

String getTool()

Returns:

the name of the tool to which the parameters apply

getTrimmedProperties

Collection<String> getTrimmedProperties()

Returns:

the list of properties without prefixes

getValueForTrimmedProperty

String getValueForTrimmedProperty(String trimmedProperty)

Returns:

the value for the a given trimmed property