Package org.apache.juneau.dto.openapi3

Class Link

java.lang.Object
org.apache.juneau.dto.openapi3.OpenApiElement
org.apache.juneau.dto.openapi3.Link
@Bean(properties="operationRef,operationId,description,requestBody,server,parameters,*") public class Link extends OpenApiElement
information for Link object.
Example:

// Construct using SwaggerBuilder. Contact x = contact("API Support", "http://www.swagger.io/support", "support@swagger.io"); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "name": "API Support", "url": "http://www.swagger.io/support", "email": "support@swagger.io" }

  • Constructor Details

    • Link

      public Link()
      Default constructor.

    • Link

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

  • Method Details

    • copy

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

    • getOperationRef

      public String getOperationRef()
      Bean property getter: operationRef.

      The identifying name of the contact person/organization.

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

    • setOperationRef

      public Link setOperationRef(String value)
      Bean property setter: operationRef.

      The identifying name of the contact person/organization.

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

    • getDescription

      public String getDescription()
      Bean property getter: description.

      The URL pointing to the contact information.

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

    • setDescription

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

    • getOperationId

      public String getOperationId()
      Bean property getter: externalValue.

      The email address of the contact person/organization.

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

    • setOperationId

      public Link setOperationId(String value)
      Bean property setter: externalValue.

      The email address of the contact person/organization.

      Parameters:
      value - The new value for this property.
      MUST be in the format of an email address.
      Can be null to unset the property.
      Returns:
      This object

    • getRequestBody

      public Object getRequestBody()
      Bean property getter: default.

      Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "value" has no meaning for required parameters.) Unlike JSON Schema this value MUST conform to the defined type for this parameter.

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

    • setRequestBody

      public Link setRequestBody(Object val)
      Bean property setter: value.

      Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) Unlike JSON Schema this value MUST conform to the defined type for this parameter.

      Parameters:
      val - The new value for this property.
      Returns:
      This object

    • getServer

      public Server getServer()
      Bean property getter: additionalProperties.
      Returns:
      The property value, or null if it is not set.

    • setServer

      public Link setServer(Server value)
      Bean property setter: additionalProperties.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getParameters

      public Map<String,Object> getParameters()
      Bean property getter: examples.

      An example of the response message.

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

    • setParameters

      public Link setParameters(Map<String,Object> value)
      Bean property setter: examples.

      An example of the response message.

      Parameters:
      value - The new value for this property.
      Keys must be MIME-type strings.
      Can be null to unset the property.
      Returns:
      This object

    • addParameter

      public Link addParameter(String mimeType, Object parameter)
      Adds a single value to the examples property.
      Parameters:
      mimeType - The mime-type string.
      parameter - The example.
      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 Link 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.
      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.