Package com.cosium.openapi.annotation_processor.option

Class Options

java.lang.Object

com.cosium.openapi.annotation_processor.option.Options

All Implemented Interfaces:

IOptions

@ParametersAreNonnullByDefault
@Immutable
public final class Options
extends Object
implements IOptions

Created on 12/07/17.

Author:

Reda.Housni-Alaoui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Options.BaseGenerationPackageBuildStage
static class	Options.Builder	Builds instances of type Options.
static interface	Options.BuildFinal
static interface	Options.CodeGeneratorBuildStage
static interface	Options.SpecificationGeneratorBuildStage

Method Summary

Modifier and Type	Method	Description
String	baseGenerationPackage()
static Options.BaseGenerationPackageBuildStage	builder()	Creates a builder for Options.
ICodeGeneratorOptions	codeGenerator()
static Options	copyOf(IOptions instance)	Creates an immutable copy of a IOptions value.
boolean	equals(Object another)	This instance is equal to all instances of Options that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: baseGenerationPackage, specificationGenerator, codeGenerator.
ISpecificationGeneratorOptions	specificationGenerator()
String	toString()	Prints the immutable value Options with attribute values.
Options	withBaseGenerationPackage(String value)	Copy the current immutable object by setting a value for the baseGenerationPackage attribute.
Options	withCodeGenerator(ICodeGeneratorOptions value)	Copy the current immutable object by setting a value for the codeGenerator attribute.
Options	withSpecificationGenerator(ISpecificationGeneratorOptions value)	Copy the current immutable object by setting a value for the specificationGenerator attribute.

Methods inherited from class java.lang.Object

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

Method Detail

baseGenerationPackage

public String baseGenerationPackage()

Specified by:

baseGenerationPackage in interface IOptions

Returns:

The base package that will be used to generate all resources

specificationGenerator

public ISpecificationGeneratorOptions specificationGenerator()

Specified by:

specificationGenerator in interface IOptions

Returns:

The specification generator options

codeGenerator

public ICodeGeneratorOptions codeGenerator()

Specified by:

codeGenerator in interface IOptions

Returns:

The code generator options

withBaseGenerationPackage

public final Options withBaseGenerationPackage(String value)

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

Parameters:

value - A new value for baseGenerationPackage

Returns:

A modified copy of the this object

withSpecificationGenerator

public final Options withSpecificationGenerator(ISpecificationGeneratorOptions value)

Copy the current immutable object by setting a value for the specificationGenerator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for specificationGenerator

Returns:

A modified copy of the this object

withCodeGenerator

public final Options withCodeGenerator(ICodeGeneratorOptions value)

Copy the current immutable object by setting a value for the codeGenerator attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for codeGenerator

Returns:

A modified copy of the this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of Options 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: baseGenerationPackage, specificationGenerator, codeGenerator.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Options with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static Options copyOf(IOptions instance)

Creates an immutable copy of a IOptions 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 Options instance

builder

public static Options.BaseGenerationPackageBuildStage builder()

Creates a builder for Options.

Returns:

A new Options builder