|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IReportOptions
Field Summary | |
---|---|
static java.lang.String |
DISABLED
Constant to use for defining an option that is disabled |
static java.lang.String |
ENABLED
Constant to use for defining an option that is enabled |
Method Summary | |
---|---|
boolean |
checkGlobalOption(java.lang.String optKey,
boolean dflt)
Determine if a given boolean option is currently enabled, checking the current options object and all other options object that have been pushed on the options stack for the calling thread. |
void |
declareOption(java.lang.String key,
java.lang.String value,
java.lang.String description)
Declare an option in the current options object. |
java.lang.String |
getGlobalOption(java.lang.String optKey)
Get the value associated with a given option, checking the current options object and all other options object that have been pushed on the options stack for the calling thread. |
void |
pop()
Pop the top-most options object from the top of the options stack for the current thread. |
void |
push()
Push the current options object on the options stack for the current thread. |
void |
setOption(java.lang.String optString)
Add an option definition to the current options object. |
Field Detail |
---|
static final java.lang.String ENABLED
static final java.lang.String DISABLED
Method Detail |
---|
java.lang.String getGlobalOption(java.lang.String optKey)
optKey
- a String that specifies the desired option
boolean checkGlobalOption(java.lang.String optKey, boolean dflt)
optKey
- a String that specifies the desired optiondflt
- a default value to use if this option is neither explicitly enabled nor disabled
void setOption(java.lang.String optString)
optString
- the option definition, in form "key=value"void declareOption(java.lang.String key, java.lang.String value, java.lang.String description)
key
- a key representing the option being declaredvalue
- a default value. This default value will be returned by @link #getGlobalOption(String)
or @link #checkGlobalOption(String) if there was no explicit @link #setOption(String) for this option in this
option object or any other option object on the options stack for the calling thread.description
- a description for the option being declared, suitable for use in
"help" messages, etc.void push()
void pop()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |