com.chemaxon.apidiscovery.linenote

Interface LinenoteBuilder<T>

public interface LinenoteBuilder<T>

Builder for line note representation factory. To obtain an instance use Linenotes.builder().

Method Summary

Modifier and Type	Method and Description
<D> LinenoteBuilder<T>	addDtoChoice(String label, String description, Supplier<D> dtoSupplier, Function<D,T> factory) Add a choice for a single parametrization.
<E extends Enum<E>> LinenoteBuilder<T>	addEnumChoice(Class<E> p, Function<E,T> factory) Add a choice for each enum instances.
<D> LinenoteBuilder<T>	addMultiDtoChoices(String label, List<String> descriptions, List<Supplier<D>> dtoSuppliers, Function<D,T> factory) Add multiple choices with multiple parameterizations.
LinenoteBuilder<T>	addSimpleChoice(String label, String description, Supplier<T> factory) Add a no-parameter choice.
Linenote<T>	build() Create factory.

Method Detail

addSimpleChoice

LinenoteBuilder<T> addSimpleChoice(String label,
                                   String description,
                                   Supplier<T> factory)

Add a no-parameter choice.

Parameters:

label - Choice label

description - Choice description

factory - Factory to instantiate the represented choice

Returns:

Reference to this builder

addEnumChoice

<E extends Enum<E>> LinenoteBuilder<T> addEnumChoice(Class<E> p,
                                                     Function<E,T> factory)

Add a choice for each enum instances. The pased enum type must contain Description annotation on its types.

Type Parameters:

E - Enum type

Parameters:

p - Enum type

factory - Factory function to instantiate the represented choice

Returns:

Reference to this builder

Throws:

IllegalArgumentException - when Description annotations are missing on the passed enum.

addDtoChoice

<D> LinenoteBuilder<T> addDtoChoice(String label,
                                    String description,
                                    Supplier<D> dtoSupplier,
                                    Function<D,T> factory)

Add a choice for a single parametrization. The passed parameter object must satisfy api discovery requirements detailed at Discovery.listParameters(java.lang.Object):

• The class must be annotated with annotation Parametrized

Fields must be annotated with Description and Parameter annotations. Appropriate setter methods must be present for fields. Note that currently only int, long, double, enum, string and boolean types are supported.

Type Parameters:

D - Parameter object type

Parameters:

label - Choice label

description - Choice description

dtoSupplier - Parameter object supplier

factory - Factory to instantiate based on the Dto state

Returns:

Reference to this builder

addMultiDtoChoices

<D> LinenoteBuilder<T> addMultiDtoChoices(String label,
                                          List<String> descriptions,
                                          List<Supplier<D>> dtoSuppliers,
                                          Function<D,T> factory)

Add multiple choices with multiple parameterizations. Note that all parameters are required parameters

Type Parameters:

D - Parameter object type

Parameters:

label - Choice label

descriptions - Descriptions for various parameterizations

dtoSuppliers - Parameterizations

factory - Factory to instantiate based on parsed Dto

Returns:

Reference to this builder

build

Linenote<T> build()

Create factory.

Returns:

factory representing the builders current state