Package dk.mada.jaxrs.model

Class Info

java.lang.Object

dk.mada.jaxrs.model.Info

Direct Known Subclasses:

ImmutableInfo

@Immutable
public abstract class Info
extends Object

API

See Also:

• infoObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Info.Contact	The contact information for the API.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Info()	Creates new instance.

Method Summary

Modifier and Type	Method	Description
static ImmutableInfo.Builder	builder()	Returns a builder for this type.
Info.Contact	contact()	Returns the contact information for the API.
abstract Optional<String>	description()	Returns the optional description of the API.
abstract Optional<String>	termsOfService()	Returns the optional TOS of the API.
abstract String	title()	Returns the title of the API.
abstract String	version()	Returns the version of the API.

Methods inherited from class java.lang.Object

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

Constructor Details

Info

protected Info()

Creates new instance.

Method Details

builder

public static ImmutableInfo.Builder builder()

Returns a builder for this type.

Returns:

a builder for this type

title

public abstract String title()

Returns the title of the API.

Returns:

the title of the API

version

public abstract String version()

Returns the version of the API.

Returns:

the version of the API

description

public abstract Optional<String> description()

Returns the optional description of the API.

Returns:

the optional description of the API

termsOfService

public abstract Optional<String> termsOfService()

Returns the optional TOS of the API.

Returns:

the optional TOS of the API

contact

@Default
public Info.Contact contact()

Returns the contact information for the API.

Returns:

the contact information for the API