Package com.cosium.openapi.annotation_processor.specification

Class SpecificationGeneratorOptions.Builder

java.lang.Object

com.cosium.openapi.annotation_processor.specification.SpecificationGeneratorOptions.Builder

All Implemented Interfaces:

SpecificationGeneratorOptions.BasePathBuildStage, SpecificationGeneratorOptions.BuildFinal, SpecificationGeneratorOptions.TitleBuildStage

Enclosing class:

SpecificationGeneratorOptions

@NotThreadSafe
public static final class SpecificationGeneratorOptions.Builder
extends Object
implements SpecificationGeneratorOptions.TitleBuildStage, SpecificationGeneratorOptions.BasePathBuildStage, SpecificationGeneratorOptions.BuildFinal

Builds instances of type SpecificationGeneratorOptions. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
SpecificationGeneratorOptions.Builder	addAllConsumes(Iterable<String> elements)	Adds elements to consumes list.
SpecificationGeneratorOptions.Builder	addAllProduces(Iterable<String> elements)	Adds elements to produces list.
SpecificationGeneratorOptions.Builder	addConsumes(String element)	Adds one element to consumes list.
SpecificationGeneratorOptions.Builder	addConsumes(String... elements)	Adds elements to consumes list.
SpecificationGeneratorOptions.Builder	addProduces(String element)	Adds one element to produces list.
SpecificationGeneratorOptions.Builder	addProduces(String... elements)	Adds elements to produces list.
SpecificationGeneratorOptions.Builder	basePath(String basePath)	Initializes the value for the basePath attribute.
SpecificationGeneratorOptions	build()	Builds a new SpecificationGeneratorOptions.
SpecificationGeneratorOptions.Builder	title(String title)	Initializes the value for the title attribute.

Methods inherited from class java.lang.Object

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

Method Detail

title

public final SpecificationGeneratorOptions.Builder title(String title)

Initializes the value for the title attribute.

Specified by:

title in interface SpecificationGeneratorOptions.TitleBuildStage

Parameters:

title - The value for title

Returns:

this builder for use in a chained invocation

basePath

public final SpecificationGeneratorOptions.Builder basePath(String basePath)

Initializes the value for the basePath attribute.

Specified by:

basePath in interface SpecificationGeneratorOptions.BasePathBuildStage

Parameters:

basePath - The value for basePath

Returns:

this builder for use in a chained invocation

addProduces

public final SpecificationGeneratorOptions.Builder addProduces(String element)

Adds one element to produces list.

Specified by:

addProduces in interface SpecificationGeneratorOptions.BuildFinal

Parameters:

element - A produces element

Returns:

this builder for use in a chained invocation

addProduces

public final SpecificationGeneratorOptions.Builder addProduces(String... elements)

Adds elements to produces list.

Specified by:

addProduces in interface SpecificationGeneratorOptions.BuildFinal

Parameters:

elements - An array of produces elements

Returns:

this builder for use in a chained invocation

addAllProduces

public final SpecificationGeneratorOptions.Builder addAllProduces(Iterable<String> elements)

Adds elements to produces list.

Specified by:

addAllProduces in interface SpecificationGeneratorOptions.BuildFinal

Parameters:

elements - An iterable of produces elements

Returns:

this builder for use in a chained invocation

addConsumes

public final SpecificationGeneratorOptions.Builder addConsumes(String element)

Adds one element to consumes list.

Specified by:

addConsumes in interface SpecificationGeneratorOptions.BuildFinal

Parameters:

element - A consumes element

Returns:

this builder for use in a chained invocation

addConsumes

public final SpecificationGeneratorOptions.Builder addConsumes(String... elements)

Adds elements to consumes list.

Specified by:

addConsumes in interface SpecificationGeneratorOptions.BuildFinal

Parameters:

elements - An array of consumes elements

Returns:

this builder for use in a chained invocation

addAllConsumes

public final SpecificationGeneratorOptions.Builder addAllConsumes(Iterable<String> elements)

Adds elements to consumes list.

Specified by:

addAllConsumes in interface SpecificationGeneratorOptions.BuildFinal

Parameters:

elements - An iterable of consumes elements

Returns:

this builder for use in a chained invocation

build

public SpecificationGeneratorOptions build()

Builds a new SpecificationGeneratorOptions.

Specified by:

build in interface SpecificationGeneratorOptions.BuildFinal

Returns:

An immutable instance of SpecificationGeneratorOptions

Throws:

IllegalStateException - if any required attributes are missing