io.sphere.sdk.annotations

Annotation Type ResourceDraftValue

public @interface ResourceDraftValue

This annotation marks an interface as resource draft representation.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
FactoryMethod[]	factoryMethods

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	abstractBuilderClass If set to true, the generated builder class will be abstract so that it can be further customized.
boolean	abstractResourceDraftValueClass If set to true, the generated resource value class will be abstract so that it can be further customized.
String[]	additionalBuilderInterfaces Allows to specify additional interfaces that the generated builder should implement.
boolean	builderReturnsDslClass If set to true, the builder will return the concrete implementation.
CopyFactoryMethod[]	copyFactoryMethods

Element Detail

factoryMethods

public abstract FactoryMethod[] factoryMethods

copyFactoryMethods

public abstract CopyFactoryMethod[] copyFactoryMethods

Default:

{}

builderReturnsDslClass

public abstract boolean builderReturnsDslClass

If set to true, the builder will return the concrete implementation. We switched the default to true because our previous generator always returned a concrete type, although the builder type argument T was set to to the draft interface.

Returns:

true iff. the generated build method should the concrete implementation type.

Default:

true

additionalBuilderInterfaces

public abstract String[] additionalBuilderInterfaces

Allows to specify additional interfaces that the generated builder should implement.

Returns:

list of fully qualified additional builder interface names

Default:

{}

abstractBuilderClass

public abstract boolean abstractBuilderClass

If set to true, the generated builder class will be abstract so that it can be further customized.

Returns:

true iff. the generated builder should be abstract

Default:

false

abstractResourceDraftValueClass

public abstract boolean abstractResourceDraftValueClass

If set to true, the generated resource value class will be abstract so that it can be further customized.

Returns:

true iff. the generated class should be abstract

Default:

false