Package org.apache.juneau.bean.openapi3

Class Example

java.lang.Object
org.apache.juneau.bean.openapi3.OpenApiElement
org.apache.juneau.bean.openapi3.Example
public class Example extends OpenApiElement
information for Examples object.

The Example Object provides an example of a media type. The example object is mutually exclusive of the examples object. Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.

OpenAPI Specification:

The Example Object is composed of the following fields:

  • summary (string) - Short description for the example
  • description (string) - Long description for the example. CommonMark syntax MAY be used for rich text representation
  • value (any) - Embedded literal example. The value field and externalValue field are mutually exclusive
  • externalValue (string) - A URI that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive
Example:

// Construct using SwaggerBuilder. Example x = example() .setSummary("User example") .setValue("John Doe"); // Serialize using JsonSerializer. String json = Json.from(x); // Or just use toString() which does the same as above. json = x.toString();

// Output { "summary": "User example", "value": "John Doe" }

See Also:

  • Constructor Details

    • Example

      public Example()
      Default constructor.

    • Example

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

  • Method Details

    • copy

      public Example copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of 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.

    • getDescription

      public String getDescription()
      Bean property getter: description.

      Long description for the example.

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

    • getExternalValue

      public String getExternalValue()
      Bean property getter: externalValue.

      A URI that points to the literal example.

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

    • getSummary

      public String getSummary()
      Bean property getter: summary.

      Short description for the example.

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

    • getValue

      public Object getValue()
      Bean property getter: value.

      Embedded literal example.

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

    • 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.

    • set

      public Example 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, or an IllegalArgumentException is thrown.
      value - The new value for the property.
      Returns:
      This object

    • setDescription

      public Example setDescription(String value)
      Bean property setter: description.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • setExternalValue

      public Example setExternalValue(String value)
      Bean property setter: externalValue.

      A URI that points to the literal example.

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

    • setSummary

      public Example setSummary(String value)
      Bean property setter: summary.

      Short description for the example.

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

    • setValue

      public Example setValue(Object val)
      Bean property setter: value.

      Embedded literal example.

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

    • strict

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

    • strict

      public Example 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