commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From simonetrip...@apache.org
Subject svn commit: r1076183 - /commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/Digester.java
Date Wed, 02 Mar 2011 12:04:03 GMT
Author: simonetripodi
Date: Wed Mar  2 12:04:03 2011
New Revision: 1076183

URL: http://svn.apache.org/viewvc?rev=1076183&view=rev
Log:
added missing warnings on Javadoc

Modified:
    commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/Digester.java

Modified: commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/Digester.java
URL: http://svn.apache.org/viewvc/commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/Digester.java?rev=1076183&r1=1076182&r2=1076183&view=diff
==============================================================================
--- commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/Digester.java
(original)
+++ commons/sandbox/digester3/trunk/src/main/java/org/apache/commons/digester3/Digester.java
Wed Mar  2 12:04:03 2011
@@ -197,6 +197,9 @@ public interface Digester extends Conten
     /**
      * Pop the top object off of the stack, and return it.  If there are
      * no objects on the stack, return <code>null</code>.
+     *
+     * <b>WARNING</b>: this method is subject to {@link ClassCastException} if
+     * the returned object is not assignable to the generic type.
      */
     <T> T pop();
 
@@ -206,6 +209,9 @@ public interface Digester extends Conten
      * <p><strong>Note:</strong> a stack is considered empty
      * if no objects have been pushed onto it yet.</p>
      *
+     * <b>WARNING</b>: this method is subject to {@link ClassCastException} if
+     * the returned object is not assignable to the generic type.
+     *
      * @param stackName the name of the stack from which the top value is to be popped.
      * @return the top <code>Object</code> on the stack or or null if the stack
is either 
      * empty or has not been created yet
@@ -216,6 +222,9 @@ public interface Digester extends Conten
     /**
      * Return the top object on the stack without removing it.  If there are
      * no objects on the stack, return <code>null</code>.
+     *
+     * <b>WARNING</b>: this method is subject to {@link ClassCastException} if
+     * the returned object is not assignable to the generic type.
      */
     <T> T peek();
 
@@ -226,6 +235,9 @@ public interface Digester extends Conten
      * <p><strong>Note:</strong> a stack is considered empty
      * if no objects have been pushed onto it yet.</p>
      *
+     * <b>WARNING</b>: this method is subject to {@link ClassCastException} if
+     * the returned object is not assignable to the generic type.
+     *
      * @param stackName the name of the stack to be peeked
      * @return the top <code>Object</code> on the stack or null if the stack
is either 
      * empty or has not been created yet
@@ -238,6 +250,9 @@ public interface Digester extends Conten
      * and [getCount()-1] is the bottom element.  If the specified index
      * is out of range, return <code>null</code>.
      *
+     * <b>WARNING</b>: this method is subject to {@link ClassCastException} if
+     * the returned object is not assignable to the generic type.
+     *
      * @param n Index of the desired element, where 0 is the top of the stack,
      *  1 is the next element down, and so on.
      */
@@ -250,6 +265,9 @@ public interface Digester extends Conten
      * <p><strong>Note:</strong> a stack is considered empty
      * if no objects have been pushed onto it yet.</p>
      *
+     * <b>WARNING</b>: this method is subject to {@link ClassCastException} if
+     * the returned object is not assignable to the generic type.
+     *
      * @param stackName the name of the stack to be peeked
      * @param n Index of the desired element, where 0 is the top of the stack,
      *  1 is the next element down, and so on.



Mime
View raw message