Google Git
Sign in
apache / axis-site / f7bdbce8f5178add02522fdbf11ca5350d8eef03 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / databinding / utils / SimpleArrayReaderStateMachine.html
blob: dac0a3e8a5dbc40e03a9f06ac6854d7b36fd2a38 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>SimpleArrayReaderStateMachine (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SimpleArrayReaderStateMachine (Apache Axis2)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SimpleArrayReaderStateMachine.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/axis2/databinding/utils/NamedStaxOMBuilder.html" title="class in org.apache.axis2.databinding.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/databinding/utils/SimpleElementReaderStateMachine.html" title="class in org.apache.axis2.databinding.utils"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html" target="_top">Frames</a></li>
<li><a href="SimpleArrayReaderStateMachine.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.axis2.databinding.utils</div>
<h2 title="Class SimpleArrayReaderStateMachine" class="title">Class SimpleArrayReaderStateMachine</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.databinding.utils.SimpleArrayReaderStateMachine</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/axis2/databinding/utils/Constants.html" title="interface in org.apache.axis2.databinding.utils">Constants</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html" title="interface in org.apache.axis2.databinding.utils">States</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SimpleArrayReaderStateMachine</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/axis2/databinding/utils/States.html" title="interface in org.apache.axis2.databinding.utils">States</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html" title="interface in org.apache.axis2.databinding.utils">Constants</a></pre>
<div class="block">A state machine that reads arrays with simple content. returns a string array</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.axis2.databinding.utils.States">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.axis2.databinding.utils.<a href="../../../../../org/apache/axis2/databinding/utils/States.html" title="interface in org.apache.axis2.databinding.utils">States</a></h3>
<code><a href="../../../../../org/apache/axis2/databinding/utils/States.html#CONTENT_FOUND_STATE">CONTENT_FOUND_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#END_ELEMENT_FOUND_STATE">END_ELEMENT_FOUND_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#FINISHED_STATE">FINISHED_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#ILLEGAL_STATE">ILLEGAL_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#INIT_STATE">INIT_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#NULLED_STATE">NULLED_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#START_ELEMENT_FOUND_STATE">START_ELEMENT_FOUND_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#STARTED_STATE">STARTED_STATE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/States.html#TEXT_FOUND_STATE">TEXT_FOUND_STATE</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.axis2.databinding.utils.Constants">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.axis2.databinding.utils.<a href="../../../../../org/apache/axis2/databinding/utils/Constants.html" title="interface in org.apache.axis2.databinding.utils">Constants</a></h3>
<code><a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#DEFAULT_XSD_NAMESPACE_PREFIX">DEFAULT_XSD_NAMESPACE_PREFIX</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#DEFAULT_XSI_NAMESPACE_PREFIX">DEFAULT_XSI_NAMESPACE_PREFIX</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#INNER_ARRAY_COMPLEX_TYPE_NAME">INNER_ARRAY_COMPLEX_TYPE_NAME</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#NIL">NIL</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#OM_ATTRIBUTE_KEY">OM_ATTRIBUTE_KEY</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#OM_ELEMENT_KEY">OM_ELEMENT_KEY</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#RETURN_WRAPPER">RETURN_WRAPPER</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#TRUE">TRUE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#XSD_NAMESPACE">XSD_NAMESPACE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#XSI_NAMESPACE">XSI_NAMESPACE</a>, <a href="../../../../../org/apache/axis2/databinding/utils/Constants.html#XSI_TYPE_ATTRIBUTE">XSI_TYPE_ATTRIBUTE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#SimpleArrayReaderStateMachine()">SimpleArrayReaderStateMachine</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#getTextArray()">getTextArray</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#isCanbeAbsent()">isCanbeAbsent</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#read(javax.xml.stream.XMLStreamReader)">read</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</a>&nbsp;reader)</code>
<div class="block">public read method - reads a given reader to extract the text value</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#reset()">reset</a></strong>()</code>
<div class="block">Resets the state machine.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#setCanbeAbsent(boolean)">setCanbeAbsent</a></strong>(boolean&nbsp;canbeAbsent)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#setElementNameToTest(javax.xml.namespace.QName)">setElementNameToTest</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a>&nbsp;elementNameToTest)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html#setNillable()">setNillable</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SimpleArrayReaderStateMachine()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleArrayReaderStateMachine</h4>
<pre>public&nbsp;SimpleArrayReaderStateMachine()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getTextArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTextArray</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getTextArray()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>an array of strings</dd></dl>
</li>
</ul>
<a name="setNillable()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNillable</h4>
<pre>public&nbsp;void&nbsp;setNillable()</pre>
</li>
</ul>
<a name="isCanbeAbsent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCanbeAbsent</h4>
<pre>public&nbsp;boolean&nbsp;isCanbeAbsent()</pre>
</li>
</ul>
<a name="setCanbeAbsent(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCanbeAbsent</h4>
<pre>public&nbsp;void&nbsp;setCanbeAbsent(boolean&nbsp;canbeAbsent)</pre>
</li>
</ul>
<a name="reset()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block">Resets the state machine. Once the reset is called the state machine is good enough for a
fresh run</div>
</li>
</ul>
<a name="setElementNameToTest(javax.xml.namespace.QName)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setElementNameToTest</h4>
<pre>public&nbsp;void&nbsp;setElementNameToTest(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/javax/xml/namespace/QName.html?is-external=true" title="class or interface in javax.xml.namespace">QName</a>&nbsp;elementNameToTest)</pre>
</li>
</ul>
<a name="read(javax.xml.stream.XMLStreamReader)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>read</h4>
<pre>public&nbsp;void&nbsp;read(<a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamReader.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamReader</a>&nbsp;reader)
throws <a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a></pre>
<div class="block">public read method - reads a given reader to extract the text value</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reader</code> - </dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javaee/5/api/javax/xml/stream/XMLStreamException.html?is-external=true" title="class or interface in javax.xml.stream">XMLStreamException</a></code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SimpleArrayReaderStateMachine.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/axis2/databinding/utils/NamedStaxOMBuilder.html" title="class in org.apache.axis2.databinding.utils"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/databinding/utils/SimpleElementReaderStateMachine.html" title="class in org.apache.axis2.databinding.utils"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/databinding/utils/SimpleArrayReaderStateMachine.html" target="_top">Frames</a></li>
<li><a href="SimpleArrayReaderStateMachine.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>