Package org.eclipse.microprofile.openapi.models.info

Interface License

All Superinterfaces:
Constructible, Extensible<License>
public interface License extends Constructible, Extensible<License>
This interface represents the License information for the exposed API.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIdentifier()
    Returns the license identifier for this License instance that is used for the API.
    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.
    default License
    identifier(String identifier)
    Sets this License instance's identifier used for the API and returns this instance of License.
    default License
    name(String name)
    Sets this License instance's name used for the API and returns this instance of License.
    void
    setIdentifier(String identifier)
    Sets the license identifier for this License instance that is used for the API.
    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.
    default 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, 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

      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

      default 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

    • getIdentifier

      String getIdentifier()
      Returns the license identifier for this License instance that is used for the API.
      Returns:
      the license identifier used for the API
      Since:
      4.0

    • setIdentifier

      void setIdentifier(String identifier)
      Sets the license identifier for this License instance that is used for the API.
      Parameters:
      identifier - the license identifier used for the API
      Since:
      4.0

    • identifier

      default License identifier(String identifier)
      Sets this License instance's identifier used for the API and returns this instance of License.
      Parameters:
      identifier - the license identifier used for the API
      Returns:
      this License instance
      Since:
      4.0

    • 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

      default 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