|
Groovy 2.0.0-rc-3 | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
java.lang.Objectgroovy.transform.ToString
@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) @GroovyASTTransformationClass("org.codehaus.groovy.transform.ToStringASTTransformation") public @interface ToString
Class annotation used to assist in the creation of toString() methods in classes. The @ToString annotation instructs the compiler to execute an AST transformation which adds the necessary toString() method.
It allows you to write classes in this shortened form:@ToString class Customer { String first, last int age Date since = new Date() Collection favItems private answer = 42 } println new Customer(first:'Tom', last:'Jones', age:21, favItems:['Books', 'Games'])Which will have this output:
Customer(Tom, Jones, 21, Wed Jul 14 23:57:14 EST 2010, [Books, Games])There are numerous options to customize the format of the generated output. E.g. if you change the first annotation to:
@ToString(includeNames=true)Then the output will be:
Customer(first:Tom, last:Jones, age:21, since:Wed Jul 14 23:57:50 EST 2010, favItems:[Books, Games])Or if you change the first annotation to:
@ToString(includeNames=true,includeFields=true,excludes="since,favItems")Then the output will be:
Customer(first:Tom, last:Jones, age:21, answer:42)If you have this example:
import groovy.transform.ToString @ToString class NamedThing { String name } @ToString(includeNames=true,includeSuper=true) class AgedThing extends NamedThing { int age } println new AgedThing(name:'Lassie', age:5)Then the output will be:
AgedThing(age:5, super:NamedThing(Lassie))@ToString can also be used in conjunction with @Canonical and @Immutable. If you want to omit fields or properties referring to null, you can use the ignoreNulls flag:
import groovy.transform.ToString @ToString(ignoreNulls = true) class NamedThing { String name } println new NamedThing(name: null)Which results in:
NamedThing()
Optional Element Summary | |
---|---|
String[] |
excludes
List of field and/or property names to exclude from generated toString. |
boolean |
ignoreNulls
Don't display any fields or properties with value null. |
boolean |
includeFields
Include fields as well as properties in generated toString. |
boolean |
includeNames
Whether to include names of properties/fields in generated toString. |
boolean |
includeSuper
Whether to include super in generated toString. |
String[] |
includes
List of field and/or property names to include within the generated toString. |
Method Summary |
---|
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Element Detail |
---|
public String[] excludes
public boolean ignoreNulls
public boolean includeFields
public boolean includeNames
public boolean includeSuper
public String[] includes
Copyright © 2003-2012 The Codehaus. All rights reserved.