Package org.apache.juneau.bean.openapi3

Class Contact

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

The Contact Object provides contact information for the exposed API. This information can be used by clients to get in touch with the API maintainers for support, questions, or other inquiries.

OpenAPI Specification:

The Contact Object is composed of the following fields:

  • name (string) - The identifying name of the contact person/organization
  • url (string) - The URL pointing to the contact information
  • email (string) - The email address of the contact person/organization
Example:

// Construct using SwaggerBuilder. Contact x = contact("API Support", "http://www.swagger.io/support", "support@swagger.io"); // Serialize using JsonSerializer. String json = Json.from(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" }

See Also:

  • Constructor Details

    • Contact

      public Contact()
      Default constructor.

    • Contact

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

  • Method Details

    • copy

      public Contact 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.

    • getEmail

      public String getEmail()
      Bean property getter: email.

      The email address of the contact person/organization.

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

    • getName

      public String getName()
      Bean property getter: name.

      The identifying name of the contact person/organization.

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

    • getUrl

      public URI getUrl()
      Bean property getter: url.

      The URL pointing to the contact information.

      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 Contact 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

    • setEmail

      public Contact setEmail(String value)
      Bean property setter: email.

      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

    • setName

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

      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

    • setUrl

      public Contact setUrl(URI value)
      Bean property setter: url.

      The value can be of any of the following types: URI, URL, String.
      Strings must be valid URIs.

      URIs defined by UriResolver can be used for values.

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

    • strict

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

    • strict

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