Package org.apache.juneau.dto.swagger

Class Tag

java.lang.Object
org.apache.juneau.dto.swagger.SwaggerElement
org.apache.juneau.dto.swagger.Tag
@Bean(properties="name,description,externalDocs,*") public class Tag extends SwaggerElement
Allows adding meta data to a single tag that is used by the Operation Object.

It is not mandatory to have a Tag Object per tag used there.

Example:

// Construct using SwaggerBuilder. Tag tag = tag() .name("pet") .description("Pets operations") // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(tag); // Or just use toString() which does the same as above. json = tag.toString();

// Output { "name": "pet", "description": "Pets operations" }

See Also:

  • Constructor Details

    • Tag

      public Tag()
      Default constructor.

    • Tag

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

  • Method Details

    • copy

      public Tag copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of this object.

    • getDescription

      public String getDescription()
      Bean property getter: description.

      A short description for the tag.

      Returns:
      The property value, or null if it is not set.

    • setDescription

      public Tag setDescription(String value)
      Bean property setter: description.

      A short description for the tag.

      Parameters:
      value - The new value for this property.
      GFM syntax can be used for rich text representation.
      Can be null to unset the property.
      Returns:
      This object.

    • getExternalDocs

      public ExternalDocumentation getExternalDocs()
      Bean property getter: externalDocs.

      Additional external documentation for this tag.

      Returns:
      The property value, or null if it is not set.

    • setExternalDocs

      public Tag setExternalDocs(ExternalDocumentation value)
      Bean property setter: externalDocs.

      Additional external documentation for this tag.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object.

    • getName

      public String getName()
      Bean property getter: name.

      The name of the tag.

      Returns:
      The property value, or null if it is not set.

    • setName

      public Tag setName(String value)
      Bean property setter: name.

      The name of the tag.

      Parameters:
      value - The new value for this property.
      Property value is required.
      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 Tag 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.