Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 3875E200C75 for ; Sun, 21 May 2017 11:03:32 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 36EE7160BA4; Sun, 21 May 2017 09:03:32 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id DF066160BC5 for ; Sun, 21 May 2017 11:03:29 +0200 (CEST) Received: (qmail 60190 invoked by uid 500); 21 May 2017 09:03:29 -0000 Mailing-List: contact commits-help@juneau.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@juneau.incubator.apache.org Delivered-To: mailing list commits@juneau.incubator.apache.org Received: (qmail 60181 invoked by uid 99); 21 May 2017 09:03:29 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd3-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 21 May 2017 09:03:29 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd3-us-west.apache.org (ASF Mail Server at spamd3-us-west.apache.org) with ESMTP id 9912E190D50 for ; Sun, 21 May 2017 09:03:28 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd3-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.222 X-Spam-Level: X-Spam-Status: No, score=-4.222 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd3-us-west.apache.org [10.40.0.10]) (amavisd-new, port 10024) with ESMTP id CW3CHHPUtHBL for ; Sun, 21 May 2017 09:03:13 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with SMTP id E65CB60E0B for ; Sun, 21 May 2017 09:02:55 +0000 (UTC) Received: (qmail 58755 invoked by uid 99); 21 May 2017 09:02:54 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 21 May 2017 09:02:54 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id E01D2E027A; Sun, 21 May 2017 09:02:54 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: jamesbognar@apache.org To: commits@juneau.incubator.apache.org Date: Sun, 21 May 2017 09:03:17 -0000 Message-Id: <7056633bc8944709ae21f1276f439425@git.apache.org> In-Reply-To: <6dc95b04bfeb4505a2151912cca6628b@git.apache.org> References: <6dc95b04bfeb4505a2151912cca6628b@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [24/39] incubator-juneau-website git commit: Javadoc updates. archived-at: Sun, 21 May 2017 09:03:32 -0000 http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/org/apache/juneau/serializer/SerializerWriter.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/serializer/SerializerWriter.html b/content/site/apidocs/org/apache/juneau/serializer/SerializerWriter.html index a9a7c71..b610721 100644 --- a/content/site/apidocs/org/apache/juneau/serializer/SerializerWriter.html +++ b/content/site/apidocs/org/apache/juneau/serializer/SerializerWriter.html @@ -121,7 +121,7 @@ var activeTableTab = "activeTableTab";

-
public class SerializerWriter
+
public class SerializerWriter
 extends Writer

 
Simple wrapper around a standard Writer with additional methods.
  

@@ -181,6 +181,12 @@ extends 
+protected UriContext
+uriContext
+
The URI context of the request.

+
+
+
 protected boolean
 useWhitespace
 
Use-whitespace flag.

@@ -208,12 +214,13 @@ extends Constructor and Description
 
 
-SerializerWriter(Writer out,
+SerializerWriter(Writer out,
                 boolean useWhitespace,
                 boolean trimStrings,
                 char quoteChar,
                 String relativeUriBase,
-                String absolutePathUriBase) 
+                String absolutePathUriBase,
+                UriContext uriContext) 
 
 
 
@@ -385,7 +392,7 @@ extends 
 
  • 
 
    out
    
-
    protected final Writer out
    
+
    protected final Writer out
    
 
    The underlying writer.
    
 
    • 
 
@@ -395,7 +402,7 @@ extends 
 
  • 
 
    useWhitespace
    
-
    protected final boolean useWhitespace
    
+
    protected final boolean useWhitespace
    
 
    Use-whitespace flag.
    
 
    • 
 
@@ -405,7 +412,7 @@ extends 
 
  • 
 
    trimStrings
    
-
    protected final boolean trimStrings
    
+
    protected final boolean trimStrings
    
 
    Trim strings flag.
    
 
    • 
 
@@ -415,7 +422,7 @@ extends 
 
  • 
 
    quoteChar
    
-
    protected final char quoteChar
    
+
    protected final char quoteChar
    
 
    The quote character being used by this writer.
    
 
    • 
 
@@ -425,20 +432,30 @@ extends 
 
  • 
 
    relativeUriBase
    
-
    protected final String relativeUriBase
    
+
    protected final String relativeUriBase
    
 
    The base (e.g. https://localhost:9443/contextPath") for relative URIs (e.g. "my/path").
    
 
    • 
 
 
 
 
-
      
+
+
+
+
+
        
+
      • 
+
        uriContext
        
+
        protected final UriContext uriContext
        
+
        The URI context of the request. (i.e. the REST request URL broken down into authority/context/servlet/pathInfo parts.
        
+
        • 
+
      
 
 
    
 
@@ -447,26 +464,30 @@ extends 
+
 
 
 
      
 
    • 
 
      SerializerWriter
      
-
      public SerializerWriter(Writer out,
+
      public SerializerWriter(Writer out,
                         boolean useWhitespace,
                         boolean trimStrings,
                         char quoteChar,
                         String relativeUriBase,
-                        String absolutePathUriBase)
      
+                        String absolutePathUriBase,
+                        UriContext uriContext)
      
 
      
 
      Parameters:
      
 
      out - The writer being wrapped.
      
-
      useWhitespace - If true, calling cr(int) will create an indentation and calling s() will write a space character.
      
+
      useWhitespace - If true, calling cr(int) will create an indentation and calling
+   s() will write a space character.
      
 
      trimStrings - If true, strings should be trimmed before they're serialized.
      
 
      quoteChar - The character to write when q() is called.
      
 
      relativeUriBase - The base (e.g. https://localhost:9443/contextPath") for relative URIs (e.g. "my/path").
      
 
      absolutePathUriBase - The base (e.g. https://localhost:9443") for relative URIs with absolute paths (e.g. "/contextPath/my/path").
      
+
      uriContext - The URI context.
+   Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
      
 
      
 
      • 
 
    
@@ -484,7 +505,7 @@ extends 
 
  • 
 
    cr
    
-
    public SerializerWriter cr(int depth)
+
    public SerializerWriter cr(int depth)
                     throws IOException
    
 
    Performs a carriage return.
  
    
@@ -505,7 +526,7 @@ extends 
 
  • 
 
    appendln
    
-
    public SerializerWriter appendln(int indent,
+
    public SerializerWriter appendln(int indent,
                                  String text)
                           throws IOException
    
 
    Writes an indent (if the useWhitespace setting is enabled), followed by text,
@@ -527,7 +548,7 @@ extends 
 
  • 
 
    appendln
    
-
    public SerializerWriter appendln(String text)
+
    public SerializerWriter appendln(String text)
                           throws IOException
    
 
    Writes the specified text followed by a newline (if the useWhitespace setting is enabled).
    
 
    
@@ -546,7 +567,7 @@ extends 
 
  • 
 
    append
    
-
    public SerializerWriter append(int indent,
+
    public SerializerWriter append(int indent,
                                String text)
                         throws IOException
    
 
    Writes an indent (if the useWhitespace setting is enabled), followed by text.
    
@@ -567,7 +588,7 @@ extends 
 
  • 
 
    append
    
-
    public SerializerWriter append(int indent,
+
    public SerializerWriter append(int indent,
                                char c)
                         throws IOException
    
 
    Writes an indent (if the useWhitespace setting is enabled), followed by text.
    
@@ -588,7 +609,7 @@ extends 
 
  • 
 
    appendUri
    
-
    public SerializerWriter appendUri(Object uri)
+
    public SerializerWriter appendUri(Object uri)
                            throws IOException
    
 
    Appends the specified object as a URI.
  
    
@@ -616,7 +637,7 @@ extends 
 
  • 
 
    append
    
-
    public SerializerWriter append(char[] characters)
+
    public SerializerWriter append(char[] characters)
                         throws IOException
    
 
    Appends the specified characters to this writer.
    
 
    
@@ -635,7 +656,7 @@ extends 
 
  • 
 
    s
    
-
    public SerializerWriter s()
+
    public SerializerWriter s()
                    throws IOException
    
 
    Adds a whitespace character to the output if the useWhitespace setting is enabled.
    
 
    
@@ -652,7 +673,7 @@ extends 
 
  • 
 
    q
    
-
    public SerializerWriter q()
+
    public SerializerWriter q()
                    throws IOException
    
 
    Adds the quote character specified by the quoteChar setting to the output.
    
 
    
@@ -669,7 +690,7 @@ extends 
 
  • 
 
    i
    
-
    public SerializerWriter i(int indent)
+
    public SerializerWriter i(int indent)
                    throws IOException
    
 
    Writes an indent to the writer if the useWhitespace setting is enabled.
    
 
    
@@ -688,7 +709,7 @@ extends 
 
  • 
 
    nl
    
-
    public SerializerWriter nl()
+
    public SerializerWriter nl()
                     throws IOException
    
 
    Writes a newline to the writer if the useWhitespace setting is enabled.
    
 
    
@@ -705,7 +726,7 @@ extends 
 
  • 
 
    nlIf
    
-
    public SerializerWriter nlIf(boolean b)
+
    public SerializerWriter nlIf(boolean b)
                       throws IOException
    
 
    Writes a newline to the writer if the useWhitespace setting is enabled and the boolean flag is true.
    
 
    
@@ -724,7 +745,7 @@ extends 
 
  • 
 
    append
    
-
    public SerializerWriter append(Object text)
+
    public SerializerWriter append(Object text)
                         throws IOException
    
 
    Writes the specified text to the writer.
    
 
    
@@ -743,7 +764,7 @@ extends 
 
  • 
 
    append
    
-
    public SerializerWriter append(String text)
+
    public SerializerWriter append(String text)
                         throws IOException
    
 
    Writes the specified text to the writer.
    
 
    
@@ -762,7 +783,7 @@ extends 
 
  • 
 
    appendIf
    
-
    public SerializerWriter appendIf(boolean b,
+
    public SerializerWriter appendIf(boolean b,
                                  String text)
                           throws IOException
    
 
    Writes the specified text to the writer if b is true.
    
@@ -783,7 +804,7 @@ extends 
 
  • 
 
    appendIf
    
-
    public SerializerWriter appendIf(boolean b,
+
    public SerializerWriter appendIf(boolean b,
                                  char c)
                           throws IOException
    
 
    Writes the specified text to the writer if b is true.
    
@@ -804,7 +825,7 @@ extends 
 
  • 
 
    append
    
-
    public SerializerWriter append(char c)
+
    public SerializerWriter append(char c)
                         throws IOException
    
 
    
 
    Specified by:
    
@@ -822,7 +843,7 @@ extends 
 
  • 
 
    write
    
-
    public void write(char[] cbuf,
+
    public void write(char[] cbuf,
                   int off,
                   int len)
            throws IOException
    
@@ -840,7 +861,7 @@ extends 
 
  • 
 
    flush
    
-
    public void flush()
+
    public void flush()
            throws IOException
    
 
    
 
    Specified by:
    
@@ -858,7 +879,7 @@ extends 
 
  • 
 
    close
    
-
    public void close()
+
    public void close()
            throws IOException
    
 
    
 
    Specified by:
    

http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/org/apache/juneau/serializer/WriterSerializer.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/serializer/WriterSerializer.html b/content/site/apidocs/org/apache/juneau/serializer/WriterSerializer.html
index df5ab6e..ce498e3 100644
--- a/content/site/apidocs/org/apache/juneau/serializer/WriterSerializer.html
+++ b/content/site/apidocs/org/apache/juneau/serializer/WriterSerializer.html
@@ -131,7 +131,7 @@ extends 
-   
  • Serializer.createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType)
+   
  • Serializer.createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext)
    
  • Serializer.doSerialize(SerializerSession, Object)
  
 
@@ -232,7 +232,7 @@ extends 
 
 
    Methods inherited from class org.apache.juneau.serializer.Serializer
    
-builder, createSession, createSession, doSerialize, getMediaTypes, getPrimaryMediaType, getResponseContentType, getResponseHeaders, serialize, serialize, toList
    • 
+builder, createSession, createSession, doSerialize, getMediaTypes, getPrimaryMediaType, getResponseContentType, getResponseHeaders, serialize, serialize, toList
    • 
 
 
 
 
 
 
-
+
 
 
 
    
-
    Description copied from class: Serializer
    
+                                          MediaType mediaType,
+                                          UriContext uriContext)
    • 
+
    Description copied from class: Serializer
    
 
    Create the session object that will be passed in to the serialize method.
  
    
  It's up to implementers to decide what the session object looks like, although typically
    it's going to be a subclass of SerializerSession.
    
 
    
 
    Overrides:
    
-
    createSession in class Serializer
    
+
    createSession in class Serializer
    
 
    Parameters:
    
 
    output - The output object.
    
    Character-based serializers can handle the following output class types:
@@ -568,6 +570,8 @@ extends timeZone - The session timezone.
  If null, then the timezone defined on the context is used.
    
 
    mediaType - The session media type (e.g. "application/json").
    
+
    uriContext - The URI context.
+   Identifies the current request URI used for resolution of URIs to absolute or root-relative form.
    
 
    Returns:
    
 
    The new session.
    
 
    
@@ -590,7 +594,7 @@ extends Specified by:
 
    doSerialize in class Serializer
    
 
    Parameters:
    
-
    session - The serializer session object return by Serializer.createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType).
    
+
    session - The serializer session object return by Serializer.createSession(Object, ObjectMap, Method, Locale, TimeZone, MediaType, UriContext).
    
  If null, session is created using Serializer.createSession(Object).
    
 
    o - The object to serialize.
    
 
    Throws:
    

http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/37ddf434/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html b/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
index 52c128d..2e9cf4f 100644
--- a/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
+++ b/content/site/apidocs/org/apache/juneau/uon/UonSerializerContext.html
@@ -233,7 +233,7 @@ extends BeanContext
-_class, createSession, createSession, dumpCacheStats, equals, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getImplClassConstructor, hashCode, hasSameCache, isNotABean, object, resolveClassMeta, string
    • 
+_class, createSession, createSession, dumpCacheStats, equals, getBeanMeta, getBeanRegistry, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getImplClassConstructor, hashCode, hasSameCache, isBean, isNotABean, object, resolveClassMeta, string
    •