Class TaskOption
- java.lang.Object
-
- org.eclipse.birt.report.engine.api.TaskOption
-
- All Implemented Interfaces:
ITaskOption
- Direct Known Subclasses:
DataExtractionOption
,RenderOption
public class TaskOption extends java.lang.Object implements ITaskOption
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Map
options
a hash map that stores the rendering options
-
Constructor Summary
Constructors Constructor Description TaskOption()
constructorTaskOption(java.util.Map options)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getBooleanOption(java.lang.String name, boolean defaultValue)
Get boolean option value by name.int
getIntOption(java.lang.String name, int defaultValue)
java.lang.Object
getOption(java.lang.String name)
get option value for one rendering optionjava.util.Map
getOptions()
Get options.java.lang.String
getStringOption(java.lang.String name)
Get option value by name.boolean
hasOption(java.lang.String name)
Check if an option is defined.void
setOption(java.lang.String name, java.lang.Object value)
set value for one rendering option
-
-
-
Method Detail
-
setOption
public void setOption(java.lang.String name, java.lang.Object value)
set value for one rendering option- Specified by:
setOption
in interfaceITaskOption
- Parameters:
name
- the option namevalue
- value for the option
-
getOption
public java.lang.Object getOption(java.lang.String name)
get option value for one rendering option- Specified by:
getOption
in interfaceITaskOption
- Parameters:
name
- the option name- Returns:
- the option value
-
hasOption
public boolean hasOption(java.lang.String name)
Check if an option is defined.- Specified by:
hasOption
in interfaceITaskOption
- Parameters:
name
- option name.- Returns:
- true if user has defined an option with this name, even if the value is NULL. false otherwise.
-
getOptions
public java.util.Map getOptions()
Get options.- Specified by:
getOptions
in interfaceITaskOption
- Returns:
- options
-
getStringOption
public java.lang.String getStringOption(java.lang.String name)
Get option value by name.- Parameters:
name
- the option name- Returns:
- the option value
-
getBooleanOption
public boolean getBooleanOption(java.lang.String name, boolean defaultValue)
Get boolean option value by name.- Parameters:
name
- the option namedefaultValue
- default option value- Returns:
- default value
-
getIntOption
public int getIntOption(java.lang.String name, int defaultValue)
-
-