io.sphere.sdk.annotations

Annotation Type HasUpdateAction

@Repeatable(value=HasCustomUpdateActions.class)
 @Target(value=METHOD)
 @Retention(value=CLASS)
public @interface HasUpdateAction

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	className
CopyFactoryMethod[]	copyFactoryMethods
String	exampleBaseClass This adds a {code @include.example exampleBaseClass#updateActionTestName()} javadoc tag to all generated update actions.
FactoryMethod[]	factoryMethods
PropertySpec[]	fields
boolean	generateDefaultFactory Specifies whether there should be a default factory method generated.
boolean	makeAbstract
Class[]	superInterfaces
String	value Used to specify the action name

Element Detail

value

public abstract String value

Used to specify the action name

Returns:

the action name

Default:

""

className

public abstract String className

Default:

""

fields

public abstract PropertySpec[] fields

Default:

{}

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:

""

factoryMethods

public abstract FactoryMethod[] factoryMethods

Default:

{}

copyFactoryMethods

public abstract CopyFactoryMethod[] copyFactoryMethods

Default:

{}

superInterfaces

public abstract Class[] superInterfaces

Default:

{}

makeAbstract

public abstract boolean makeAbstract

Default:

false

generateDefaultFactory

public abstract boolean generateDefaultFactory

Specifies whether there should be a default factory method generated. a default factory method accepts all required parameters as argument.

Returns:

true if you need to generate a default factory, false otherwise.

Default:

true