@Bean(properties="description,url,*") public class ExternalDocumentation extends SwaggerElement
Constructor and Description |
---|
ExternalDocumentation()
Default constructor.
|
ExternalDocumentation(ExternalDocumentation copyFrom)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
ExternalDocumentation |
copy()
Make a deep copy of this object.
|
ExternalDocumentation |
description(Object value)
Same as
setDescription(String) . |
<T> T |
get(String property,
Class<T> type)
Generic property getter.
|
String |
getDescription()
Bean property getter:
|
URI |
getUrl()
Bean property getter:
|
boolean |
hasDescription()
Returns
|
boolean |
hasUrl()
Returns
|
Set<String> |
keySet()
Returns all the keys on this element.
|
ExternalDocumentation |
set(String property,
Object value)
Generic property setter.
|
ExternalDocumentation |
setDescription(String value)
Bean property setter:
|
ExternalDocumentation |
setUrl(URI value)
Bean property setter:
|
ExternalDocumentation |
url(Object value)
Same as
setUrl(URI) . |
asMap, extraKeys, get, getExtraProperties, isStrict, strict, strict, toString
public ExternalDocumentation()
public ExternalDocumentation(ExternalDocumentation copyFrom)
copyFrom
- The object to copy.public ExternalDocumentation copy()
public String getDescription()
A short description of the target documentation.
public ExternalDocumentation setDescription(String value)
A short description of the target documentation.
value
- The new value for this property.
public ExternalDocumentation description(Object value)
setDescription(String)
.value
- The new value for this property.
toString()
.
public URI getUrl()
The URL for the target documentation.
public ExternalDocumentation setUrl(URI value)
The URL for the target documentation.
value
- The new value for this property.
UriResolver
can be used for values.public ExternalDocumentation url(Object value)
setUrl(URI)
.value
- The new value for this property.
UriResolver
can be used for values.
public boolean hasUrl()
public boolean hasDescription()
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 ExternalDocumentation 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 © 2018 Apache. All rights reserved.