org.eclipse.microprofile.openapi.models.info

Interface License

All Superinterfaces:

Constructible, Extensible

public interface License
extends Constructible, Extensible

This interface represents the License information for the exposed API.

See Also:

"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#licenseObject"

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the license name for this License instance that is used for the API.
String	getUrl() Returns the URL for this License instance that is used for the API.
License	name(String name) Sets this License instance's name used for the API and returns this instance of License.
void	setName(String name) Sets the license name for this License instance that is used for the API.
void	setUrl(String url) Sets this URL for this License instance that is used for the API.
License	url(String url) Sets this License instance's URL used for the API and returns this instance of License.

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, getExtensions, setExtensions

Method Detail

getName

String getName()

Returns the license name for this License instance that is used for the API.

Returns:

the license name used for the API

setName

void setName(String name)

Sets the license name for this License instance that is used for the API.

Parameters:

name - the license name used for the API

name

License name(String name)

Sets this License instance's name used for the API and returns this instance of License.

Parameters:

name - the license name used for the API

Returns:

this License instance

getUrl

String getUrl()

Returns the URL for this License instance that is used for the API.

Returns:

the URL to the license used for the API

setUrl

void setUrl(String url)

Sets this URL for this License instance that is used for the API.

Parameters:

url - the URL to the license used for the API

url

License url(String url)

Sets this License instance's URL used for the API and returns this instance of License.

Parameters:

url - the URL to the license used for the API

Returns:

this License instance