Package org.apache.juneau.dto.swagger

Class License

java.lang.Object
org.apache.juneau.dto.swagger.SwaggerElement
org.apache.juneau.dto.swagger.License
@Bean(properties="name,url,*") public class License extends SwaggerElement
License information for the exposed API.
Example:

// Construct using SwaggerBuilder. License license = license("Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0.html"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(license); // Or just use toString() which does the same as above. json = license.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.
      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: SwaggerElement
      Generic property getter.

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

      Overrides:
      get in class SwaggerElement
      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: SwaggerElement
      Generic property setter.

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

      Overrides:
      set in class SwaggerElement
      Parameters:
      property - The property name to set.
      value - The new value for the property.
      Returns:
      This object.

    • keySet

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