Skip to content

Commit 5df3858

Browse files
johncarl81johncarl81
committed
Added comments relating to Parceler usage
1 parent 34204c2 commit 5df3858

7 files changed

Lines changed: 40 additions & 2 deletions

File tree

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/Extra.java‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@
2424
* <p>
2525
* Use on any native, {@link android.os.Parcelable Parcelable} or
2626
* {@link java.io.Serializable Serializable} field in an {@link EActivity}
27-
* annotated class to bind it with Android's extra.
27+
* annotated class to bind it with Android's arguments.
28+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
29+
* annotated with &#064;Parcel, or collections supported by Parceler will be
30+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
31+
* through the Parcels utility class.
2832
* </p>
2933
* <p>
3034
* The annotation value is the key used for extra. If not set, the field name
@@ -43,7 +47,7 @@
4347
* Activity#setIntent(Intent)} will automatically update the annotated extras.
4448
* </p>
4549
* <blockquote>
46-
*
50+
*
4751
* Example :
4852
*
4953
* <pre>

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/FragmentArg.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
* Use on any native, {@link android.os.Parcelable Parcelable} or
2626
* {@link java.io.Serializable Serializable} field in an {@link EFragment}
2727
* annotated class to bind it with Android's arguments.
28+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
29+
* annotated with &#064;Parcel, or collections supported by Parceler will be
30+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
31+
* through the Parcels utility class.
2832
* </p>
2933
* <p>
3034
* The annotation value is the key used for argument. If not set, the field name

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/InstanceState.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@
2525
* Use on activity fields to save and restore their values when the system calls
2626
* <code>onSaveInstanceState(Bundle)</code> and <code>onCreate(Bundle)</code>.
2727
* </p>
28+
* <p>
29+
* Use on any native, {@link android.os.Parcelable Parcelable} or
30+
* {@link java.io.Serializable Serializable} field in an {@link EActivity}
31+
* annotated class to bind it with Android's arguments.
32+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
33+
* annotated with &#064;Parcel, or collections supported by Parceler will be
34+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
35+
* through the Parcels utility class.
36+
* </p>
2837
*
2938
* <blockquote>
3039
*

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/OnActivityResult.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,10 @@
9090
* Use on any native, {@link android.os.Parcelable} or
9191
* {@link java.io.Serializable} parameter of an {@link OnActivityResult}
9292
* annotated method to bind it with the value from the Intent.
93+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
94+
* annotated with &#064;Parcel, or collections supported by Parceler will be
95+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
96+
* through the Parcels utility class.
9397
* </p>
9498
* <p>
9599
* The annotation value is the key used for the result data. If not set, the

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/Receiver.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,10 @@ enum RegisterAt {
155155
* {@code void onReceive(Context context, Intent intent)}. The key of this
156156
* extra is the value of the annotation {@link ReceiverAction.Extra} if it
157157
* is set or the name of the parameter.
158+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
159+
* annotated with &#064;Parcel, or collections supported by Parceler will be
160+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
161+
* through the Parcels utility class.
158162
* </p>
159163
*/
160164
@Retention(RetentionPolicy.CLASS)

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/ReceiverAction.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,10 @@
115115
* {@code void onReceive(Context context, Intent intent)}. The key of this
116116
* extra is the value of the annotation {@link ReceiverAction.Extra} if it
117117
* is set or the name of the parameter.
118+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
119+
* annotated with &#064;Parcel, or collections supported by Parceler will be
120+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
121+
* through the Parcels utility class.
118122
* </p>
119123
*/
120124
@Retention(RetentionPolicy.CLASS)

‎AndroidAnnotations/androidannotations-core/androidannotations-api/src/main/java/org/androidannotations/annotations/ServiceAction.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,15 @@
8484
* AbstractIntentService} class, which implements that method, so you do not
8585
* have to do in your actual class if you derive it.
8686
* </p>
87+
* <p>
88+
* Use on any native, {@link android.os.Parcelable Parcelable} or
89+
* {@link java.io.Serializable Serializable} field in an {@link EService}
90+
* annotated class to bind it with Android's arguments.
91+
* If <a href="http://parceler.org">Parceler</a> is on the classpath, extras
92+
* annotated with &#064;Parcel, or collections supported by Parceler will be
93+
* automatically marshaled using a {@link android.os.Parcelable Parcelable}
94+
* through the Parcels utility class.
95+
* </p>
8796
*
8897
* @see EIntentService
8998
* @see org.androidannotations.api.support.app.AbstractIntentService

0 commit comments

Comments
 (0)