xapi.annotation.reflect

Annotation Type KeepAnnotation

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

Annotation used to tell reflection subsystem to hold onto annotation data. This annotation can be supplied almost anywhere to explicitly include a particular set of annotations in the ReflectionService.

Can be applied to packages, classes, annotation types, parameters, methods, fields and constructors. The ReflectionService will do its best to retain manual annotation retention overrides.

Primarily used in gwt reflection, but available as well for future iterations of classpath scanner to intelligently discard runtime metadata.

Author:

"James X. Nelson (james@wetheinter.net)"

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	debugData DebugData to include.
boolean	loadAsync Whether or not to defer including reflected constructor into a code split containing all reflection data.
boolean	preventOverride Used to allow package-level or type-level annotations to override children.

Element Detail

debugData

public abstract String debugData

DebugData to include.

Returns:

"" (default) = no debug data / production mode "anything" = keep this string, and print extra debug logging.

Using debugData.length > 0 will result in as much type data being preserved as possible in log messages, including method default class types.

Default:

""

loadAsync

public abstract boolean loadAsync

Whether or not to defer including reflected constructor into a code split containing all reflection data.

Implementations using xapi-gwt-inject won't need to worry as much, the magic-method-injector will ensure code bloat is localized to call site.

Running without injection support will put all class data into a single, monolithic, generated factory for the whole app, unless async is used.

Returns:

true to force this code into async split. false (default) to load synchronously; no boilerplate.

if true, Generator will throw exception if accessed outside of X_Reflect.async()

Default:

false

preventOverride

public abstract boolean preventOverride

Used to allow package-level or type-level annotations to override children.

Good for overriding default settings temporarily; setting debugData and preventOverride on package-info.java will turn on debugging for that package.

Returns:

true, to prevent checking for more specific child types.

Inheritance Hierarchy Is -> package-info.java -> OuterClass -> OuterClass$InnerClass -> ...

Default:

false