Package org.apache.juneau.bean.openapi3

Class License

java.lang.Object
org.apache.juneau.bean.openapi3.OpenApiElement
org.apache.juneau.bean.openapi3.License
public class License extends OpenApiElement
License information for the exposed API.

The License Object provides license information for the exposed API. This information helps clients understand the terms under which the API can be used, including any restrictions or requirements.

OpenAPI Specification:

The License Object is composed of the following fields:

  • name (string, REQUIRED) - The license name used for the API
  • url (string) - A URL to the license used for the 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 = Json.from(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" }

See Also:

  • Constructor Details

    • License

      public License()
      Default constructor.

    • License

      public License(License copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The object to copy.

  • Method Details

    • 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.
      Can be null to unset the property.
      Returns:
      This object

    • 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

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: OpenApiElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class OpenApiElement
      Type Parameters:
      T - The datatype to cast the value to.
      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: OpenApiElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class OpenApiElement
      Parameters:
      property - The property name to set. Must not be null.
      value - The new value for the property.
      Returns:
      This object

    • keySet

      public Set<String> keySet()
      Description copied from class: OpenApiElement
      Returns all the keys on this element.
      Overrides:
      keySet in class OpenApiElement
      Returns:
      All the keys on this element.
      Never null.

    • strict

      public License strict()
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Returns:
      This object

    • strict

      public License strict(Object value)
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Parameters:
      value - The new value for this property.
      Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
      Can be null (interpreted as false).
      Returns:
      This object