Package com.cosium.openapi.annotation_processor.specification

Class SpecificationGeneratorOptions

java.lang.Object

com.cosium.openapi.annotation_processor.specification.SpecificationGeneratorOptions

All Implemented Interfaces:

ISpecificationGeneratorOptions

@ParametersAreNonnullByDefault
@Immutable
public final class SpecificationGeneratorOptions
extends Object
implements ISpecificationGeneratorOptions

Created on 12/07/17.

Author:

Reda.Housni-Alaoui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SpecificationGeneratorOptions.BasePathBuildStage
static class	SpecificationGeneratorOptions.Builder	Builds instances of type SpecificationGeneratorOptions.
static interface	SpecificationGeneratorOptions.BuildFinal
static interface	SpecificationGeneratorOptions.TitleBuildStage

Method Summary

Modifier and Type	Method	Description
String	basePath()
static SpecificationGeneratorOptions.TitleBuildStage	builder()	Creates a builder for SpecificationGeneratorOptions.
com.google.common.collect.ImmutableList<String>	consumes()
static SpecificationGeneratorOptions	copyOf(ISpecificationGeneratorOptions instance)	Creates an immutable copy of a ISpecificationGeneratorOptions value.
boolean	equals(Object another)	This instance is equal to all instances of SpecificationGeneratorOptions that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: title, basePath, produces, consumes.
com.google.common.collect.ImmutableList<String>	produces()
String	title()
String	toString()	Prints the immutable value SpecificationGeneratorOptions with attribute values.
SpecificationGeneratorOptions	withBasePath(String value)	Copy the current immutable object by setting a value for the basePath attribute.
SpecificationGeneratorOptions	withConsumes(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of consumes.
SpecificationGeneratorOptions	withConsumes(String... elements)	Copy the current immutable object with elements that replace the content of consumes.
SpecificationGeneratorOptions	withProduces(Iterable<String> elements)	Copy the current immutable object with elements that replace the content of produces.
SpecificationGeneratorOptions	withProduces(String... elements)	Copy the current immutable object with elements that replace the content of produces.
SpecificationGeneratorOptions	withTitle(String value)	Copy the current immutable object by setting a value for the title attribute.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

title

public String title()

Specified by:

title in interface ISpecificationGeneratorOptions

Returns:

The title of the specification

basePath

public String basePath()

Specified by:

basePath in interface ISpecificationGeneratorOptions

Returns:

The specification base path

produces

public com.google.common.collect.ImmutableList<String> produces()

Specified by:

produces in interface ISpecificationGeneratorOptions

Returns:

The produced global mime types

consumes

public com.google.common.collect.ImmutableList<String> consumes()

Specified by:

consumes in interface ISpecificationGeneratorOptions

Returns:

The consumes global mime types

withTitle

public final SpecificationGeneratorOptions withTitle(String value)

Copy the current immutable object by setting a value for the title attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for title

Returns:

A modified copy of the this object

withBasePath

public final SpecificationGeneratorOptions withBasePath(String value)

Copy the current immutable object by setting a value for the basePath attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for basePath

Returns:

A modified copy of the this object

withProduces

public final SpecificationGeneratorOptions withProduces(String... elements)

Copy the current immutable object with elements that replace the content of produces.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withProduces

public final SpecificationGeneratorOptions withProduces(Iterable<String> elements)

Copy the current immutable object with elements that replace the content of produces. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of produces elements to set

Returns:

A modified copy of this object

withConsumes

public final SpecificationGeneratorOptions withConsumes(String... elements)

Copy the current immutable object with elements that replace the content of consumes.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withConsumes

public final SpecificationGeneratorOptions withConsumes(Iterable<String> elements)

Copy the current immutable object with elements that replace the content of consumes. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of consumes elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of SpecificationGeneratorOptions that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: title, basePath, produces, consumes.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SpecificationGeneratorOptions with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static SpecificationGeneratorOptions copyOf(ISpecificationGeneratorOptions instance)

Creates an immutable copy of a ISpecificationGeneratorOptions value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable SpecificationGeneratorOptions instance

builder

public static SpecificationGeneratorOptions.TitleBuildStage builder()

Creates a builder for SpecificationGeneratorOptions.

Returns:

A new SpecificationGeneratorOptions builder