Package org.forgerock.api.models

Class ApiDescription.Builder

java.lang.Object

org.forgerock.api.models.ApiDescription.Builder

Enclosing class:

ApiDescription

public static final class ApiDescription.Builder
extends Object

Builder for the ApiDescription.

Method Summary

Modifier and Type	Method	Description
ApiDescription	build()	Builds the ApiDescription instance.
ApiDescription.Builder	definitions(Definitions definitions)	Set the definitions.
ApiDescription.Builder	description(String description)	Sets the description.
ApiDescription.Builder	description(LocalizableString description)	Sets the description.
ApiDescription.Builder	errors(Errors errors)	Set the errors.
ApiDescription.Builder	id(String id)	Set the id.
ApiDescription.Builder	paths(Paths paths)	Set the paths.
ApiDescription.Builder	services(Services services)	Set the services.
ApiDescription.Builder	version(String version)	Set the version of the API.

Methods inherited from class java.lang.Object

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

Method Details

id

public ApiDescription.Builder id(String id)

Set the id.

Parameters:

id - ApiDescription id

Returns:

Builder

description

public ApiDescription.Builder description(String description)

Sets the description.

Parameters:

description - Description of API Description

Returns:

Builder

description

public ApiDescription.Builder description(LocalizableString description)

Sets the description.

Parameters:

description - Description of API Description

Returns:

Builder

definitions

public ApiDescription.Builder definitions(Definitions definitions)

Set the definitions.

Parameters:

definitions - Definitions for this API Description

Returns:

Builder

services

public ApiDescription.Builder services(Services services)

Set the services.

Parameters:

services - Services for this API Description

Returns:

Builder

errors

public ApiDescription.Builder errors(Errors errors)

Set the errors.

Parameters:

errors - Errors for this API Description

Returns:

Builder

paths

public ApiDescription.Builder paths(Paths paths)

Set the paths.

Parameters:

paths - Paths

Returns:

Builder

version

public ApiDescription.Builder version(String version)

Set the version of the API.

Parameters:

version - The version.

Returns:

This builder.

build

public ApiDescription build()

Builds the ApiDescription instance.

Returns:

ApiDescription instance