org.apache.juneau.dto.swagger

Class ExternalDocumentation

java.lang.Object

org.apache.juneau.dto.swagger.SwaggerElement

org.apache.juneau.dto.swagger.ExternalDocumentation

@Bean(properties="description,url,*")
public class ExternalDocumentation
extends SwaggerElement

Allows referencing an external resource for extended documentation.

Example:

// Construct using SwaggerBuilder. ExternalDocumentation x = externalDocumentation("https://swagger.io", "Find more info here"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "description": "Find more info here", "url": "https://swagger.io" }

See Also:

• Overview > juneau-dto > Swagger

Constructor Summary

Constructors

Constructor and Description
ExternalDocumentation()

Method Summary

Modifier and Type	Method and Description
ExternalDocumentation	description(Object value) Same as setDescription(String).
<T> T	get(String property, Class<T> type) Generic property getter.
String	getDescription() Bean property getter: description.
URI	getUrl() Bean property getter: url.
ExternalDocumentation	set(String property, Object value) Generic property setter.
ExternalDocumentation	setDescription(String value) Bean property setter: description.
ExternalDocumentation	setUrl(URI value) Bean property setter: url.
ExternalDocumentation	url(Object value) Same as setUrl(URI).

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

getExtraProperties, isStrict, strict, strict, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExternalDocumentation

public ExternalDocumentation()

Method Detail

getDescription

public String getDescription()

Bean property getter: description.

A short description of the target documentation.

Returns:

The property value, or null if it is not set.

setDescription

public ExternalDocumentation setDescription(String value)

Bean property setter: description.

A short description of the target documentation.

Parameters:

value - The new value for this property.
GFM syntax can be used for rich text representation.
Can be null to unset the property.

Returns:

This object (for method chaining).

description

public ExternalDocumentation description(Object value)

Same as setDescription(String).

Parameters:

value - The new value for this property.
Non-String values will be converted to String using toString().
Can be null to unset the property.

Returns:

This object (for method chaining).

getUrl

public URI getUrl()

Bean property getter: url.

The URL for the target documentation.

Returns:

The property value, or null if it is not set.

setUrl

public ExternalDocumentation setUrl(URI value)

Bean property setter: url.

The URL for the target documentation.

Parameters:

value - The new value for this property.
Property value is required.
URIs defined by UriResolver can be used for values.

Returns:

This object (for method chaining).

url

public ExternalDocumentation url(Object value)

Same as setUrl(URI).

Parameters:

value - The new value for this property.
URIs defined by UriResolver can be used for values.
Valid types:

• URI
• URL
• String
  Converted to URI using new URI(value.toString()).

Can be null to unset the property.

Returns:

This object (for method chaining).

get

public <T> T get(String property,
                 Class<T> type)

Description copied from class: SwaggerElement

Generic property getter.

Can be used to retrieve non-standard Swagger fields such as "$ref".

Overrides:

get in class SwaggerElement

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

public ExternalDocumentation set(String property,
                                 Object value)

Description copied from class: SwaggerElement

Generic property setter.

Can be used to set non-standard Swagger fields such as "$ref".

Overrides:

set in class SwaggerElement

Parameters:

property - The property name to set.

value - The new value for the property.

Returns:

This object (for method chaining).