public class ParameterDescriptor extends IgnorableDescriptor<ParameterDescriptor>
RequestDocumentation.parameterWithName(java.lang.String)
Modifier | Constructor and Description |
---|---|
protected |
ParameterDescriptor(String name)
Creates a new
ParameterDescriptor describing the parameter with the given
name . |
Modifier and Type | Method and Description |
---|---|
String |
getName()
Returns the name of the parameter being described by this descriptor.
|
boolean |
isOptional()
Returns
true if the described parameter is optional, otherwise
false . |
ParameterDescriptor |
optional()
Marks the parameter as optional.
|
ignored, isIgnored
attributes, description, getAttributes, getDescription
protected ParameterDescriptor(String name)
ParameterDescriptor
describing the parameter with the given
name
.name
- the name of the parameterpublic final ParameterDescriptor optional()
this
public final String getName()
public final boolean isOptional()
true
if the described parameter is optional, otherwise
false
.true
if the described parameter is optional, otherwise
false