Top Description Methods
org.eclipse.microprofile.openapi.models.info

public Interface Contact

extends Constructible, Extensible<Contact>
Imports
org.eclipse.microprofile.openapi.models.Constructible, .Extensible

This interface represents the Contact information for the exposed API.
See Also
OpenAPI Specification Contact Object

Method Summary

Modifier and TypeMethod and Description
public default Contact

Returns:

this Contact instance
email
(String
the email of the contact person/organization
email
)

Sets this Contact instance's contact email to the given email and returns this instance of Contact

public String

Returns:

the email of the contact person/organization
getEmail
()

Returns the contact email of this Contact instance.

public String

Returns:

the name of the contact person/organization
getName
()

Returns the identifying name of this Contact instance.

public String

Returns:

the URL pointing to the contact information
getUrl
()

Returns the URL pointing to the contact information for this Contact instance.

public default Contact

Returns:

this Contact instance
name
(String
the name of the contact person/organization
name
)

Sets this Contact instance's identifying name to the given name and returns this instance of Contact.

public void
setEmail(String
the email of the contact person/organization
email
)

Sets the contact email of this instance of Contact.

public void
setName(String
the name of the contact person/organization
name
)

Sets the identifying name of this Contact instance.

public void
setUrl(String
the URL pointing to the contact information
url
)

Sets this Contact instance's URL pointing to the contact information.

public default Contact

Returns:

this Contact instance
url
(String
the url pointing to the contact information
url
)

Sets this Contact instance's URL pointing to the contact information and returns this instance of Contact.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:
addExtensionextensionsgetExtensionsremoveExtensionsetExtensions

Method Detail

emailback to summary
public default Contact email(String email)

Sets this Contact instance's contact email to the given email and returns this instance of Contact

Parameters
email:String

the email of the contact person/organization

Returns:Contact

this Contact instance

getEmailback to summary
public String getEmail()

Returns the contact email of this Contact instance.

Returns:String

the email of the contact person/organization

getNameback to summary
public String getName()

Returns the identifying name of this Contact instance.

Returns:String

the name of the contact person/organization

getUrlback to summary
public String getUrl()

Returns the URL pointing to the contact information for this Contact instance.

Returns:String

the URL pointing to the contact information

nameback to summary
public default Contact name(String name)

Sets this Contact instance's identifying name to the given name and returns this instance of Contact.

Parameters
name:String

the name of the contact person/organization

Returns:Contact

this Contact instance

setEmailback to summary
public void setEmail(String email)

Sets the contact email of this instance of Contact.

Parameters
email:String

the email of the contact person/organization

setNameback to summary
public void setName(String name)

Sets the identifying name of this Contact instance.

Parameters
name:String

the name of the contact person/organization

setUrlback to summary
public void setUrl(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:String

the URL pointing to the contact information

urlback to summary
public default Contact url(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:String

the url pointing to the contact information

Returns:Contact

this Contact instance