mirror of https://github.com/etesync/android
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
591 lines
22 KiB
591 lines
22 KiB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_37) on Mon Feb 18 20:39:44 EST 2013 -->
|
|
<TITLE>
|
|
InputNode
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2013-02-18">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="InputNode";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../org/simpleframework/xml/stream/HyphenStyle.html" title="class in org.simpleframework.xml.stream"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/Mode.html" title="enum in org.simpleframework.xml.stream"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?org/simpleframework/xml/stream/InputNode.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="InputNode.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
org.simpleframework.xml.stream</FONT>
|
|
<BR>
|
|
Interface InputNode</H2>
|
|
<DL>
|
|
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream">Node</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public interface <B>InputNode</B><DT>extends <A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream">Node</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
The <code>InputNode</code> object represents an iterator for the
|
|
elements within an element. This allows the input node object to
|
|
become a self contained iterator for an element and its children.
|
|
Each child taken from the input node object, is itself an input
|
|
node, and can be used to explore its sub elements without having
|
|
any affect on its outer elements.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Niall Gallagher</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getAttribute(java.lang.String)">getAttribute</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
Provides an attribute from the element represented.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="interface in org.simpleframework.xml.stream">NodeMap</A><<A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getAttributes()">getAttributes</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This returns a map of the attributes contained within the
|
|
element.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getNext()">getNext</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This returns the next child element within this element if
|
|
one exists.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getNext(java.lang.String)">getNext</A></B>(java.lang.String name)</CODE>
|
|
|
|
<BR>
|
|
This returns the next child in this element if that child
|
|
has the name provided.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getParent()">getParent</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This is used to acquire the <code>Node</code> that is the
|
|
parent of this node.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../org/simpleframework/xml/stream/Position.html" title="interface in org.simpleframework.xml.stream">Position</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getPosition()">getPosition</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This provides the position of this node within the document.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getPrefix()">getPrefix</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This is used to acquire the namespace prefix for the node.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getReference()">getReference</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This allows the namespace reference URI to be determined.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#getSource()">getSource</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This is used to return the source object for this node.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#isElement()">isElement</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This is used to determine if this node is an element.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#isEmpty()">isEmpty</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This is used to determine if this input node is empty.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#isRoot()">isRoot</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This method is used to determine if this node is the root
|
|
node for the XML document.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../org/simpleframework/xml/stream/InputNode.html#skip()">skip</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This method is used to skip all child elements from this
|
|
element.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_org.simpleframework.xml.stream.Node"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from interface org.simpleframework.xml.stream.<A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream">Node</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="../../../../org/simpleframework/xml/stream/Node.html#getName()">getName</A>, <A HREF="../../../../org/simpleframework/xml/stream/Node.html#getValue()">getValue</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="isRoot()"><!-- --></A><H3>
|
|
isRoot</H3>
|
|
<PRE>
|
|
boolean <B>isRoot</B>()</PRE>
|
|
<DL>
|
|
<DD>This method is used to determine if this node is the root
|
|
node for the XML document. The root node is the first node
|
|
in the document and has no sibling nodes. This is false
|
|
if the node has a parent node or a sibling node.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>true if this is the root node within the document</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isElement()"><!-- --></A><H3>
|
|
isElement</H3>
|
|
<PRE>
|
|
boolean <B>isElement</B>()</PRE>
|
|
<DL>
|
|
<DD>This is used to determine if this node is an element. This
|
|
allows users of the framework to make a distinction between
|
|
nodes that represent attributes and nodes that represent
|
|
elements. This is particularly useful given that attribute
|
|
nodes do not maintain a node map of attributes.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns true if the node is an element node</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPrefix()"><!-- --></A><H3>
|
|
getPrefix</H3>
|
|
<PRE>
|
|
java.lang.String <B>getPrefix</B>()</PRE>
|
|
<DL>
|
|
<DD>This is used to acquire the namespace prefix for the node.
|
|
If there is no namespace prefix for the node then this will
|
|
return null. Acquiring the prefix enables the qualification
|
|
of the node to be determined. It also allows nodes to be
|
|
grouped by its prefix and allows group operations.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns the prefix associated with this node</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReference()"><!-- --></A><H3>
|
|
getReference</H3>
|
|
<PRE>
|
|
java.lang.String <B>getReference</B>()</PRE>
|
|
<DL>
|
|
<DD>This allows the namespace reference URI to be determined.
|
|
A reference is a globally unique string that allows the
|
|
node to be identified. Typically the reference will be a URI
|
|
but it can be any unique string used to identify the node.
|
|
This allows the node to be identified within the namespace.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns the associated namespace reference URI</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPosition()"><!-- --></A><H3>
|
|
getPosition</H3>
|
|
<PRE>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/Position.html" title="interface in org.simpleframework.xml.stream">Position</A> <B>getPosition</B>()</PRE>
|
|
<DL>
|
|
<DD>This provides the position of this node within the document.
|
|
This allows the user of this node to report problems with
|
|
the location within the document, allowing the XML to be
|
|
debugged if it does not match the class schema.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns the position of the XML read cursor</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAttribute(java.lang.String)"><!-- --></A><H3>
|
|
getAttribute</H3>
|
|
<PRE>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> <B>getAttribute</B>(java.lang.String name)</PRE>
|
|
<DL>
|
|
<DD>Provides an attribute from the element represented. If an
|
|
attribute for the specified name does not exist within the
|
|
element represented then this method will return null.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - this is the name of the attribute to retrieve
|
|
<DT><B>Returns:</B><DD>this returns the value for the named attribute</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAttributes()"><!-- --></A><H3>
|
|
getAttributes</H3>
|
|
<PRE>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/NodeMap.html" title="interface in org.simpleframework.xml.stream">NodeMap</A><<A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A>> <B>getAttributes</B>()</PRE>
|
|
<DL>
|
|
<DD>This returns a map of the attributes contained within the
|
|
element. If no elements exist within the element then this
|
|
returns an empty map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns a map of attributes for the element</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getParent()"><!-- --></A><H3>
|
|
getParent</H3>
|
|
<PRE>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> <B>getParent</B>()</PRE>
|
|
<DL>
|
|
<DD>This is used to acquire the <code>Node</code> that is the
|
|
parent of this node. This will return the node that is
|
|
the direct parent of this node and allows for siblings to
|
|
make use of nodes with their parents if required.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/simpleframework/xml/stream/Node.html#getParent()">getParent</A></CODE> in interface <CODE><A HREF="../../../../org/simpleframework/xml/stream/Node.html" title="interface in org.simpleframework.xml.stream">Node</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns the parent node for this node</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSource()"><!-- --></A><H3>
|
|
getSource</H3>
|
|
<PRE>
|
|
java.lang.Object <B>getSource</B>()</PRE>
|
|
<DL>
|
|
<DD>This is used to return the source object for this node. This
|
|
is used primarily as a means to determine which XML provider
|
|
is parsing the source document and producing the nodes. It
|
|
is useful to be able to determine the XML provider like this.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns the source of this input node</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNext()"><!-- --></A><H3>
|
|
getNext</H3>
|
|
<PRE>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> <B>getNext</B>()
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This returns the next child element within this element if
|
|
one exists. If all children have been read, or if there are
|
|
no child elements for this element then this returns null.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns an input node for the next child
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - thrown if there was a parse error</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNext(java.lang.String)"><!-- --></A><H3>
|
|
getNext</H3>
|
|
<PRE>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/InputNode.html" title="interface in org.simpleframework.xml.stream">InputNode</A> <B>getNext</B>(java.lang.String name)
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This returns the next child in this element if that child
|
|
has the name provided. If the next child element in this
|
|
node does not have the name given then null is returned.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - this is the name of the next child element
|
|
<DT><B>Returns:</B><DD>the next element if it has the name specified
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - thrown if there was a parse error</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="skip()"><!-- --></A><H3>
|
|
skip</H3>
|
|
<PRE>
|
|
void <B>skip</B>()
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This method is used to skip all child elements from this
|
|
element. This allows elements to be effectively skipped such
|
|
that when parsing a document if an element is not required
|
|
then that element can be completely removed from the XML.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - thrown if there was a parse error</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isEmpty()"><!-- --></A><H3>
|
|
isEmpty</H3>
|
|
<PRE>
|
|
boolean <B>isEmpty</B>()
|
|
throws java.lang.Exception</PRE>
|
|
<DL>
|
|
<DD>This is used to determine if this input node is empty. An
|
|
empty node is one with no attributes or children. This can
|
|
be used to determine if a given node represents an empty
|
|
entity, with which no extra data can be extracted.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns true if the node is an empty element
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE>java.lang.Exception</CODE> - thrown if there was a parse error</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../org/simpleframework/xml/stream/HyphenStyle.html" title="class in org.simpleframework.xml.stream"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../org/simpleframework/xml/stream/Mode.html" title="enum in org.simpleframework.xml.stream"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?org/simpleframework/xml/stream/InputNode.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="InputNode.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|