Package net.sf.tweety.plugin.parameter
Class CommandParameter
- java.lang.Object
-
- net.sf.tweety.plugin.parameter.CommandParameter
-
- All Implemented Interfaces:
java.lang.Cloneable
- Direct Known Subclasses:
FileListCommandParameter
,IntegerCommandParameter
,SelectionCommandParameter
,StringListCommandParameter
public abstract class CommandParameter extends java.lang.Object implements java.lang.Cloneable
This is the abstract basics class for CommandParameter Never leave identifier and description arguments for the constructor empty, they can not be changed afterwards- Author:
- Bastian Wolf
-
-
Constructor Summary
Constructors Constructor Description CommandParameter(java.lang.String id, java.lang.String des)
non-empty constructor (member variables cannot be changed after construction)
-
Method Summary
Modifier and Type Method Description java.lang.String
getDescription()
returns the description for this parameterjava.lang.String
getIdentifier()
returns this parameters name (the identifier)abstract CommandParameter
instantiate(java.lang.String s)
instantiate the command with the given argument string if validabstract boolean
isValid(java.lang.String s)
Checks, if the given String is a valid argument for this command parameter
-
-
-
Constructor Detail
-
CommandParameter
public CommandParameter(java.lang.String id, java.lang.String des)
non-empty constructor (member variables cannot be changed after construction)- Parameters:
id
- the identifier string for this command parameter (e.g. aggr for aggregation)des
- the description string for this command parameter
-
-
Method Detail
-
getIdentifier
public java.lang.String getIdentifier()
returns this parameters name (the identifier)- Returns:
- this parameters name (the identifier)
-
getDescription
public java.lang.String getDescription()
returns the description for this parameter- Returns:
- the description for this parameter
-
isValid
public abstract boolean isValid(java.lang.String s)
Checks, if the given String is a valid argument for this command parameter- Parameters:
s
- the given input string- Returns:
- true if valid, false if not
-
instantiate
public abstract CommandParameter instantiate(java.lang.String s)
instantiate the command with the given argument string if valid- Parameters:
s
- the given argument string- Returns:
- The CommandParameter instance or null if the given string is not valid.
-
-