Class Tag
It is not mandatory to have a Tag Object per tag used there.
Example:
See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Make a deep copy of this object.<T> T
Generic property getter.Bean property getter:description .Bean property getter:externalDocs .getName()
Bean property getter:name .keySet()
Returns all the keys on this element.Generic property setter.setDescription
(String value) Bean property setter:description .Bean property setter:externalDocs .Bean property setter:name .
-
Constructor Details
-
Tag
public Tag()Default constructor. -
Tag
Copy constructor.- Parameters:
copyFrom
- The object to copy.
-
-
Method Details
-
copy
Make a deep copy of this object.- Returns:
- A deep copy of this object.
-
getDescription
Bean property getter:description .A short description for the tag.
- Returns:
- The property value, or
null if it is not set.
-
setDescription
Bean property setter:description .A short description for the tag.
- Parameters:
value
- The new value for this property.
GFM syntax can be used for rich text representation.
Can benull to unset the property.- Returns:
- This object.
-
getExternalDocs
Bean property getter:externalDocs .Additional external documentation for this tag.
- Returns:
- The property value, or
null if it is not set.
-
setExternalDocs
Bean property setter:externalDocs .Additional external documentation for this tag.
- Parameters:
value
- The new value for this property.
Can benull to unset the property.- Returns:
- This object.
-
getName
Bean property getter:name .The name of the tag.
- Returns:
- The property value, or
null if it is not set.
-
setName
Bean property setter:name .The name of the tag.
- Parameters:
value
- The new value for this property.
Property value is required.- Returns:
- This object.
-
get
Description copied from class:SwaggerElement
Generic property getter.Can be used to retrieve non-standard Swagger fields such as
"$ref" .- Overrides:
get
in classSwaggerElement
- Type Parameters:
T
- The datatype to cast the value to.- Parameters:
property
- The property name to retrieve.type
- The datatype to cast the value to.- Returns:
- The property value, or
null if the property does not exist or is not set.
-
set
Description copied from class:SwaggerElement
Generic property setter.Can be used to set non-standard Swagger fields such as
"$ref" .- Overrides:
set
in classSwaggerElement
- Parameters:
property
- The property name to set.value
- The new value for the property.- Returns:
- This object.
-
keySet
Description copied from class:SwaggerElement
Returns all the keys on this element.- Overrides:
keySet
in classSwaggerElement
- Returns:
- All the keys on this element.
Nevernull .
-