org.apache.juneau.dto.swagger

Class License

java.lang.Object

org.apache.juneau.dto.swagger.SwaggerElement

org.apache.juneau.dto.swagger.License

@Bean(bpi="name,url,*")
public class License
extends SwaggerElement

License information for the exposed API.

Example:

// Construct using SwaggerBuilder. License x = license("Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0.html"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }

• Overview > juneau-dto > Swagger

Constructor Summary

Constructors

Constructor and Description
License() Default constructor.
License(License copyFrom) Copy constructor.

Method Summary

Modifier and Type	Method and Description
License	copy() Make a deep copy of this object.
<T> T	get(String property, Class<T> type) Generic property getter.
String	getName() Bean property getter: name.
URI	getUrl() Bean property getter: url.
boolean	hasName() Returns true if the name property is not null or empty.
boolean	hasUrl() Returns true if the url property is not null.
Set<String>	keySet() Returns all the keys on this element.
License	name(Object value) Same as setName(String).
License	set(String property, Object value) Generic property setter.
License	setName(String value) Bean property setter: name.
License	setUrl(URI value) Bean property setter: url.
License	url(Object value) Same as setUrl(URI).

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

asMap, extraKeys, get, isStrict, strict, strict, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

License

public License()

Default constructor.

License

public License(License copyFrom)

Copy constructor.

Parameters:

copyFrom - The object to copy.

Method Detail

copy

public License copy()

Make a deep copy of this object.

Returns:

A deep copy of this object.

getName

public String getName()

Bean property getter: name.

The license name used for the API.

Returns:

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

setName

public License setName(String value)

Bean property setter: name.

The license name used for the API.

Parameters:

value - The new value for this property.
Property value is required.

Returns:

This object (for method chaining).

name

public License name(Object value)

Same as setName(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.

A URL to the license used for the API.

Returns:

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

setUrl

public License setUrl(URI value)

Bean property setter: url.

A URL to the license used for the API.

Parameters:

value - The new value for this property.
URIs defined by UriResolver can be used for values.
Can be null to unset the property.

Returns:

This object (for method chaining).

url

public License url(Object value)

Same as setUrl(URI).

Parameters:

value - The new value for this property.
Non-URI values will be converted to URI using new URI(value.toString()).
Valid types:

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

Can be null to unset the property.

Returns:

This object (for method chaining).

hasName

public boolean hasName()

Returns true if the name property is not null or empty.

Returns:

true if the name property is not null or empty.

hasUrl

public boolean hasUrl()

Returns true if the url property is not null.

Returns:

true if the url property is not null.

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 License 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).

keySet

public Set<String> keySet()

Description copied from class: SwaggerElement

Returns all the keys on this element.

Overrides:

keySet in class SwaggerElement

Returns:

All the keys on this element.
Never null.