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