http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/content/site/apidocs/org/apache/juneau/csv/CsvParserContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/csv/CsvParserContext.html b/content/site/apidocs/org/apache/juneau/csv/CsvParserContext.html index 905c099..134127e 100644 --- a/content/site/apidocs/org/apache/juneau/csv/CsvParserContext.html +++ b/content/site/apidocs/org/apache/juneau/csv/CsvParserContext.html @@ -123,21 +123,25 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/csv/CsvParserContext.html#line.36">CsvParserContext</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/csv/CsvParserContext.html#line.40">CsvParserContext</a> extends <a href="../../../../org/apache/juneau/parser/ParserContext.html" title="class in org.apache.juneau.parser">ParserContext</a></pre> <div class="block">Configurable properties on the <a href="../../../../org/apache/juneau/csv/CsvParser.html" title="class in org.apache.juneau.csv"><code>CsvParser</code></a> class. + <p> Context properties are set by calling <a href="../../../../org/apache/juneau/PropertyStore.html#setProperty-java.lang.String-java.lang.Object-"><code>PropertyStore.setProperty(String, Object)</code></a> on the property store passed into the constructor. + <p> See <a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> for more information about context properties. <h6 class='topic'>Inherited configurable properties</h6> <ul class='doctree'> - <li class='jc'><a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - + <li class='jc'> + <a class="doclink" href="../BeanContext.html#ConfigProperties">BeanContext</a> - Properties associated with handling beans on serializers and parsers. <ul> - <li class='jc'><a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - + <li class='jc'> + <a class="doclink" href="../parser/ParserContext.html#ConfigProperties">ParserContext</a> - Configurable properties common to all parsers. </ul> </ul></div> @@ -248,8 +252,9 @@ extends <a href="../../../../org/apache/juneau/parser/ParserContext.html" title= <ul class="blockListLast"> <li class="blockList"> <h4>CsvParserContext</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/csv/CsvParserContext.html#line.45">CsvParserContext</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/csv/CsvParserContext.html#line.50">CsvParserContext</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre> <div class="block">Constructor. + <p> Typically only called from <a href="../../../../org/apache/juneau/PropertyStore.html#getContext-java.lang.Class-"><code>PropertyStore.getContext(Class)</code></a>.</div> <dl> @@ -272,7 +277,7 @@ extends <a href="../../../../org/apache/juneau/parser/ParserContext.html" title= <ul class="blockListLast"> <li class="blockList"> <h4>asMap</h4> -<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvParserContext.html#line.50">asMap</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvParserContext.html#line.55">asMap</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/Context.html#asMap--">Context</a></code></span></div> <div class="block">Returns the properties defined on this bean context as a simple map for debugging purposes.</div> <dl>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/content/site/apidocs/org/apache/juneau/csv/CsvParserSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/csv/CsvParserSession.html b/content/site/apidocs/org/apache/juneau/csv/CsvParserSession.html index 3e0eab0..e619137 100644 --- a/content/site/apidocs/org/apache/juneau/csv/CsvParserSession.html +++ b/content/site/apidocs/org/apache/juneau/csv/CsvParserSession.html @@ -123,9 +123,10 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public final class <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.28">CsvParserSession</a> +<pre>public final class <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.29">CsvParserSession</a> extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title="class in org.apache.juneau.parser">ParserSession</a></pre> <div class="block">Session object that lives for the duration of a single use of <a href="../../../../org/apache/juneau/csv/CsvParser.html" title="class in org.apache.juneau.csv"><code>CsvParser</code></a>. + <p> This class is NOT thread safe. It is meant to be discarded after one-time use.</div> </li> @@ -245,7 +246,7 @@ extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title= <ul class="blockListLast"> <li class="blockList"> <h4>CsvParserSession</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.55">CsvParserSession</a>(<a href="../../../../org/apache/juneau/csv/CsvParserContext.html" title="class in org.apache.juneau.csv">CsvParserContext</a> ctx, +<pre>public <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.61">CsvParserSession</a>(<a href="../../../../org/apache/juneau/csv/CsvParserContext.html" title="class in org.apache.juneau.csv">CsvParserContext</a> ctx, <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> op, <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> input, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> javaMethod, @@ -257,23 +258,23 @@ extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title= <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>ctx</code> - The context creating this session object. - The context contains all the configuration settings for this object.</dd> + The context contains all the configuration settings for this object.</dd> <dd><code>input</code> - The input. Can be any of the following types: - <ul> - <li><jk>null</jk> - <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a> - <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang"><code>CharSequence</code></a> - <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a> containing UTF-8 encoded text. - <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io"><code>File</code></a> containing system encoded text. - </ul></dd> + <ul> + <li><jk>null</jk> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CharSequence.html?is-external=true"; title="class or interface in java.lang"><code>CharSequence</code></a> + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a> containing UTF-8 encoded text. + <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io"><code>File</code></a> containing system encoded text. + </ul></dd> <dd><code>op</code> - The override properties. - These override any context properties defined in the context.</dd> + These override any context properties defined in the context.</dd> <dd><code>javaMethod</code> - The java method that called this parser, usually the method in a REST servlet.</dd> <dd><code>outer</code> - The outer object for instantiating top-level non-static inner classes.</dd> <dd><code>locale</code> - The session locale. - If <jk>null</jk>, then the locale defined on the context is used.</dd> + If <jk>null</jk>, then the locale defined on the context is used.</dd> <dd><code>timeZone</code> - The session timezone. - If <jk>null</jk>, then the timezone defined on the context is used.</dd> + If <jk>null</jk>, then the timezone defined on the context is used.</dd> <dd><code>mediaType</code> - The session media type (e.g. <js>"application/json"</js>).</dd> </dl> </li> @@ -292,10 +293,12 @@ extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title= <ul class="blockList"> <li class="blockList"> <h4>getReader</h4> -<pre>public <a href="../../../../org/apache/juneau/parser/ParserReader.html" title="class in org.apache.juneau.parser">ParserReader</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.60">getReader</a>() +<pre>public <a href="../../../../org/apache/juneau/parser/ParserReader.html" title="class in org.apache.juneau.parser">ParserReader</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.66">getReader</a>() throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/parser/ParserSession.html#getReader--">ParserSession</a></code></span></div> <div class="block">Wraps the specified input object inside a reader. + + <p> Subclasses can override this method to implement their own readers.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> @@ -313,8 +316,9 @@ extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title= <ul class="blockList"> <li class="blockList"> <h4>isWhitespace</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.83">isWhitespace</a>(int cp)</pre> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.90">isWhitespace</a>(int cp)</pre> <div class="block">Returns <jk>true</jk> if the specified character is whitespace. + <p> The definition of whitespace is different for strict vs lax mode. Strict mode only interprets 0x20 (space), 0x09 (tab), 0x0A (line feed) and 0x0D (carriage return) as whitespace. @@ -333,7 +337,7 @@ extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title= <ul class="blockList"> <li class="blockList"> <h4>isCommentOrWhitespace</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.95">isCommentOrWhitespace</a>(int cp)</pre> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.102">isCommentOrWhitespace</a>(int cp)</pre> <div class="block">Returns <jk>true</jk> if the specified character is whitespace or '/'.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -349,7 +353,7 @@ extends <a href="../../../../org/apache/juneau/parser/ParserSession.html" title= <ul class="blockListLast"> <li class="blockList"> <h4>getLastLocation</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>> <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.104">getLastLocation</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>> <a href="../../../../src-html/org/apache/juneau/csv/CsvParserSession.html#line.111">getLastLocation</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/parser/ParserSession.html#getLastLocation--">ParserSession</a></code></span></div> <div class="block">Returns information used to determine at what location in the parse a failure occurred.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/content/site/apidocs/org/apache/juneau/csv/CsvSerializer.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/csv/CsvSerializer.html b/content/site/apidocs/org/apache/juneau/csv/CsvSerializer.html index 5a257c8..1ae1ee5 100644 --- a/content/site/apidocs/org/apache/juneau/csv/CsvSerializer.html +++ b/content/site/apidocs/org/apache/juneau/csv/CsvSerializer.html @@ -195,8 +195,8 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/csv/CsvSerializer.html#builder--">builder</a></span>()</code> -<div class="block">Creates a new builder class for this object so that a new object can be created - that expands upon the current object's settings.</div> +<div class="block">Creates a new builder class for this object so that a new object can be created that expands upon the current + object's settings.</div> </td> </tr> <tr id="i1" class="rowColor"> @@ -297,8 +297,8 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" <h4>builder</h4> <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializer.html#line.43">builder</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObject.html#builder--">CoreObject</a></code></span></div> -<div class="block">Creates a new builder class for this object so that a new object can be created - that expands upon the current object's settings.</div> +<div class="block">Creates a new builder class for this object so that a new object can be created that expands upon the current + object's settings.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#builder--">builder</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd> @@ -318,15 +318,16 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/Serializer.html#doSerialize-org.apache.juneau.serializer.SerializerSession-java.lang.Object-">Serializer</a></code></span></div> <div class="block">Serializes a POJO to the specified output stream or writer. + <p> This method should NOT close the context object.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../org/apache/juneau/serializer/Serializer.html#doSerialize-org.apache.juneau.serializer.SerializerSession-java.lang.Object-">doSerialize</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer">Serializer</a></code></dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>session</code> - The serializer session object return by <a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession-java.lang.Object-org.apache.juneau.ObjectMap-java.lang.reflect.Method-java.util.Locale-java.util.TimeZone-org.apache.juneau.http.MediaType-org.apache.juneau.UriContext-"><code>Serializer.createSession(Object, ObjectMap, Method, Locale, - TimeZone, MediaType, UriContext)</code></a>. - If <jk>null</jk>, session is created using <a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession-java.lang.Object-"><code>Serializer.createSession(Object)</code></a>.</dd> +<dd><code>session</code> - The serializer session object return by <a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession-java.lang.Object-org.apache.juneau.ObjectMap-java.lang.reflect.Method-java.util.Locale-java.util.TimeZone-org.apache.juneau.http.MediaType-org.apache.juneau.UriContext-"><code>Serializer.createSession(Object, ObjectMap, Method, Locale, TimeZone, + MediaType, UriContext)</code></a>. + If <jk>null</jk>, session is created using <a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession-java.lang.Object-"><code>Serializer.createSession(Object)</code></a>.</dd> <dd><code>o</code> - The object to serialize.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - If thrown from underlying stream, or if the input contains a syntax error or is malformed.</dd>
