Author: veithen Date: Sun Mar 15 23:51:47 2009 New Revision: 754794 URL: http://svn.apache.org/viewvc?rev=754794&view=rev Log: Added some Javadoc.
Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java?rev=754794&r1=754793&r2=754794&view=diff ============================================================================== --- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java (original) +++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/om/impl/builder/StAXOMBuilder.java Sun Mar 15 23:51:47 2009 @@ -619,6 +619,26 @@ } } + /** + * Check if the node for the current token has already been created or if the parser is ahead + * of the builder. + * + * @return A return value of <code>true</code> indicates that the parser is one token ahead + * of the builder, i.e. that the node for the current token has not been created yet. + * In this case {...@link #getLastNode()} returns the node corresponding to the previous + * token. This state can only be reached by a call to {...@link #lookahead()}, and the + * current token is always a {...@link XMLStreamConstants#START_ELEMENT START_ELEMENT}. + * The information related to that element can be obtained by calls to + * {...@link #getName()}, {...@link #getNamespace()}, {...@link #getPrefix()}, + * {...@link #getAttributeCount()}, {...@link #getAttributeName(int)}, + * {...@link #getAttributeNamespace(int)}, {...@link #getAttributePrefix(int)}, + * {...@link #getNamespaceCount()}, {...@link #getNamespacePrefix(int)} and + * {...@link #getNamespaceUri(int)}. + * <p> + * A return value of <code>false</code> indicates that the node corresponding to the + * current token hold by the parser has already been created, i.e. + * {...@link #getLastNode()} returns the node corresponding to the current token. + */ public boolean isLookahead() { return lookAheadToken >= 0; }