Class DocumentParameter
- All Implemented Interfaces:
Serializable
,Cloneable
Parameters specified in the SSM document that execute on the server when the command is run.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
If specified, the default values for the parameters.A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.getName()
The name of the parameter.getType()
The type of parameter.int
hashCode()
void
setDefaultValue
(String defaultValue) If specified, the default values for the parameters.void
setDescription
(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
The name of the parameter.void
setType
(DocumentParameterType type) The type of parameter.void
The type of parameter.toString()
Returns a string representation of this object; useful for testing and debugging.withDefaultValue
(String defaultValue) If specified, the default values for the parameters.withDescription
(String description) A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.The name of the parameter.The type of parameter.The type of parameter.
-
Constructor Details
-
DocumentParameter
public DocumentParameter()
-
-
Method Details
-
setName
The name of the parameter.
- Parameters:
name
- The name of the parameter.
-
getName
The name of the parameter.
- Returns:
- The name of the parameter.
-
withName
The name of the parameter.
- Parameters:
name
- The name of the parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setType
The type of parameter. The type can be either “String” or “StringList”.
- Parameters:
type
- The type of parameter. The type can be either “String” or “StringList”.- See Also:
-
getType
The type of parameter. The type can be either “String” or “StringList”.
- Returns:
- The type of parameter. The type can be either “String” or “StringList”.
- See Also:
-
withType
The type of parameter. The type can be either “String” or “StringList”.
- Parameters:
type
- The type of parameter. The type can be either “String” or “StringList”.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setType
The type of parameter. The type can be either “String” or “StringList”.
- Parameters:
type
- The type of parameter. The type can be either “String” or “StringList”.- See Also:
-
withType
The type of parameter. The type can be either “String” or “StringList”.
- Parameters:
type
- The type of parameter. The type can be either “String” or “StringList”.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDescription
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
- Parameters:
description
- A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
-
getDescription
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
- Returns:
- A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
-
withDescription
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
- Parameters:
description
- A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultValue
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
- Parameters:
defaultValue
- If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
-
getDefaultValue
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
- Returns:
- If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
-
withDefaultValue
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
- Parameters:
defaultValue
- If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-