Package org.eclipse.microprofile.openapi.models.info

Interface Contact

  • All Superinterfaces:
    Constructible, Extensible

    public interface Contact
extends Constructible, Extensible
    This interface represents the Contact information for the exposed API.
    See Also:
    "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.md#contactObject"

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Contact email​(java.lang.String email)
      Sets this Contact instance's contact email to the given email and returns this instance of Contact
      java.lang.String getEmail​()
      Returns the contact email of this Contact instance.
      java.lang.String getName​()
      Returns the identifying name of this Contact instance.
      java.lang.String getUrl​()
      Returns the URL pointing to the contact information for this Contact instance.
      Contact name​(java.lang.String name)
      Sets this Contact instance's identifying name to the given name and returns this instance of Contact.
      void setEmail​(java.lang.String email)
      Sets the contact email of this instance of Contact.
      void setName​(java.lang.String name)
      Sets the identifying name of this Contact instance.
      void setUrl​(java.lang.String url)
      Sets this Contact instance's URL pointing to the contact information.
      Contact url​(java.lang.String url)
      Sets this Contact instance's URL pointing to the contact information and returns this instance of Contact.

    • Method Detail

      • getName

        java.lang.String getName​()
        Returns the identifying name of this Contact instance.
        Returns:
        the name of the contact person/organization

      • setName

        void setName​(java.lang.String name)
        Sets the identifying name of this Contact instance.
        Parameters:
        name - the name of the contact person/organization

      • name

        Contact name​(java.lang.String name)
        Sets this Contact instance's identifying name to the given name and returns this instance of Contact.
        Parameters:
        name - the name of the contact person/organization
        Returns:
        this Contact instance

      • getUrl

        java.lang.String getUrl​()
        Returns the URL pointing to the contact information for this Contact instance.
        Returns:
        the URL pointing to the contact information

      • setUrl

        void setUrl​(java.lang.String url)
        Sets this Contact instance's URL pointing to the contact information. The URL must be in the format of a URL.
        Parameters:
        url - the URL pointing to the contact information

      • url

        Contact url​(java.lang.String url)
        Sets this Contact instance's URL pointing to the contact information and returns this instance of Contact. The URL must be in the format of a URL.
        Parameters:
        url - the url pointing to the contact information
        Returns:
        this Contact instance

      • getEmail

        java.lang.String getEmail​()
        Returns the contact email of this Contact instance.
        Returns:
        the email of the contact person/organization

      • setEmail

        void setEmail​(java.lang.String email)
        Sets the contact email of this instance of Contact.
        Parameters:
        email - the email of the contact person/organization

      • email

        Contact email​(java.lang.String email)
        Sets this Contact instance's contact email to the given email and returns this instance of Contact
        Parameters:
        email - the email of the contact person/organization
        Returns:
        this Contact instance