@Bean(properties="name,description,externalDocs,*") public class Tag extends SwaggerElement
It is not mandatory to have a Tag Object per tag used there.
Constructor and Description |
---|
Tag()
Default constructor.
|
Tag(Tag copyFrom)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
Tag |
copy()
Make a deep copy of this object.
|
Tag |
description(Object value)
Same as
setDescription(String) . |
Tag |
externalDocs(Object value)
|
<T> T |
get(String property,
Class<T> type)
Generic property getter.
|
String |
getDescription()
Bean property getter:
|
ExternalDocumentation |
getExternalDocs()
Bean property getter:
|
String |
getName()
Bean property getter:
|
Set<String> |
keySet()
Returns all the keys on this element.
|
Tag |
name(Object value)
Same as
setName(String) . |
Tag |
set(String property,
Object value)
Generic property setter.
|
Tag |
setDescription(String value)
Bean property setter:
|
Tag |
setExternalDocs(ExternalDocumentation value)
Bean property setter:
|
Tag |
setName(String value)
Bean property setter:
|
public Tag()
public String getName()
The name of the tag.
public Tag setName(String value)
The name of the tag.
value
- The new value for this property.
public Tag name(Object value)
setName(String)
.value
- The new value for this property.
public String getDescription()
A short description for the tag.
public Tag setDescription(String value)
A short description for the tag.
value
- The new value for this property.
public Tag description(Object value)
setDescription(String)
.value
- The new value for this property.
public ExternalDocumentation getExternalDocs()
Additional external documentation for this tag.
public Tag setExternalDocs(ExternalDocumentation value)
Additional external documentation for this tag.
value
- The new value for this property.
public Tag externalDocs(Object value)
value
- The new value for this property.
ExternalDocumentation
ExternalDocumentation
externalDocs(
public <T> T get(String property, Class<T> type)
SwaggerElement
Can be used to retrieve non-standard Swagger fields such as
get
in class SwaggerElement
property
- The property name to retrieve.type
- The datatype to cast the value to.public Tag set(String property, Object value)
SwaggerElement
Can be used to set non-standard Swagger fields such as
set
in class SwaggerElement
property
- The property name to set.value
- The new value for the property.public Set<String> keySet()
SwaggerElement
keySet
in class SwaggerElement
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.