Top Description Methods
org.eclipse.microprofile.openapi.models.info

public Interface License

extends Constructible, Extensible<License>
Imports
org.eclipse.microprofile.openapi.models.Constructible, .Extensible

This interface represents the License information for the exposed API.
See Also
OpenAPI Specification License Object

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the license identifier used for the API
getIdentifier
()

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

public String

Returns:

the license name used for the API
getName
()

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

public String

Returns:

the URL to the license used for the API
getUrl
()

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

public default License

Returns:

this License instance
identifier
(String
the license identifier used for the API
identifier
)

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

public default License

Returns:

this License instance
name
(String
the license name used for the API
name
)

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

public void
setIdentifier(String
the license identifier used for the API
identifier
)

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

public void
setName(String
the license name used for the API
name
)

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

public void
setUrl(String
the URL to the license used for the API
url
)

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

public default License

Returns:

this License instance
url
(String
the URL to the license used for the API
url
)

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

Inherited from org.eclipse.microprofile.openapi.models.Extensible:
addExtensionextensionsgetExtensionsremoveExtensionsetExtensions

Method Detail

getIdentifierback to summary
public String getIdentifier()

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

Returns:String

the license identifier used for the API

Since
4.0
getNameback to summary
public String getName()

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

Returns:String

the license name used for the API

getUrlback to summary
public String getUrl()

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

Returns:String

the URL to the license used for the API

identifierback to summary
public default License identifier(String identifier)

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

Parameters
identifier:String

the license identifier used for the API

Returns:License

this License instance

Since
4.0
nameback to summary
public default License name(String name)

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

Parameters
name:String

the license name used for the API

Returns:License

this License instance

setIdentifierback to summary
public void setIdentifier(String identifier)

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

Parameters
identifier:String

the license identifier used for the API

Since
4.0
setNameback to summary
public void setName(String name)

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

Parameters
name:String

the license name used for the API

setUrlback to summary
public void setUrl(String url)

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

Parameters
url:String

the URL to the license used for the API

urlback to summary
public default License url(String url)

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

Parameters
url:String

the URL to the license used for the API

Returns:License

this License instance