http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4752869d/content/site/apidocs/org/apache/juneau/uon/UonWriter.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/uon/UonWriter.html b/content/site/apidocs/org/apache/juneau/uon/UonWriter.html new file mode 100644 index 0000000..bbc1387 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/uon/UonWriter.html @@ -0,0 +1,818 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>UonWriter (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="UonWriter (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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="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/juneau/uon/UonSerializerSession.html" title="class in org.apache.juneau.uon"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/uon/UonWriter.html" target="_top">Frames</a></li> +<li><a href="UonWriter.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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.juneau.serializer.SerializerWriter">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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.juneau.uon</div> +<h2 title="Class UonWriter" class="title">Class UonWriter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">java.io.Writer</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">org.apache.juneau.serializer.SerializerWriter</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.juneau.uon.UonWriter</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://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Flushable.html?is-external=true"; title="class or interface in java.io">Flushable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a></dd> +</dl> +<hr> +<br> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.28">UonWriter</a> +extends <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></pre> +<div class="block">Specialized writer for serializing UON-encoded text. + <p> + <h5 class='section'>Notes:</h5> + <ul> + <li>This class is not intended for external use. + </ul></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.juneau.serializer.SerializerWriter"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.juneau.serializer.<a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></h3> +<code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#absolutePathUriBase">absolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#out">out</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#quoteChar">quoteChar</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#relativeUriBase">relativeUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#trimStrings">trimStrings</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#useWhitespace">useWhitespace</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.java.io.Writer"> +<!-- --> +</a> +<h3>Fields inherited from class java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#lock"; title="class or interface in java.io">lock</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#UonWriter-org.apache.juneau.uon.UonSerializerSession-java.io.Writer-boolean-boolean-boolean-java.lang.String-java.lang.String-">UonWriter</a></span>(<a href="../../../../org/apache/juneau/uon/UonSerializerSession.html" title="class in org.apache.juneau.uon">UonSerializerSession</a> session, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + boolean useWhitespace, + boolean encodeChars, + boolean trimStrings, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> relativeUriBase, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> absolutePathUriBase)</code> +<div class="block">Constructor.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#append-char-">append</a></span>(char c)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#append-int-char-">append</a></span>(int indent, + char c)</code> +<div class="block">Writes an indent (if the <code>useWhitespace</code> setting is enabled), followed by text.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#append-int-java.lang.String-">append</a></span>(int indent, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</code> +<div class="block">Writes an indent (if the <code>useWhitespace</code> setting is enabled), followed by text.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#append-java.lang.Object-">append</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> text)</code> +<div class="block">Writes the specified text to the writer.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#append-java.lang.String-">append</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</code> +<div class="block">Writes the specified text to the writer.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendBoolean-java.lang.Object-">appendBoolean</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</code> +<div class="block">Appends a boolean value to the output.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendIf-boolean-char-">appendIf</a></span>(boolean b, + char c)</code> +<div class="block">Writes the specified text to the writer if b is true.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendIf-boolean-java.lang.String-">appendIf</a></span>(boolean b, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</code> +<div class="block">Writes the specified text to the writer if b is true.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendln-int-java.lang.String-">appendln</a></span>(int indent, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</code> +<div class="block">Writes an indent (if the <code>useWhitespace</code> setting is enabled), followed by text, + followed by a newline (if the <code>useWhitespace</code> setting is enabled).</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendln-java.lang.String-">appendln</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text)</code> +<div class="block">Writes the specified text followed by a newline (if the <code>useWhitespace</code> setting is enabled).</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendNumber-java.lang.Object-">appendNumber</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o)</code> +<div class="block">Appends a numeric value to the output.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendObject-java.lang.Object-boolean-">appendObject</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o, + boolean isTopAttrName)</code> +<div class="block">Serializes the specified simple object as a UON string value.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#appendUri-java.lang.Object-">appendUri</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</code> +<div class="block">Appends a URI to the output.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#cr-int-">cr</a></span>(int depth)</code> +<div class="block">Performs a carriage return.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#i-int-">i</a></span>(int indent)</code> +<div class="block">Writes an indent to the writer if the <code>useWhitespace</code> setting is enabled.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#nl--">nl</a></span>()</code> +<div class="block">Writes a newline to the writer if the <code>useWhitespace</code> setting is enabled.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/uon/UonWriter.html#q--">q</a></span>()</code> +<div class="block">Adds the quote character specified by the <code>quoteChar</code> setting to the output.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.serializer.SerializerWriter"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.juneau.serializer.<a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></h3> +<code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-char:A-">append</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#close--">close</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#flush--">flush</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#nlIf-boolean-">nlIf</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#s--">s</a>, <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#write-char:A-int-int-">write</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.io.Writer"> +<!-- --> +</a> +<h3>Methods inherited from class java.io.<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#append-java.lang.CharSequence-"; title="class or interface in java.io">append</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#append-java.lang.CharSequence-int-int-"; title="class or interface in java.io">append</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-char:A-"; title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-int-"; title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-java.lang.String-"; title="class or interface in java.io">write</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true#write-java.lang.String-int-int-"; title="class or interface in java.io">write</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 java.lang.<a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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="UonWriter-org.apache.juneau.uon.UonSerializerSession-java.io.Writer-boolean-boolean-boolean-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UonWriter</h4> +<pre>protected <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.60">UonWriter</a>(<a href="../../../../org/apache/juneau/uon/UonSerializerSession.html" title="class in org.apache.juneau.uon">UonSerializerSession</a> session, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + boolean useWhitespace, + boolean encodeChars, + boolean trimStrings, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> relativeUriBase, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> absolutePathUriBase)</pre> +<div class="block">Constructor.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>session</code> - The session that created this writer.</dd> +<dd><code>out</code> - The writer being wrapped.</dd> +<dd><code>useWhitespace</code> - If <jk>true</jk>, tabs will be used in output.</dd> +<dd><code>encodeChars</code> - If <jk>true</jk>, special characters should be encoded.</dd> +<dd><code>trimStrings</code> - If <jk>true</jk>, strings should be trimmed before they're serialized.</dd> +<dd><code>relativeUriBase</code> - The base (e.g. <js>https://localhost:9443/contextPath";</js>) for relative URIs (e.g. <js>"my/path"</js>).</dd> +<dd><code>absolutePathUriBase</code> - The base (e.g. <js>https://localhost:9443";</js>) for relative URIs with absolute paths (e.g. <js>"/contextPath/my/path"</js>).</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="appendObject-java.lang.Object-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendObject</h4> +<pre>public final <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.74">appendObject</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o, + boolean isTopAttrName) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Serializes the specified simple object as a UON string value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The object being serialized.</dd> +<dd><code>isTopAttrName</code> - If this is a top-level attribute name we're serializing.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - Should never happen.</dd> +</dl> +</li> +</ul> +<a name="appendBoolean-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendBoolean</h4> +<pre>protected <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.147">appendBoolean</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Appends a boolean value to the output.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The boolean value to append to the output.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="appendNumber-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendNumber</h4> +<pre>protected <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.159">appendNumber</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> o) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Appends a numeric value to the output.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>o</code> - The numeric value to append to the output.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="appendUri-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendUri</h4> +<pre>public <a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.182">appendUri</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Appends a URI to the output.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendUri-java.lang.Object-">appendUri</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>uri</code> - The URI to append to the output.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="cr-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cr</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.205">cr</a>(int depth) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#cr-int-">SerializerWriter</a></code></span></div> +<div class="block">Performs a carriage return. + <p> + Adds a newline and the specified number of tabs (if the <code>useWhitespace</code> setting is enabled) to the output.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#cr-int-">cr</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>depth</code> - The indentation.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="appendln-int-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendln</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.211">appendln</a>(int indent, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendln-int-java.lang.String-">SerializerWriter</a></code></span></div> +<div class="block">Writes an indent (if the <code>useWhitespace</code> setting is enabled), followed by text, + followed by a newline (if the <code>useWhitespace</code> setting is enabled).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendln-int-java.lang.String-">appendln</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>indent</code> - The number of tabs to indent.</dd> +<dd><code>text</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="appendln-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendln</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.217">appendln</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendln-java.lang.String-">SerializerWriter</a></code></span></div> +<div class="block">Writes the specified text followed by a newline (if the <code>useWhitespace</code> setting is enabled).</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendln-java.lang.String-">appendln</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>text</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="append-int-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.223">append</a>(int indent, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-int-java.lang.String-">SerializerWriter</a></code></span></div> +<div class="block">Writes an indent (if the <code>useWhitespace</code> setting is enabled), followed by text.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-int-java.lang.String-">append</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>indent</code> - The number of tabs to indent.</dd> +<dd><code>text</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="append-int-char-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.229">append</a>(int indent, + char c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-int-char-">SerializerWriter</a></code></span></div> +<div class="block">Writes an indent (if the <code>useWhitespace</code> setting is enabled), followed by text.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-int-char-">append</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>indent</code> - The number of tabs to indent.</dd> +<dd><code>c</code> - The character to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="q--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>q</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.235">q</a>() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#q--">SerializerWriter</a></code></span></div> +<div class="block">Adds the quote character specified by the <code>quoteChar</code> setting to the output.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#q--">q</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="i-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>i</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.241">i</a>(int indent) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#i-int-">SerializerWriter</a></code></span></div> +<div class="block">Writes an indent to the writer if the <code>useWhitespace</code> setting is enabled.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#i-int-">i</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>indent</code> - The number of tabs to indent.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="nl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>nl</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.247">nl</a>() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#nl--">SerializerWriter</a></code></span></div> +<div class="block">Writes a newline to the writer if the <code>useWhitespace</code> setting is enabled.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#nl--">nl</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="append-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.253">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> text) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-java.lang.Object-">SerializerWriter</a></code></span></div> +<div class="block">Writes the specified text to the writer.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-java.lang.Object-">append</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>text</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="append-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.259">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-java.lang.String-">SerializerWriter</a></code></span></div> +<div class="block">Writes the specified text to the writer.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-java.lang.String-">append</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>text</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="appendIf-boolean-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendIf</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.265">appendIf</a>(boolean b, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> text) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendIf-boolean-java.lang.String-">SerializerWriter</a></code></span></div> +<div class="block">Writes the specified text to the writer if b is true.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendIf-boolean-java.lang.String-">appendIf</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>b</code> - Boolean flag.</dd> +<dd><code>text</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="appendIf-boolean-char-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>appendIf</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.271">appendIf</a>(boolean b, + char c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendIf-boolean-char-">SerializerWriter</a></code></span></div> +<div class="block">Writes the specified text to the writer if b is true.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#appendIf-boolean-char-">appendIf</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>b</code> - Boolean flag.</dd> +<dd><code>c</code> - The text to write.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - If a problem occurred trying to write to the writer.</dd> +</dl> +</li> +</ul> +<a name="append-char-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../org/apache/juneau/uon/UonWriter.html" title="class in org.apache.juneau.uon">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/uon/UonWriter.html#line.277">append</a>(char c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true#append-char-"; title="class or interface in java.lang">append</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html#append-char-">append</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerWriter.html" title="class in org.apache.juneau.serializer">SerializerWriter</a></code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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="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/juneau/uon/UonSerializerSession.html" title="class in org.apache.juneau.uon"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/juneau/uon/UonWriter.html" target="_top">Frames</a></li> +<li><a href="UonWriter.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: </li> +<li>Nested | </li> +<li><a href="#fields.inherited.from.class.org.apache.juneau.serializer.SerializerWriter">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </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 © 2017 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4752869d/content/site/apidocs/org/apache/juneau/uon/doc-files/Example_HTML.png ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/uon/doc-files/Example_HTML.png b/content/site/apidocs/org/apache/juneau/uon/doc-files/Example_HTML.png new file mode 100644 index 0000000..04dcf41 Binary files /dev/null and b/content/site/apidocs/org/apache/juneau/uon/doc-files/Example_HTML.png differ http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4752869d/content/site/apidocs/org/apache/juneau/uon/doc-files/rfc_uon.txt ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/uon/doc-files/rfc_uon.txt b/content/site/apidocs/org/apache/juneau/uon/doc-files/rfc_uon.txt new file mode 100644 index 0000000..7880064 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/uon/doc-files/rfc_uon.txt @@ -0,0 +1,294 @@ +Network Working Group J. Bognar +Request for Comments: 9999 +Category: Informational Salesforce + Feb 2017 + + ***DRAFT*** + URI Object Notation (UON): Generic Syntax + + +About this document + + This memo provides information for the Internet community. It does + not specify an Internet standard of any kind. Distribution of this + memo is unlimited. + +Copyright Notice + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Abstract + + This document describes a grammar that builds upon RFC2396 + (Uniform Resource Identifiers). Its purpose is to define a + generalized object notation for URI query parameter values similar in + concept to Javascript Object Notation (RFC4627). The goal is a + syntax that allows for array and map structures to be + such that any data structure defined in JSON can be losslessly + defined in an equivalent URI-based grammar, yet be fully compliant + with the RFC2396 specification. + + This grammar provides the ability to construct the following data + structures in URL parameter values: + + OBJECT + ARRAY + NUMBER + BOOLEAN + STRING + NULL + + Example: + + The following shows a sample object defined in Javascript: + + var x = { + id: 1, + name: 'John Smith', + uri: 'http://sample/addressBook/person/1', + addressBookUri: 'http://sample/addressBook', + birthDate: '1946-08-12T00:00:00Z', + otherIds: null, + addresses: [ + { + uri: 'http://sample/addressBook/address/1', + personUri: 'http://sample/addressBook/person/1', + id: 1, + street: '100 Main Street', + city: 'Anywhereville', + state: 'NY', + zip: 12345, + isCurrent: true, + } + ] + } + + Using the syntax defined in this document, the equivalent + UON notation would be as follows: + + x=(id=1,name='John+Smith',uri=http://sample/ + addressBook/person/1,addressBookUri=http://sample/ + addressBook,birthDate=1946-08-12T00:00:00Z,otherIds=null, + addresses=@((uri=http://sample/addressBook/ + address/1,personUri=http://sample/addressBook/ + person/1,id=1,street='100+Main+Street',city= + Anywhereville,state=NY,zip=12345,isCurrent=true))) + +1. Language constraints + + The grammar syntax is constrained to usage of characters allowed by + URI notation: + + uric = reserved | unreserved | escaped + reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" | + "$" | "," + unreserved = alphanum | mark + mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")" + + In particular, the URI specification disallows the following + characters in unencoded form: + + unwise = "{" | "}" | "|" | "\" | "^" | "[" | "]" | "`" + delims = "<" | ">" | "#" | "%" | <"> + + The exclusion of {} and [] characters eliminates the possibility of + using JSON as parameter values. + + +2. Grammar constructs + + The grammar consists of the following language constructs: + + Objects - Values consisting of one or more child name/value pairs. + Arrays - Values consisting of zero or more child values. + Booleans - Values consisting of true/false values. + Numbers - Decimal and floating point values. + Strings - Everything else. + +2.1. Objects + + Objects are values consisting of one or more child name/value pairs. + The (...) construct is used to define an object. + + Example: A simple map with two key/value pairs: + + a1=(b1=x1,b2=x2) + + Example: A nested map: + + a1=(b1=(c1=x1,c2=x2)) + +2.2. Arrays + + Arrays are values consisting of zero or more child values. + The @(...) construct is used to define an array. + + Example: An array of two string values: + + a1=@(x1,x2) + + Example: A 2-dimensional array: + + a1=@(@(x1,x2),@(x3,x4)) + + Example: An array of objects: + + a1=@((b1=x1,b2=x2),(c1=x1,c2=x2)) + +2.3. Booleans + + Booleans are values that can only take on values "true" or "false". + + Example: Two boolean values: + + a1=true&a2=false + +2.4. Numbers + + Numbers are represented without constructs. + Both decimal and float numbers are supported. + + Example: Two numerical values, one decimal and one float: + + a1=123&a2=1.23e1 + +2.5. Null values + + Nulls are represented by the keyword 'null': + + a1=null + +2.6. Strings + + Strings are encapsulated in single quote (') characters. + + Example: Simple string values: + + a1='foobar'&a2='123'&a3='true' + + The quotes are optional when the string cannot be confused + with one of the constructs listed above (i.e. objects/arrays/ + booleans/numbers/null). + + Example: A simple string value, unquoted: + + a1=foobar + + Strings must be quoted for the following cases: + + - The string can be confused with a boolean or number. + - The string is empty. + - The string contains one or more whitespace characters. + - The string starts with one of the following characters: + @ ( + - The string contains any of the following characters: + ) , = + + For example, the string literal "(b1=x)" should be + represented as follows: + + a1='(b1=x)' + + The tilde character (~) is used for escaping characters to prevent + them from being confused with syntax characters. + + The following characters must be escaped in string literals: + + ' ~ + + Example: The string "foo'bar~baz" + + a1='foo~'bar~~baz' + +2.7. Top-level attribute names + + Top-level attribute names (e.g. "a1" in "&a1=foobar") are treated + as strings but for one exception. The '=' character must be + encoded so as not to be confused as a key/value separator. + Note that the '=' character must also be escaped per the UON + notation. + + For example, the UON equivalent of {"a=b":"a=b"} constructed as + a top-level query parameter string would be as follows: + + a~%3Db=a~=b + + Note that the '=' character is encoded in the attribute name, + but it is not necessary to have it encoded in the attribute value. + +2.8. URL-encoded characters + + UON notation allows for any character, even UON grammar + characters, to be URL-encoded. + + The following query strings are fully equivalent in structure: + + a1=(b1='x1',b2='x2') + %61%31=%79%6f%75%20%61%72%65%20%61%20%6e%65%72%64%21 + + +3. BNF + + The following BNF describes the syntax for top-level URI query + parameter values (e.g. ?<attrname>=<value>). + + attrname = (string | null) + value = (var | string | null) + + string = ("'" litchar* "'") | litchar* + null = "null" + + var = ovar | avar | nvar | boolean | number + ovar = "(" [pairs] ")" + avar = "@(" [values] ")" + + pairs = pair ["," pairs] + pair = key "=" value + values = value ["," values] + key = (string | null) + boolean = "true" | "false" + + escape_seq = "~" escaped + encode_seq = "%" digithex digithex + + number = [-] (decimal | float) [exp] + decimal = "0" | (digit19 digit*) + float = decimal "." digit+ + exp = "e" [("+" | "-")] digit+ + + litchar = unencoded | encode_seq | escape_seq + escaped = "@" | "," | "(" | ")" | "~" | "=" + unencoded = alpha | digit | + ";" | "/" | "?" | ":" | "@" | + "-" | "_" | "." | "!" | "*" | "'" + alpha = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | + "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | + "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | + "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | + "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | + "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" + digit = "0" | digit19 + digit19 = "1" | "2" | "3" | "4" | "5" | "6" | "7" | + "8" | "9" + digithex = digit | + "A" | "B" | "C" | "D" | "E" | "F" | + "a" | "b" | "c" | "d" | "e" | "f" + + + + http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4752869d/content/site/apidocs/org/apache/juneau/uon/package-frame.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/uon/package-frame.html b/content/site/apidocs/org/apache/juneau/uon/package-frame.html new file mode 100644 index 0000000..2781306 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/uon/package-frame.html @@ -0,0 +1,32 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>org.apache.juneau.uon (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)</title> +<link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<h1 class="bar"><a href="../../../../org/apache/juneau/uon/package-summary.html" target="classFrame">org.apache.juneau.uon</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="UonParser.html" title="class in org.apache.juneau.uon" target="classFrame">UonParser</a></li> +<li><a href="UonParser.Decoding.html" title="class in org.apache.juneau.uon" target="classFrame">UonParser.Decoding</a></li> +<li><a href="UonParserBuilder.html" title="class in org.apache.juneau.uon" target="classFrame">UonParserBuilder</a></li> +<li><a href="UonParserContext.html" title="class in org.apache.juneau.uon" target="classFrame">UonParserContext</a></li> +<li><a href="UonParserSession.html" title="class in org.apache.juneau.uon" target="classFrame">UonParserSession</a></li> +<li><a href="UonReader.html" title="class in org.apache.juneau.uon" target="classFrame">UonReader</a></li> +<li><a href="UonSerializer.html" title="class in org.apache.juneau.uon" target="classFrame">UonSerializer</a></li> +<li><a href="UonSerializer.Encoding.html" title="class in org.apache.juneau.uon" target="classFrame">UonSerializer.Encoding</a></li> +<li><a href="UonSerializer.Readable.html" title="class in org.apache.juneau.uon" target="classFrame">UonSerializer.Readable</a></li> +<li><a href="UonSerializerBuilder.html" title="class in org.apache.juneau.uon" target="classFrame">UonSerializerBuilder</a></li> +<li><a href="UonSerializerContext.html" title="class in org.apache.juneau.uon" target="classFrame">UonSerializerContext</a></li> +<li><a href="UonSerializerSession.html" title="class in org.apache.juneau.uon" target="classFrame">UonSerializerSession</a></li> +<li><a href="UonWriter.html" title="class in org.apache.juneau.uon" target="classFrame">UonWriter</a></li> +</ul> +</div> +</body> +</html>
