![]() |
SignDoc SDK (Java)
5.0.0
|
Actions and parameters for SignDocImage.clean(). More...
Public Member Functions | |
SignDocCleanParameters () throws SignDocException | |
Constructor. More... | |
synchronized SignDocCleanParameters | clone () throws SignDocException |
Clone this object. More... | |
synchronized void | clear () throws SignDocException |
Remove all actions. More... | |
synchronized void | add (String aName) throws SignDocException |
Add an action without parameter. More... | |
synchronized void | addBoolean (String aName, boolean aValue) throws SignDocException |
Add an action with a boolean parameter. More... | |
synchronized void | addInteger (String aName, int aValue) throws SignDocException |
Add an action with an integer parameter. More... | |
synchronized void | addNumber (String aName, double aValue) throws SignDocException |
Add an action with a floating-point number parameter. More... | |
synchronized int | getNumberOfActions () throws SignDocException |
Get the numbers of actions. More... | |
synchronized String | getNameAt (int aIndex) throws SignDocException |
Get the name of an action. More... | |
synchronized int | getTypeAt (int aIndex) throws SignDocException |
Get the type of the parameter of an action. More... | |
synchronized Boolean | getBooleanAt (int aIndex) throws SignDocException |
Get the value of a boolean parameter. More... | |
synchronized Integer | getIntegerAt (int aIndex) throws SignDocException |
Get the value of an integer parameter. More... | |
synchronized Double | getNumberAt (int aIndex) throws SignDocException |
Get the value of a floating-point number parameter. More... | |
synchronized String | getErrorMessage () throws SignDocException |
Get an error message for the last function call. More... | |
synchronized void | close () |
Destroy the underlying native object (for java.lang.AutoCloseable). More... | |
Static Public Member Functions | |
static int | getType (String aName) throws SignDocException |
Get the type of a parameter. More... | |
Static Public Attributes | |
static final int | t_undefined = 0 |
Return value of getType() and getTypeAt(): The specified action is not defined. More... | |
static final int | t_boolean = 1 |
Return value of getType() and getTypeAt(): Boolean. More... | |
static final int | t_integer = 2 |
Return value of getType() and getTypeAt(): Integer. More... | |
static final int | t_number = 3 |
Return value of getType() and getTypeAt(): Floating-point number. More... | |
static final int | t_void = 7 |
Return value of getType() and getTypeAt(): void (no value). More... | |
Protected Member Functions | |
void | finalize () throws Throwable |
Finalize this object. More... | |
Actions and parameters for SignDocImage.clean().
SignDocCleanParameters | ( | ) | throws SignDocException |
Constructor.
No actions will be set.
synchronized void add | ( | String | aName | ) | throws SignDocException |
Add an action without parameter.
The following actions without parameter are available:
This function throws SignDocUnknownParameterException if aName is not the name of an action without parameter.
[in] | aName | The name of the action (case-sensitive). |
synchronized void addBoolean | ( | String | aName, |
boolean | aValue | ||
) | throws SignDocException |
Add an action with a boolean parameter.
The following action with boolean parameter is available:
This function throws SignDocUnknownParameterException if aName is not the name of an action with boolean parameter.
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void addInteger | ( | String | aName, |
int | aValue | ||
) | throws SignDocException |
Add an action with an integer parameter.
The following actions with integer parameter are available:
This function throws SignDocUnknownParameterException if aName is not the name of an action with integer parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void addNumber | ( | String | aName, |
double | aValue | ||
) | throws SignDocException |
Add an action with a floating-point number parameter.
The following actions with a floating-point number parameter are available:
This function throws SignDocUnknownParameterException if aName is not the name of an action with floating-point number parameter, SignDocInvalidValueException if aValue is invalid.
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
synchronized void clear | ( | ) | throws SignDocException |
Remove all actions.
synchronized SignDocCleanParameters clone | ( | ) | throws SignDocException |
Clone this object.
synchronized void close | ( | ) |
Destroy the underlying native object (for java.lang.AutoCloseable).
After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.
|
protected |
Finalize this object.
Do not call this method unless you know what you are doing.
synchronized Boolean getBooleanAt | ( | int | aIndex | ) | throws SignDocException |
Get the value of a boolean parameter.
[in] | aIndex | The zero-based index of the action. |
synchronized String getErrorMessage | ( | ) | throws SignDocException |
Get an error message for the last function call.
synchronized Integer getIntegerAt | ( | int | aIndex | ) | throws SignDocException |
Get the value of an integer parameter.
[in] | aIndex | The zero-based index of the action. |
synchronized String getNameAt | ( | int | aIndex | ) | throws SignDocException |
Get the name of an action.
[in] | aIndex | The zero-based index of the action. |
synchronized Double getNumberAt | ( | int | aIndex | ) | throws SignDocException |
Get the value of a floating-point number parameter.
[in] | aIndex | The zero-based index of the action. |
synchronized int getNumberOfActions | ( | ) | throws SignDocException |
Get the numbers of actions.
|
static |
Get the type of a parameter.
[in] | aName | The name of the action (case-sensitive). |
synchronized int getTypeAt | ( | int | aIndex | ) | throws SignDocException |
Get the type of the parameter of an action.
[in] | aIndex | The zero-based index of the action. |
|
static |
Return value of getType() and getTypeAt(): Boolean.
|
static |
Return value of getType() and getTypeAt(): Integer.
|
static |
Return value of getType() and getTypeAt(): Floating-point number.
|
static |
Return value of getType() and getTypeAt(): The specified action is not defined.
|
static |
Return value of getType() and getTypeAt(): void (no value).