Package org.apache.juneau.dto.swagger

Class Contact

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

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

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

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

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

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

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

    • setUrl

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

      The URL pointing to the contact information.

      Parameters:
      value - The new value for this property.
      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 Contact 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.