xapi.annotation.gc

Annotation Type OnGC

@Documented
@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface OnGC

Using the OnGC annotation in collaboration with X_GC allows objects to cleanly automate the job of cleaning up their children. Current support only includes calling an ordered list of onDestroy methods. Use the instanceGCMethods() to define the order in which you want the zero-arg methods called. Runtime gc will use some reflection, as efficiently as possible, to allow any object to properly destroy another object without actually knowing anything at all about it's type.

Author:

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	chainDeleteFields
boolean	deleteInstanceFields
String[]	instanceGCMethods The ordered list of zero-arg gc methods you would like to call, in the order you would like them called.
String[]	staticGCMethods An ordered list of one-arg static methods you want to be executed.

Element Detail

instanceGCMethods

public abstract String[] instanceGCMethods

The ordered list of zero-arg gc methods you would like to call, in the order you would like them called. These must be instance object on the thing you want to destroy.

Returns:

Default:

{}

staticGCMethods

public abstract String[] staticGCMethods

An ordered list of one-arg static methods you want to be executed. Proper syntax is: com.project.Clazz$InnerStatic#methodToCall

Returns:

- A list of one-arg static destruction methods to call. That one arg MUST be java.lang.Object; if you need a typed method, make two. That's what many jvms do anyway ;) Google: java bridge methods

Default:

{}

deleteInstanceFields

public abstract boolean deleteInstanceFields

Returns:

Whether or not to use reflection to destroy instance fields. Default of true causes all object references to get set to null.

Default:

true

chainDeleteFields

public abstract boolean chainDeleteFields

Returns:

true to check objects in GC'd instance fields for OnGC, and destroy them as well. Default is false for runtime perfomance. Only turn this on if you want to form a destruction chain of objects, and are too lazy to manually call X_GC#destroy() on all your fields. Note that gwt support for chained destroy is not currently functional.

Default:

false