Google Git
Sign in
apache / axis-site / 8c17319ae4c4129c6d30d33e4b59d5b23345ea24 / . / axis2 / java / core-staging / apidocs / org / apache / axis2 / json / AbstractJSONDataSource.html
blob: 79d29bad0c27f25338b20a8f5fd5f775fcb0c32d [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>AbstractJSONDataSource (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="AbstractJSONDataSource (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/AbstractJSONDataSource.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>Prev Class</li>
<li><a href="../../../../org/apache/axis2/json/AbstractJSONMessageFormatter.html" title="class in org.apache.axis2.json"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/json/AbstractJSONDataSource.html" target="_top">Frames</a></li>
<li><a href="AbstractJSONDataSource.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.json</div>
<h2 title="Class AbstractJSONDataSource" class="title">Class AbstractJSONDataSource</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><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds">org.apache.axiom.om.ds.AbstractOMDataSource</a></li>
<li>
<ul class="inheritance">
<li><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractPullOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds">org.apache.axiom.om.ds.AbstractPullOMDataSource</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.json.AbstractJSONDataSource</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSource</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/axis2/json/JSONBadgerfishDataSource.html" title="class in org.apache.axis2.json">JSONBadgerfishDataSource</a>, <a href="../../../../org/apache/axis2/json/JSONDataSource.html" title="class in org.apache.axis2.json">JSONDataSource</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractJSONDataSource</span>
extends <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractPullOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds">AbstractPullOMDataSource</a></pre>
<div class="block">JSONDataSource keeps the JSON String inside and consumes it when needed. This is to be kept in
the OMSourcedElement and can be used either to expand the tree or get the JSON String
directly without expanding. This uses the "Mapped" JSON convention.</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.axiom.om.OMDataSourceExt">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.axiom.om.<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true" title="class or interface in org.apache.axiom.om">OMDataSourceExt</a></h3>
<code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/OMDataSourceExt.html?is-external=true#LOSSY_PREFIX" title="class or interface in org.apache.axiom.om">LOSSY_PREFIX</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/json/AbstractJSONDataSource.html#AbstractJSONDataSource(java.io.Reader)">AbstractJSONDataSource</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;jsonReader)</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>protected <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/json/AbstractJSONDataSource.html#getJSONString()">getJSONString</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <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></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/json/AbstractJSONDataSource.html#getReader()">getReader</a></strong>()</code>
<div class="block">Gives the StAX reader using the "Mapped" formatted input JSON String.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/axis2/json/AbstractJSONDataSource.html#isDestructiveRead()">isDestructiveRead</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axiom.om.ds.AbstractPullOMDataSource">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axiom.om.ds.<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractPullOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds">AbstractPullOMDataSource</a></h3>
<code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractPullOMDataSource.html?is-external=true#isDestructiveWrite()" title="class or interface in org.apache.axiom.om.ds">isDestructiveWrite</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractPullOMDataSource.html?is-external=true#serialize(javax.xml.stream.XMLStreamWriter)" title="class or interface in org.apache.axiom.om.ds">serialize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.axiom.om.ds.AbstractOMDataSource">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.axiom.om.ds.<a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true" title="class or interface in org.apache.axiom.om.ds">AbstractOMDataSource</a></h3>
<code><a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#close()" title="class or interface in org.apache.axiom.om.ds">close</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#copy()" title="class or interface in org.apache.axiom.om.ds">copy</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getObject()" title="class or interface in org.apache.axiom.om.ds">getObject</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getProperty(java.lang.String)" title="class or interface in org.apache.axiom.om.ds">getProperty</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getXMLBytes(java.lang.String)" title="class or interface in org.apache.axiom.om.ds">getXMLBytes</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#getXMLInputStream(java.lang.String)" title="class or interface in org.apache.axiom.om.ds">getXMLInputStream</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#hasProperty(java.lang.String)" title="class or interface in org.apache.axiom.om.ds">hasProperty</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#serialize(java.io.OutputStream, org.apache.axiom.om.OMOutputFormat)" title="class or interface in org.apache.axiom.om.ds">serialize</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#serialize(java.io.Writer, org.apache.axiom.om.OMOutputFormat)" title="class or interface in org.apache.axiom.om.ds">serialize</a>, <a href="http://ws.apache.org/axiom/apidocs/org/apache/axiom/om/ds/AbstractOMDataSource.html?is-external=true#setProperty(java.lang.String, java.lang.Object)" title="class or interface in org.apache.axiom.om.ds">setProperty</a></code></li>
</ul>
<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="AbstractJSONDataSource(java.io.Reader)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractJSONDataSource</h4>
<pre>public&nbsp;AbstractJSONDataSource(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</a>&nbsp;jsonReader)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getReader()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReader</h4>
<pre>public abstract&nbsp;<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;getReader()
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">Gives the StAX reader using the "Mapped" formatted input JSON String.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The XMLStreamReader according to the JSON String.</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> - if there is an error while making the StAX reader.</dd></dl>
</li>
</ul>
<a name="isDestructiveRead()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDestructiveRead</h4>
<pre>public&nbsp;boolean&nbsp;isDestructiveRead()</pre>
</li>
</ul>
<a name="getJSONString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getJSONString</h4>
<pre>protected&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;getJSONString()</pre>
</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/AbstractJSONDataSource.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>Prev Class</li>
<li><a href="../../../../org/apache/axis2/json/AbstractJSONMessageFormatter.html" title="class in org.apache.axis2.json"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/axis2/json/AbstractJSONDataSource.html" target="_top">Frames</a></li>
<li><a href="AbstractJSONDataSource.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="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>