From commits-return-4929-archive-asf-public=cust-asf.ponee.io@juneau.apache.org Mon Jan 15 00:07:03 2018 Return-Path: X-Original-To: archive-asf-public@eu.ponee.io Delivered-To: archive-asf-public@eu.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by mx-eu-01.ponee.io (Postfix) with ESMTP id B705A180651 for ; Mon, 15 Jan 2018 00:07:03 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id A7560160C44; Sun, 14 Jan 2018 23:07:03 +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 CD913160C43 for ; Mon, 15 Jan 2018 00:07:01 +0100 (CET) Received: (qmail 74389 invoked by uid 500); 14 Jan 2018 23:07:01 -0000 Mailing-List: contact commits-help@juneau.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@juneau.apache.org Delivered-To: mailing list commits@juneau.apache.org Received: (qmail 74380 invoked by uid 99); 14 Jan 2018 23:07:01 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 14 Jan 2018 23:07:01 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id 8071A1A1138 for ; Sun, 14 Jan 2018 23:07:00 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -4.231 X-Spam-Level: X-Spam-Status: No, score=-4.231 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, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id crNOjmCDHfv1 for ; Sun, 14 Jan 2018 23:06:50 +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 6D1C85FB4E for ; Sun, 14 Jan 2018 23:06:48 +0000 (UTC) Received: (qmail 74007 invoked by uid 99); 14 Jan 2018 23:06:47 -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, 14 Jan 2018 23:06:47 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id C5645F16B9; Sun, 14 Jan 2018 23:06:45 +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, 14 Jan 2018 23:07:26 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [43/51] [partial] juneau-website git commit: Update javadocs. http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/ObjectMap.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/ObjectMap.html b/content/site/apidocs/org/apache/juneau/ObjectMap.html index 10f8a3a..8a50770 100644 --- a/content/site/apidocs/org/apache/juneau/ObjectMap.html +++ b/content/site/apidocs/org/apache/juneau/ObjectMap.html @@ -134,7 +134,7 @@ var activeTableTab = "activeTableTab"; 
public class ObjectMap
 extends LinkedHashMap<String,Object>
Java implementation of a JSON object. - +

An extension of LinkedHashMap, so all methods available in that class are also available to this class.

@@ -144,20 +144,20 @@ extends Map. It also contains accessor methods for to avoid common typecasting when accessing elements in a list. - +

Example:

// Construct an empty Map Map m = new ObjectMap(); - + // Construct a Map from JSON String json = "{a:'A',b:{c:'C',d:123}}"; m = new ObjectMap(json); - + // Construct a Map using the append method m = new ObjectMap().append("foo","x").append("bar",123) .append("baz",true); - + // Construct a Map from XML generated by XmlSerializer String xml = "<object><a type='string'>A</a><b type='object'><c type='string'>C</c><d type='number'>123</d></b></object>"; m = new ObjectMap(xml, DataFormat.XML); @@ -165,45 +165,45 @@ extends ; m = new ObjectMap(urlParams, DataFormat.URLPARAM); m = (Map)UrlEncodingParser.DEFAULT.parse(Object.class, xml); // Equivalent m = UrlEncodingParser.DEFAULT.parse(Map.class, xml); // Equivalent m = UrlEncodingParser.DEFAULT.parse(ObjectMap.class, xml); // Equivalent - + // Construct JSON from ObjectMap m = new ObjectMap("{foo:'bar'},{baz:[123,true]}"); json = m.toString(); // Produces "{foo:'bar'},{baz:[123,true]}" json = m.toString(JsonSerializer.DEFAULT_CONDENSED); // Equivalent json = JsonSerializer.DEFAULT_CONDENSED.serialize(m); // Equivalent - + // Get a map entry as an Integer m = new ObjectMap("{foo:123}"); Integer i = m.getInt("foo"); i = m.get(Integer.class, "foo"); // Equivalent - + // Get a map entry as a Float m = new ObjectMap("{foo:123}"); Float f = m.getFloat("foo"); f = m.get(Float.class, "foo"); // Equivalent - + // Same as above, except converted to a String m = new ObjectMap("{foo:123}"); String s = m.getString("foo"); // Returns "123" s = m.get(String.class, "foo"); // Equivalent - + // Get one of the entries in the list as a bean (converted to a bean if it isn't already one) m = new ObjectMap("{person:{name:'John Smith',age:45}}"); Person p = m.get(Person.class, "person"); - + // Add an inner map ObjectMap m1 = new ObjectMap("{a:1}"); ObjectMap m2 = new ObjectMap("{b:2}").setInner(m1); int a = m2.getInt("a"); // a == 1

- +

This class is not thread safe.

@@ -948,14 +948,14 @@ extends ObjectMap setInner(Map<String,Object> inner)
Set an inner map in this map to allow for chained get calls. - +

If get(Object) returns null, then get(Object) will be called on the inner map. - +

In addition to providing the ability to chain maps, this method also provides the ability to wrap an existing map inside another map so that you can add entries to the outer map without affecting the values on the inner map. - +

ObjectMap m1 = new ObjectMap("{foo:1}"); ObjectMap m2 = new ObjectMap().setInner(m1); @@ -997,10 +997,10 @@ extends ObjectMap setBeanSession(BeanSession session)

Override the default bean session used for converting POJOs. - +

Default is BeanContext.DEFAULT, which is sufficient in most cases. - +

Useful if you're serializing/parsing beans with transforms defined.

@@ -1034,7 +1034,7 @@ extends ObjectMap append(String key, Object value)
Convenience method for adding multiple objects to this map. - +

Equivalent to calling put(key, value), but returns this map so that the method can be chained.

@@ -1054,7 +1054,7 @@ extends ObjectMap appendAll(Map<String,Object> m)
Convenience method for adding a contents of another map to this map. - +

Equivalent to calling putAll(m), but returns this map so that the method can be chained.

@@ -1089,30 +1089,30 @@ extends get(String key, Class<T> type)
Same as get(), but casts or converts the value to the specified class type. - +

This is the preferred get method for simple types. - +

Examples:

ObjectMap m = new ObjectMap("..."); - + // Value converted to a string. String s = m.get("key1", String.class); - + // Value converted to a bean. MyBean b = m.get("key2", MyBean.class); - + // Value converted to a bean array. MyBean[] ba = m.get("key3", MyBean[].class); - + // Value converted to a linked-list of objects. List l = m.get("key4", LinkedList.class); - + // Value converted to a map of object keys/values. Map m2 = m.get("key5", TreeMap.class);

- +

See BeanSession.convertToType(Object, ClassMeta) for the list of valid data conversions.

@@ -1136,42 +1136,42 @@ extends Type type, Type... args)
Same as get(String,Class), but allows for complex data types consisting of collections or maps. - +

The type can be a simple type (e.g. beans, strings, numbers) or parameterized type (collections/maps). - +

Examples:

ObjectMap m = new ObjectMap("..."); - + // Value converted to a linked-list of strings. List<String> l1 = m.get("key1", LinkedList.class, String.class); - + // Value converted to a linked-list of beans. List<MyBean> l2 = m.get("key2", LinkedList.class, MyBean.class); - + // Value converted to a linked-list of linked-lists of strings. List<List<String>> l3 = m.get("key3", LinkedList.class, LinkedList.class, String.class); - + // Value converted to a map of string keys/values. Map<String,String> m1 = m.get("key4", TreeMap.class, String.class, String.class); - + // Value converted to a map containing string keys and values of lists containing beans. Map<String,List<MyBean>> m2 = m.get("key5", TreeMap.class, String.class, List.class, MyBean.class);

- +

Collection classes are assumed to be followed by zero or one objects indicating the element type. - +

Map classes are assumed to be followed by zero or two meta objects indicating the key and value types. - +

The array can be arbitrarily long to indicate arbitrarily complex data structures. - +

See BeanSession.convertToType(Object, ClassMeta) for the list of valid data conversions. - +

Notes:
  • Use the get(String, Class) method instead if you don't need a parameterized map/collection. @@ -1305,10 +1305,10 @@ extends find(Class<T> type, String... keys)
    Returns the value for the first key in the list that has an entry in this map. - +

    Casts or converts the value to the specified class type. - +

    See BeanSession.convertToType(Object, ClassMeta) for the list of valid data conversions.

    @@ -1332,21 +1332,21 @@ extends Class<T> type)
    Same as get(String,Class), but the key is a slash-delimited path used to traverse entries in this POJO. - +

    For example, the following code is equivalent:

    ObjectMap m = getObjectMap(); - + // Long way long l = m.getObjectMap("foo").getObjectList("bar").getObjectMap("0") .getLong("baz"); - + // Using this method long l = m.getAt("foo/bar/0/baz", long.class);

    - +

    This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

    @@ -1371,7 +1371,7 @@ extends Type type, Type... args)
    Same as getAt(String,Class), but allows for conversion to complex maps and collections. - +

    This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

    @@ -1397,21 +1397,21 @@ extends Object o)
    Same as put(String,Object), but the key is a slash-delimited path used to traverse entries in this POJO. - +

    For example, the following code is equivalent:

    ObjectMap m = getObjectMap(); - + // Long way m.getObjectMap("foo").getObjectList("bar").getObjectMap("0") .put("baz", 123); - + // Using this method m.putAt("foo/bar/0/baz", 123);

    - +

    This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

    @@ -1433,20 +1433,20 @@ extends Object postAt(String path, Object o)
    Similar to putAt(String,Object), but used to append to collections and arrays. - +

    For example, the following code is equivalent:

    ObjectMap m = getObjectMap(); - + // Long way m.getObjectMap("foo").getObjectList("bar").append(123); - + // Using this method m.postAt("foo/bar", 123);

    - +

    This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

    @@ -1468,20 +1468,20 @@ extends Object deleteAt(String path)
    Similar to remove(Object), but the key is a slash-delimited path used to traverse entries in this POJO. - +

    For example, the following code is equivalent:

    ObjectMap m = getObjectMap(); - + // Long way m.getObjectMap("foo").getObjectList("bar").getObjectMap(0).remove("baz"); - + // Using this method m.deleteAt("foo/bar/0/baz");

    - +

    This method uses the PojoRest class to perform the lookup, so the map can contain any of the various class types that the PojoRest class supports (e.g. beans, collections, arrays).

    @@ -1503,7 +1503,7 @@ extends String json) throws ParseException
    Convenience method for inserting JSON directly into an attribute on this object. - +

    The JSON text can be an object (i.e. "{...}") or an array (i.e. "[...]").

    @@ -1523,7 +1523,7 @@ extends String getString(String key)
    Returns the specified entry value converted to a String. - +

    Shortcut for get(key, String.class).

    @@ -1542,7 +1542,7 @@ extends String[] getStringArray(String key)
    Returns the specified entry value converted to a String. - +

    Shortcut for get(key, String[].class).

    @@ -1580,7 +1580,7 @@ extends String getString(String key, String defVal)
    Returns the specified entry value converted to a String. - +

    Shortcut for getWithDefault(key, defVal, String.class).

    @@ -1600,7 +1600,7 @@ extends Integer getInt(String key)
    Returns the specified entry value converted to an Integer. - +

    Shortcut for get(key, Integer.class).

    @@ -1622,7 +1622,7 @@ extends Integer getInt(String key, Integer defVal)
    Returns the specified entry value converted to an Integer. - +

    Shortcut for getWithDefault(key, defVal, Integer.class).

    @@ -1644,7 +1644,7 @@ extends Long getLong(String key)
    Returns the specified entry value converted to a Long. - +

    Shortcut for get(key, Long.class).

    @@ -1666,7 +1666,7 @@ extends Long getLong(String key, Long defVal)
    Returns the specified entry value converted to a Long. - +

    Shortcut for getWithDefault(key, defVal, Long.class).

    @@ -1688,7 +1688,7 @@ extends Boolean getBoolean(String key)
    Returns the specified entry value converted to a Boolean. - +

    Shortcut for get(key, Boolean.class).

    @@ -1710,7 +1710,7 @@ extends Boolean getBoolean(String key, Boolean defVal)
    Returns the specified entry value converted to a Boolean. - +

    Shortcut for getWithDefault(key, defVal, Boolean.class).

    @@ -1732,7 +1732,7 @@ extends Map<?,?> getMap(String key)
    Returns the specified entry value converted to a Map. - +

    Shortcut for get(key, Map.class).

    @@ -1754,7 +1754,7 @@ extends Map<?,?> getMap(String key, Map<?,?> defVal)
    Returns the specified entry value converted to a Map. - +

    Shortcut for getWithDefault(key, defVal, Map.class).

    @@ -1800,7 +1800,7 @@ extends List<?> getList(String key)
    Returns the specified entry value converted to a List. - +

    Shortcut for get(key, List.class).

    @@ -1822,7 +1822,7 @@ extends List<?> getList(String key, List<?> defVal)
    Returns the specified entry value converted to a List. - +

    Shortcut for getWithDefault(key, defVal, List.class).

    @@ -1866,7 +1866,7 @@ extends ObjectMap getObjectMap(String key)
    Returns the specified entry value converted to a Map. - +

    Shortcut for get(key, ObjectMap.class).

    @@ -1888,7 +1888,7 @@ extends ObjectMap getObjectMap(String key, ObjectMap defVal)
    Returns the specified entry value converted to a ObjectMap. - +

    Shortcut for getWithDefault(key, defVal, ObjectMap.class).

    @@ -1910,7 +1910,7 @@ extends ObjectList getObjectList(String key)
    Returns the specified entry value converted to a ObjectList. - +

    Shortcut for get(key, ObjectList.class).

    @@ -1932,7 +1932,7 @@ extends ObjectList getObjectList(String key, ObjectList defVal)
    Returns the specified entry value converted to a ObjectList. - +

    Shortcut for getWithDefault(key, defVal, ObjectList.class).

    @@ -1954,7 +1954,7 @@ extends String findString(String... keys)
    Returns the first entry that exists converted to a String. - +

    Shortcut for find(String.class, keys).

    @@ -1974,7 +1974,7 @@ extends Integer findInt(String... keys)
    Returns the first entry that exists converted to an Integer. - +

    Shortcut for find(Integer.class, keys).

    @@ -1996,7 +1996,7 @@ extends Long findLong(String... keys)
    Returns the first entry that exists converted to a Long. - +

    Shortcut for find(Long.class, keys).

    @@ -2018,7 +2018,7 @@ extends Boolean findBoolean(String... keys)
    Returns the first entry that exists converted to a Boolean. - +

    Shortcut for find(Boolean.class, keys).

    @@ -2040,7 +2040,7 @@ extends Map<?,?> findMap(String... keys)
    Returns the first entry that exists converted to a Map. - +

    Shortcut for find(Map.class, keys).

    @@ -2062,7 +2062,7 @@ extends List<?> findList(String... keys)
    Returns the first entry that exists converted to a List. - +

    Shortcut for find(List.class, keys).

    @@ -2084,7 +2084,7 @@ extends ObjectMap findObjectMap(String... keys)
    Returns the first entry that exists converted to a ObjectMap. - +

    Shortcut for find(ObjectMap.class, keys).

    @@ -2106,7 +2106,7 @@ extends ObjectList findObjectList(String... keys)
    Returns the first entry that exists converted to a ObjectList. - +

    Shortcut for find(ObjectList.class, keys).

    @@ -2311,7 +2311,7 @@ extends cast(Class<T> type)
    Converts this map into an object of the specified type. - +

    If this map contains a "_type" entry, it must be the same as or a subclass of the type.

    http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/PropertyNamer.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/PropertyNamer.html b/content/site/apidocs/org/apache/juneau/PropertyNamer.html index fb62c17..2cf679a 100644 --- a/content/site/apidocs/org/apache/juneau/PropertyNamer.html +++ b/content/site/apidocs/org/apache/juneau/PropertyNamer.html @@ -106,13 +106,13 @@ var activeTableTab = "activeTableTab"; 
    public interface PropertyNamer
    Defines an API for converting conventional bean property names to some other form. - +

    For example, given the bean property "fooBarURL", the PropertyNamerDLC property namer will convert this to "foo-bar-url". - +

    - Property namers are associated with beans through the Bean.propertyNamer() annotation.

    + Property namers are associated with beans through the @Bean.propertyNamer() annotation.
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/PropertyNamerDLC.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/PropertyNamerDLC.html b/content/site/apidocs/org/apache/juneau/PropertyNamerDLC.html index 6f98bd0..06652c1 100644 --- a/content/site/apidocs/org/apache/juneau/PropertyNamerDLC.html +++ b/content/site/apidocs/org/apache/juneau/PropertyNamerDLC.html @@ -116,8 +116,8 @@ var activeTableTab = "activeTableTab"; extends Object implements PropertyNamer
Converts property names to dashed-lower-case format. - -
Examples:
+ +
Example:
  • "fooBar" -> "foo-bar"
  • "fooBarURL" -> "foo-bar-url" http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html b/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html index 829f727..c665384 100644 --- a/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html +++ b/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html @@ -116,15 +116,15 @@ var activeTableTab = "activeTableTab"; extends Object implements PropertyNamer
    Default property namer. - -
    Examples:
    + +
    Example:
    • "fooBar" -> "fooBar"
    • "fooBarURL" -> "fooBarURL"
    • "FooBarURL" -> "fooBarURL"
    • "URL" -> "URL"
    - +

    See Introspector.decapitalize(String) for exact rules.

    • http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/PropertyNamerULC.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/PropertyNamerULC.html b/content/site/apidocs/org/apache/juneau/PropertyNamerULC.html index 959f513..1b42bb9 100644 --- a/content/site/apidocs/org/apache/juneau/PropertyNamerULC.html +++ b/content/site/apidocs/org/apache/juneau/PropertyNamerULC.html @@ -116,8 +116,8 @@ var activeTableTab = "activeTableTab"; extends Object implements PropertyNamer
    Converts property names to underscore-lower-case format. - -
    Examples:
    + +
    Example:
    • "fooBar" -> "foo_bar"
    • "fooBarURL" -> "foo_bar_url"