Package writer2latex.api
Class ComplexOption
java.lang.Object
writer2latex.api.ComplexOption
A complex option is a set of named keys, each pointing to a set of named attributes
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Clear the contents of the setboolean
containsKey
(String sName) Test if this complex options contains a specific option namevoid
Define a key using a copy of a the provided attributes.void
copyAll
(ComplexOption co) Copy all values from anotherComplexOption
(overwrites existing values)Get the value belonging to a keykeySet()
Get the names of all options that are currently defined by this complex optionvoid
Define a key.void
Remove an option from the set, if it exists
-
Constructor Details
-
ComplexOption
public ComplexOption()
-
-
Method Details
-
clear
public void clear()Clear the contents of the set -
remove
Remove an option from the set, if it exists- Parameters:
sName
- the name of the key to remove
-
put
Define a key. If the key already exists, the old value will be replaced- Parameters:
sName
- the name of the key. The name must be non-empty, otherwise the request will be ignored.attributes
-
-
copy
Define a key using a copy of a the provided attributes. If the key already exists, the old value will be replaced- Parameters:
sName
- the name of the key. The name must be non-empty, otherwise the request will be ignored.attributes
-
-
get
Get the value belonging to a key- Parameters:
sName
- the name of the key- Returns:
- the attributes, or null if the option doesn't exist
-
copyAll
Copy all values from anotherComplexOption
(overwrites existing values)- Parameters:
co
- another instance ofComplexOption
-
keySet
Get the names of all options that are currently defined by this complex option- Returns:
- all names as a
Set
-
containsKey
Test if this complex options contains a specific option name- Parameters:
sName
- the name to test- Returns:
- true if the name exists
-