io.sphere.sdk.annotations

Annotation Type HasUpdateActions

public @interface HasUpdateActions

This annotation is used to generate update actions for a resource - only for its primitive types.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	deriveExampleBaseClass This allows to disable the generation of the {code @include.example exampleBaseClass#updateActionTestName()} javadoc tag within the update actions.
String	exampleBaseClass This adds a {code @include.example exampleBaseClass#updateActionTestName()} javadoc tag to all generated update actions.

Element Detail

exampleBaseClass

public abstract String exampleBaseClass

This adds a {code @include.example exampleBaseClass#updateActionTestName()} javadoc tag to all generated update actions. Where <i>updateActionTestName</i> is derived by un-capitalizing the update action name (e.g. for a SetKey update action the updateActionTestName is setKey. This follows our convention to have integration tests for all of our update actions.

Returns:

the example base class name

Default:

""

deriveExampleBaseClass

public abstract boolean deriveExampleBaseClass

This allows to disable the generation of the {code @include.example exampleBaseClass#updateActionTestName()} javadoc tag within the update actions.

Returns:

the example javadoc tag generation preference. If false, the tag is not created. By default it is true and the tag is created

Default:

true