Info (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.swagger.SwaggerElement
- - org.apache.juneau.dto.swagger.Info

```
@Bean(properties="title,description,termsOfService,contact,license,version,*")
public class Info
extends SwaggerElement
```
The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
Example:

// Construct using SwaggerBuilder. Info x = info("Swagger Sample App", "1.0.1") .description("This is a sample server Petstore server.") .termsOfService("http://swagger.io/terms/") .contact( contact("API Support", "http://www.swagger.io/support", "support@swagger.io") ) .license( license("Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0.html") ); // Serialize using JsonSerializer. String json = JsonSerializer.DEFAULT.toString(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "title": "Swagger Sample App", "description": "This is a sample server Petstore server.", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "API Support", "url": "http://www.swagger.io/support", "email": "support@swagger.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.1" }

See Also:
- Overview > juneau-dto > Swagger

Constructor Summary

Constructors
Constructor and Description

Info()

Constructors
Constructor and Description
`Info()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Info`	`contact(Object value)` Same as `setContact(Contact)`.
`Info`	`description(Object value)` Same as `setDescription(String)`.
`<T> T`	`get(String property, Class<T> type)` Generic property getter.
`Contact`	`getContact()` Bean property getter: contact.
`String`	`getDescription()` Bean property getter: description.
`License`	`getLicense()` Bean property getter: license.
`String`	`getTermsOfService()` Bean property getter: termsOfService.
`String`	`getTitle()` Bean property getter: title.
`String`	`getVersion()` Bean property getter: version.
`Info`	`license(Object value)` Same as `setLicense(License)`.
`Info`	`set(String property, Object value)` Generic property setter.
`Info`	`setContact(Contact value)` Bean property setter: contact.
`Info`	`setDescription(String value)` Bean property setter: description.
`Info`	`setLicense(License value)` Bean property setter: license.
`Info`	`setTermsOfService(String value)` Bean property setter: termsOfService.
`Info`	`setTitle(String value)` Bean property setter: title.
`Info`	`setVersion(String value)` Bean property setter: version.
`Info`	`termsOfService(Object value)` Same as `setTermsOfService(String)`.
`Info`	`title(Object value)` Same as `setTitle(String)`.
`Info`	`version(Object value)` Same as `setVersion(String)`.

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
  - Info
```
public Info()
```
- Method Detail
  - getTitle
```
public String getTitle()
```
    Bean property getter: title.
    The title of the application.
    
    Returns:
    
    The property value, or null if it is not set.
  - setTitle
```
public Info setTitle(String value)
```
    Bean property setter: title.
    The title of the application.
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - title
```
public Info title(Object value)
```
    Same as setTitle(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).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    A short description of the application.
    
    Returns:
    
    The property value, or null if it is not set.
  - setDescription
```
public Info setDescription(String value)
```
    Bean property setter: description.
    A short description of the application.
    
    Parameters:
    
    value - The new value for this property.
    GFM syntax can be used for rich text representation.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - description
```
public Info description(Object value)
```
    Same as setDescription(String).
    
    Parameters:
    
    value - The new value for this property.
    Non-String values will be converted to String using toString().
    GFM syntax can be used for rich text representation.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - getTermsOfService
```
public String getTermsOfService()
```
    Bean property getter: termsOfService.
    The Terms of Service for the API.
    
    Returns:
    
    The property value, or null if it is not set.
  - setTermsOfService
```
public Info setTermsOfService(String value)
```
    Bean property setter: termsOfService.
    The Terms of Service for the API.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - termsOfService
```
public Info termsOfService(Object value)
```
    Same as setTermsOfService(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).
  - getContact
```
public Contact getContact()
```
    Bean property getter: contact.
    The contact information for the exposed API.
    
    Returns:
    
    The property value, or null if it is not set.
  - setContact
```
public Info setContact(Contact value)
```
    Bean property setter: contact.
    The contact information for the exposed API.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - contact
```
public Info contact(Object value)
```
    Same as setContact(Contact).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    Contact
    String - JSON object representation of Contact
    Example:
    
    contact("{name:'name',url:'url',...}");
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getLicense
```
public License getLicense()
```
    Bean property getter: license.
    The license information for the exposed API.
    
    Returns:
    
    The property value, or null if it is not set.
  - setLicense
```
public Info setLicense(License value)
```
    Bean property setter: license.
    The license information for the exposed API.
    
    Parameters:
    
    value - The new value for this property.
    Can be null to unset the property.
    
    Returns:
    
    This object (for method chaining).
  - license
```
public Info license(Object value)
```
    Same as setLicense(License).
    Parameters:
    value - The new value for this property.
    Valid types:
    
    License
    String - JSON object representation of License
    Example:
    
    license("{name:'name',url:'url',...}");
    
    Can be null to unset the property.
    Returns:
    
    This object (for method chaining).
  - getVersion
```
public String getVersion()
```
    Bean property getter: version.
    Provides the version of the application API (not to be confused with the specification version).
    
    Returns:
    
    The property value, or null if it is not set.
  - setVersion
```
public Info setVersion(String value)
```
    Bean property setter: version.
    Provides the version of the application API (not to be confused with the specification version).
    
    Parameters:
    
    value - The new value for this property.
    Property value is required.
    
    Returns:
    
    This object (for method chaining).
  - version
```
public Info version(Object value)
```
    Same as setVersion(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).
  - 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 Info 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).

Class Info

Example:

See Also:

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Info

Method Detail

getTitle

setTitle

title

getDescription

setDescription

description

getTermsOfService

setTermsOfService

termsOfService

getContact

setContact

contact

Example:

getLicense

setLicense

license

Example:

getVersion

setVersion

version

get

set