org.onehippo.cms7.essentials.dashboard.annotations

Annotation Type HippoEssentialsGenerated

@Documented
 @Retention(value=RUNTIME)
 @Target(value={PACKAGE,TYPE,ANNOTATION_TYPE,METHOD,CONSTRUCTOR,FIELD,LOCAL_VARIABLE,PARAMETER})
public @interface HippoEssentialsGenerated

Used to mark source code that has been generated by Essentials' BeanWriter tool. This annotation lives in this odd place/package in order to preserve backwards compatibility. The annotation used to live in the Essentials project, but that fact caused the archetype to have the site webapp depend on /pull in the Essentials plugin SDK API, which was even more ugly.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	allowModifications Indicates if generated code may be modified by Essentials' BeanWriter tool.
String	internalName Name used by Essentials' BeanWriter tool.

Element Detail

internalName

public abstract String internalName

Name used by Essentials' BeanWriter tool. User can safely rename generated property (e.g. class name, method name), HippoEssentials framework will check internal name before generating mentioned property

Returns:

internal name of generated code

Default:

""

allowModifications

public abstract boolean allowModifications

Indicates if generated code may be modified by Essentials' BeanWriter tool.

Returns:

true by default

Default:

true