public class DocumentParameter
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Parameters specified in the SSM document that execute on the server when the command is run.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
defaultValue
If specified, the default values for the parameters.
|
private java.lang.String |
description
A description of what the parameter does, how to use it, the default
value, and whether or not the parameter is optional.
|
private java.lang.String |
name
The name of the parameter.
|
private java.lang.String |
type
The type of parameter.
|
Constructor and Description |
---|
DocumentParameter() |
Modifier and Type | Method and Description |
---|---|
DocumentParameter |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDefaultValue()
If specified, the default values for the parameters.
|
java.lang.String |
getDescription()
A description of what the parameter does, how to use it, the default
value, and whether or not the parameter is optional.
|
java.lang.String |
getName()
The name of the parameter.
|
java.lang.String |
getType()
The type of parameter.
|
int |
hashCode() |
void |
setDefaultValue(java.lang.String defaultValue)
If specified, the default values for the parameters.
|
void |
setDescription(java.lang.String description)
A description of what the parameter does, how to use it, the default
value, and whether or not the parameter is optional.
|
void |
setName(java.lang.String name)
The name of the parameter.
|
void |
setType(DocumentParameterType type)
The type of parameter.
|
void |
setType(java.lang.String type)
The type of parameter.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DocumentParameter |
withDefaultValue(java.lang.String defaultValue)
If specified, the default values for the parameters.
|
DocumentParameter |
withDescription(java.lang.String description)
A description of what the parameter does, how to use it, the default
value, and whether or not the parameter is optional.
|
DocumentParameter |
withName(java.lang.String name)
The name of the parameter.
|
DocumentParameter |
withType(DocumentParameterType type)
The type of parameter.
|
DocumentParameter |
withType(java.lang.String type)
The type of parameter.
|
private java.lang.String name
The name of the parameter.
private java.lang.String type
The type of parameter. The type can be either “String” or “StringList”.
private java.lang.String description
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
private java.lang.String defaultValue
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
public void setName(java.lang.String name)
The name of the parameter.
name
- The name of the parameter.public java.lang.String getName()
The name of the parameter.
public DocumentParameter withName(java.lang.String name)
The name of the parameter.
name
- The name of the parameter.public void setType(java.lang.String type)
The type of parameter. The type can be either “String” or “StringList”.
type
- The type of parameter. The type can be either “String” or
“StringList”.DocumentParameterType
public java.lang.String getType()
The type of parameter. The type can be either “String” or “StringList”.
DocumentParameterType
public DocumentParameter withType(java.lang.String type)
The type of parameter. The type can be either “String” or “StringList”.
type
- The type of parameter. The type can be either “String” or
“StringList”.DocumentParameterType
public void setType(DocumentParameterType type)
The type of parameter. The type can be either “String” or “StringList”.
type
- The type of parameter. The type can be either “String” or
“StringList”.DocumentParameterType
public DocumentParameter withType(DocumentParameterType type)
The type of parameter. The type can be either “String” or “StringList”.
type
- The type of parameter. The type can be either “String” or
“StringList”.DocumentParameterType
public void setDescription(java.lang.String description)
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
description
- A description of what the parameter does, how to use it, the
default value, and whether or not the parameter is optional.public java.lang.String getDescription()
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
public DocumentParameter withDescription(java.lang.String description)
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
description
- A description of what the parameter does, how to use it, the
default value, and whether or not the parameter is optional.public void setDefaultValue(java.lang.String defaultValue)
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
defaultValue
- If specified, the default values for the parameters. Parameters
without a default value are required. Parameters with a default
value are optional.public java.lang.String getDefaultValue()
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
public DocumentParameter withDefaultValue(java.lang.String defaultValue)
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
defaultValue
- If specified, the default values for the parameters. Parameters
without a default value are required. Parameters with a default
value are optional.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DocumentParameter clone()
clone
in class java.lang.Object