io.sundr.builder.annotations

Annotation Type Pojo

@Target(value={CONSTRUCTOR,TYPE})
 @Retention(value=SOURCE)
public @interface Pojo

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Adapter[]	adapter Adapter configuration
java.lang.Class[]	interfaces An array of interface to add to the Pojo.
boolean	mutable Indicates that the generated pojo will be mutable or not.
java.lang.String	name The class name of the generated Pojo.
java.lang.String	prefix The prefix to add to the annotated class in order to create the pojo name.
java.lang.String	relativePath The relative path the pojo will be generated.
java.lang.String	suffix The suffix to add to the annotated class in order to create the pojo name.
java.lang.Class	superClass The super class to add to the generated pojo.
boolean	withStaticAdapterMethod Flag to include static mapping methods in the generated pojo.
boolean	withStaticBuilderMethod Flag to include static builder method in the generated pojo.
boolean	withStaticMapAdapterMethod Flag to incluce mapping methods from map instances.

Element Detail

mutable

public abstract boolean mutable

Indicates that the generated pojo will be mutable or not. If not mutable all properties will be final and no default constructor will be provided.

Returns:

true if mutable, false otherwise.t

Default:

false

name

public abstract java.lang.String name

The class name of the generated Pojo.

Returns:

The class name, or empty (default) if the name is to be the implicitly specified.

Default:

""

prefix

public abstract java.lang.String prefix

The prefix to add to the annotated class in order to create the pojo name.

Returns:

The prefix.

Default:

""

suffix

public abstract java.lang.String suffix

The suffix to add to the annotated class in order to create the pojo name.

Returns:

The suffix.

Default:

""

relativePath

public abstract java.lang.String relativePath

The relative path the pojo will be generated.

Returns:

The relative path.

Default:

""

superClass

public abstract java.lang.Class superClass

The super class to add to the generated pojo.

Returns:

the super class.

Default:

java.lang.Object.class

interfaces

public abstract java.lang.Class[] interfaces

An array of interface to add to the Pojo.

Returns:

The interface array.

Default:

{}

withStaticBuilderMethod

public abstract boolean withStaticBuilderMethod

Flag to include static builder method in the generated pojo.

Returns:

True, if static builder should be included false, otherwise.

Default:

true

withStaticAdapterMethod

public abstract boolean withStaticAdapterMethod

Flag to include static mapping methods in the generated pojo. The adapter just maps the source interface/annotation to the generated pojo.

Returns:

True, if static adapter should be included false, otherwise.

Default:

true

withStaticMapAdapterMethod

public abstract boolean withStaticMapAdapterMethod

Flag to incluce mapping methods from map instances.

Returns:

True, if static adapter should be included, false, otherwise.

Default:

false

adapter

public abstract Adapter[] adapter

Adapter configuration

Returns:

The adapter configuration.

Default:

{}