harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tim Ellison (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HARMONY-6183) Javadocs for java.util.prefs.*
Date Mon, 27 Apr 2009 19:33:30 GMT

    [ https://issues.apache.org/jira/browse/HARMONY-6183?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12703311#action_12703311
] 

Tim Ellison commented on HARMONY-6183:
--------------------------------------

Note that this correction is in fact untrue:

Index: modules/prefs/src/main/java/java/util/prefs/PreferenceChangeEvent.java
===================================================================
--- modules/prefs/src/main/java/java/util/prefs/PreferenceChangeEvent.java	(revision 768380)
+++ modules/prefs/src/main/java/java/util/prefs/PreferenceChangeEvent.java	Mon Apr 27 11:58:28
PDT 2009
@@ -24,11 +24,12 @@
 import java.util.EventObject;
 
 /**
- * This is the event class to indicate some preferences has been added, 
- * deleted or updated.
+ * This is the event class to indicate that a preference has been added, deleted
+ * or updated.
  * <p>
- * Please note that this class cannot be serialized actually, so relevant 
- * serialization methods only throw <code>NotSerializableException</code>.
+ * Please note that the serialization functionality has not yet been
+ * implemented, so the serialization methods do nothing but throw a {@code
+ * NotSerializableException}.
  * </p>
  * 
  * @see java.util.prefs.Preferences

I have changed it to read:

Index: PreferenceChangeEvent.java
===================================================================
--- PreferenceChangeEvent.java	(revision 768745)
+++ PreferenceChangeEvent.java	(working copy)
@@ -24,12 +24,12 @@
 import java.util.EventObject;
 
 /**
- * This is the event class to indicate some preferences has been added, 
- * deleted or updated.
+ * This is the event class to indicate that a preference has been added, deleted
+ * or updated.
  * <p>
- * Please note that this class cannot be serialized actually, so relevant 
- * serialization methods only throw <code>NotSerializableException</code>.
- * </p>
+ * Please note that although the class is marked as {@code Serializable} by
+ * inheritance from {@code EventObject}, this type is not intended to be serialized
+ * so the serialization methods do nothing but throw a {@code NotSerializableException}.
  * 
  * @see java.util.prefs.Preferences
  * @see java.util.prefs.PreferenceChangeListener


> Javadocs for java.util.prefs.*
> ------------------------------
>
>                 Key: HARMONY-6183
>                 URL: https://issues.apache.org/jira/browse/HARMONY-6183
>             Project: Harmony
>          Issue Type: Improvement
>          Components: Classlib
>         Environment: SVN Revision: 768380
>            Reporter: Jesse Wilson
>            Assignee: Tim Ellison
>            Priority: Minor
>             Fix For: 5.0M10
>
>         Attachments: Prefs_Javadoc_from_Android_.patch
>
>   Original Estimate: 0.33h
>  Remaining Estimate: 0.33h
>
> Improvements to the prefs Javadocs from Android.
> http://developer.android.com/reference/java/util/prefs/package-summary.html

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message