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 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" }

See Also:

• Overview > juneau-dto > Swagger

Constructor Summary

Constructors

Constructor and Description
Contact()

Method Summary

Modifier and Type	Method and Description
Contact	email(Object value) Same as setEmail(String).
<T> T	get(String property, Class<T> type) Generic property getter.
String	getEmail() Bean property getter: email.
String	getName() Bean property getter: name.
URI	getUrl() Bean property getter: url.
Contact	name(Object value) Same as setName(String).
Contact	set(String property, Object value) Generic property setter.
Contact	setEmail(String value) Bean property setter: email.
Contact	setName(String value) Bean property setter: name.
Contact	setUrl(URI value) Bean property setter: url.
Contact	url(Object value) Same as setUrl(URI).

Methods inherited from class org.apache.juneau.dto.swagger.SwaggerElement

getExtraProperties, isStrict, strict, strict, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Contact

public Contact()

Method Detail

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 (for method chaining).

name

public Contact name(Object value)

Same as setName(String).

Parameters:

value - The new value for this property.
Non-String values will be converted to String using toString().
Can be null to unset the property.

Returns:

This object (for method chaining).

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 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 (for method chaining).

url

public Contact url(Object value)

Same as setUrl(URI).

Parameters:

value - The new value for this property.
Non-URI values will be converted to URI using new URI(value.toString()).
Can be null to unset the property.

Returns:

This object (for method chaining).

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 (for method chaining).

email

public Contact email(Object value)

Same as setEmail(String).

Parameters:

value - The new value for this property.
Non-String values will be converted to String using toString().
MUST be in the format of an email address.
Can be null to unset the property.

Returns:

This object (for method chaining).

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

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 (for method chaining).