You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@groovy.apache.org by pa...@apache.org on 2016/03/02 20:26:30 UTC
[2/2] groovy git commit: More code examples in Javadoc for
TupleConstructor and ToString
More code examples in Javadoc for TupleConstructor and ToString
Based on discussion on the dev mailing list on how to include code example from the MrHaki Groovy Goodness blog series. Instead of external link the code samples from the blog posts are included in the Javadoc comments.
See also:
* http://groovy.329449.n5.nabble.com/Re-GitHub-groovy-pull-request-Link-to-MrHaki-s-blog-in-TupleConstructor-jav-tp5731382.html
Project: http://git-wip-us.apache.org/repos/asf/groovy/repo
Commit: http://git-wip-us.apache.org/repos/asf/groovy/commit/bb33d4c5
Tree: http://git-wip-us.apache.org/repos/asf/groovy/tree/bb33d4c5
Diff: http://git-wip-us.apache.org/repos/asf/groovy/diff/bb33d4c5
Branch: refs/heads/GROOVY_2_4_X
Commit: bb33d4c5624a1f4384ca40f26eb7e20ed689e0bb
Parents: 3452d29
Author: Hubert Klein Ikkink <h....@gmail.com>
Authored: Wed Mar 2 08:49:13 2016 +0100
Committer: pascalschumacher <pa...@gmx.net>
Committed: Wed Mar 2 20:26:17 2016 +0100
----------------------------------------------------------------------
src/main/groovy/transform/ToString.java | 143 +++++++++++++++++++
src/main/groovy/transform/TupleConstructor.java | 97 +++++++++++++
2 files changed, 240 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/groovy/blob/bb33d4c5/src/main/groovy/transform/ToString.java
----------------------------------------------------------------------
diff --git a/src/main/groovy/transform/ToString.java b/src/main/groovy/transform/ToString.java
index c5236af..2d33ff9 100644
--- a/src/main/groovy/transform/ToString.java
+++ b/src/main/groovy/transform/ToString.java
@@ -112,6 +112,149 @@ import java.lang.annotation.Target;
* <pre>
* my.company.NamedThing(name: Lassie)
* </pre>
+ * <p>More examples:</p>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // Most simple implementation of toString.
+ * import groovy.transform.ToString
+ *
+ * {@code @ToString}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ * }
+ *
+ * def person = new Person(name: 'mrhaki', likes: ['Groovy', 'Java'])
+ *
+ * assert person.toString() == 'Person(mrhaki, [Groovy, Java])'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // includeNames to output the names of the properties.
+ * import groovy.transform.ToString
+ *
+ * {@code @ToString(includeNames=true)}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ * }
+ *
+ * def person = new Person(name: 'mrhaki', likes: ['Groovy', 'Java'])
+ *
+ * assert person.toString() == 'Person(name:mrhaki, likes:[Groovy, Java])'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // includeFields to not only output properties, but also field values.
+ * import groovy.transform.ToString
+ *
+ * {@code @ToString(includeNames=true, includeFields=true)}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ * }
+ *
+ * def person = new Person(name: 'mrhaki', likes: ['Groovy', 'Java'])
+ *
+ * assert person.toString() == 'Person(name:mrhaki, likes:[Groovy, Java], active:false)'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // Use includeSuper to include properties from super class in output.
+ * import groovy.transform.ToString
+ *
+ * {@code @ToString(includeNames=true)}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ * }
+ *
+ * {@code @ToString(includeSuper=true, includeNames=true)}
+ * class Student extends Person {
+ * List courses
+ * }
+ *
+ * def student = new Student(name: 'mrhaki', likes: ['Groovy', 'Java'], courses: ['IT', 'Business'])
+ *
+ * assert student.toString() == 'Student(courses:[IT, Business], super:Person(name:mrhaki, likes:[Groovy, Java]))'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // excludes active field and likes property from output
+ * import groovy.transform.ToString
+ *
+ * {@code @ToString(includeNames=true, includeFields=true, excludes='active,likes')}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ * }
+ *
+ * def person = new Person(name: 'mrhaki', likes: ['Groovy', 'Java'])
+ *
+ * assert person.toString() == 'Person(name:mrhaki)'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // Don't include the package name in the output
+ * package com.mrhaki.blog.groovy
+ *
+ * import groovy.transform.*
+ *
+ * {@code @ToString(includePackage=false)}
+ * class Course {
+ * String title
+ * Integer maxAttendees
+ * }
+ *
+ * final Course course = new Course(title: 'Groovy 101', maxAttendees: 200)
+ *
+ * assert course.toString() == 'Course(Groovy 101, 200)'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // Don't use properties with null value.
+ * package com.mrhaki.blog.groovy
+ *
+ * import groovy.transform.*
+ *
+ * {@code @ToString(ignoreNulls=true)}
+ * class Course {
+ * String title
+ * Integer maxAttendees
+ * }
+ *
+ * final Course course = new Course(title: 'Groovy 101')
+ *
+ * assert course.toString() == 'com.mrhaki.blog.groovy.Course(Groovy 101)'
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // Cache toString() result.
+ * package com.mrhaki.blog.groovy
+ *
+ * import groovy.transform.*
+ *
+ * {@code @ToString(cache=true)}
+ * class Course {
+ * String title
+ * Integer maxAttendees
+ * }
+ *
+ * Course course = new Course(title: 'Groovy 101', maxAttendees: 200)
+ *
+ * assert course.toString() == 'com.mrhaki.blog.groovy.Course(Groovy 101, 200)'
+ *
+ * // Value change will not be reflected in toString().
+ * course.title = 'Grails with REST'
+ *
+ * assert course.toString() == 'com.mrhaki.blog.groovy.Course(Groovy 101, 200)'
+ * assert course.title == 'Grails with REST'
+ * </pre>
*
* @author Paul King
* @author Andre Steingress
http://git-wip-us.apache.org/repos/asf/groovy/blob/bb33d4c5/src/main/groovy/transform/TupleConstructor.java
----------------------------------------------------------------------
diff --git a/src/main/groovy/transform/TupleConstructor.java b/src/main/groovy/transform/TupleConstructor.java
index 949f77d..54cbdda 100644
--- a/src/main/groovy/transform/TupleConstructor.java
+++ b/src/main/groovy/transform/TupleConstructor.java
@@ -54,6 +54,103 @@ import java.lang.annotation.Target;
* (if {@code includeSuperProperties} is set) followed by the properties of the class followed
* by the fields of the class (if {@code includeFields} is set). Within each grouping the order
* is as attributes appear within the respective class.
+ * <p>More examples:</p>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * import groovy.transform.TupleConstructor
+ *
+ * {@code @TupleConstructor()}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ * }
+ *
+ * def person = new Person('mrhaki', ['Groovy', 'Java'])
+ *
+ * assert person.name == 'mrhaki'
+ * assert person.likes == ['Groovy', 'Java']
+ *
+ * person = new Person('mrhaki')
+ *
+ * assert person.name == 'mrhaki'
+ * assert !person.likes
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // includeFields in the constructor creation.
+ * import groovy.transform.TupleConstructor
+ *
+ * {@code @TupleConstructor(includeFields=true)}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ *
+ * boolean isActivated() { active }
+ * }
+ *
+ * def person = new Person('mrhaki', ['Groovy', 'Java'], true)
+ *
+ * assert person.name == 'mrhaki'
+ * assert person.likes == ['Groovy', 'Java']
+ * assert person.activated
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // use force attribute to force creation of constructor
+ * // even if we define our own constructors.
+ * import groovy.transform.TupleConstructor
+ *
+ * {@code @TupleConstructor(force=true)}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ *
+ * Person(boolean active) {
+ * this.active = active
+ * }
+ *
+ * boolean isActivated() { active }
+ * }
+ *
+ * def person = new Person('mrhaki', ['Groovy', 'Java'])
+ *
+ * assert person.name == 'mrhaki'
+ * assert person.likes == ['Groovy', 'Java']
+ * assert !person.activated
+ *
+ * person = new Person(true)
+ *
+ * assert person.activated
+ * </pre>
+ * <pre>
+ * //--------------------------------------------------------------------------
+ * // include properties and fields from super class.
+ * import groovy.transform.TupleConstructor
+ *
+ * {@code @TupleConstructor(includeFields=true)}
+ * class Person {
+ * String name
+ * List likes
+ * private boolean active = false
+ *
+ * boolean isActivated() { active }
+ * }
+ *
+ * {@code @TupleConstructor(callSuper=true, includeSuperProperties=true, includeSuperFields=true)}
+ * class Student extends Person {
+ * List courses
+ * }
+ *
+ * def student = new Student('mrhaki', ['Groovy', 'Java'], true, ['IT'])
+ *
+ * assert student.name == 'mrhaki'
+ * assert student.likes == ['Groovy', 'Java']
+ * assert student.activated
+ * assert student.courses == ['IT']
+ * </pre>
* <p>
* Limitations:
* <ul>