Package groovy.transform
Annotation Type AutoExternalize
Note: This annotation is currently experimental! Use at your own risk!
Class annotation used to assist in the creation of
Externalizable
classes.
The @AutoExternalize
annotation instructs the compiler to execute an
AST transformation which adds writeExternal()
and readExternal()
methods
to a class and adds Externalizable
to the interfaces which the class implements.
The writeExternal()
method writes each property (or field) for the class while the
readExternal()
method will read each one back in the same order. Properties or fields
marked as transient
are ignored.
Example usage:
import groovy.transform.*
@AutoExternalize
class Person {
String first, last
List favItems
Date since
}
Which will create a class of the following form:
class Person implements Externalizable { ... public void writeExternal(ObjectOutput out) throws IOException { out.writeObject(first) out.writeObject(last) out.writeObject(favItems) out.writeObject(since) } public void readExternal(ObjectInput oin) { first = oin.readObject() last = oin.readObject() favItems = oin.readObject() since = oin.readObject() } ... }
- Since:
- 1.8.0
- Author:
- Paul King
-
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionComma separated list of property names to exclude from externalizingboolean
Include fields as well as properties when externalizing
-
Element Details
-
excludes
String excludesComma separated list of property names to exclude from externalizing- Default:
- ""
-
includeFields
boolean includeFieldsInclude fields as well as properties when externalizing- Default:
- false
-