Interface License
- All Superinterfaces:
Constructible
,Extensible<License>
This interface represents the License information for the exposed API.
- See Also:
-
- "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#licenseObject"
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns the license name for this License instance that is used for the API.getUrl()
Returns the URL for this License instance that is used for the API.default License
Sets this License instance's name used for the API and returns this instance of License.void
Sets the license name for this License instance that is used for the API.void
Sets this URL for this License instance that is used for the API.default License
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, extensions, getExtensions, removeExtension, setExtensions
-
Method Details
-
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
Sets the license name for this License instance that is used for the API.- Parameters:
name
- the license name used for the API
-
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
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
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
-