polygene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From paulmer...@apache.org
Subject [6/7] polygene-java git commit: json: javadocs
Date Sun, 23 Apr 2017 11:07:36 GMT
json: javadocs


Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo
Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/947ee2dd
Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/947ee2dd
Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/947ee2dd

Branch: refs/heads/develop
Commit: 947ee2dda8fe287f57676e2f877dc79aebbc1818
Parents: 9a31a12
Author: Paul Merlin <paulmerlin@apache.org>
Authored: Sun Apr 23 13:06:20 2017 +0200
Committer: Paul Merlin <paulmerlin@apache.org>
Committed: Sun Apr 23 13:06:20 2017 +0200

----------------------------------------------------------------------
 .../javaxjson/JavaxJsonFactories.java           | 45 +++++++++++++++++---
 1 file changed, 39 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/polygene-java/blob/947ee2dd/core/spi/src/main/java/org/apache/polygene/serialization/javaxjson/JavaxJsonFactories.java
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/apache/polygene/serialization/javaxjson/JavaxJsonFactories.java
b/core/spi/src/main/java/org/apache/polygene/serialization/javaxjson/JavaxJsonFactories.java
index 83eca3c..e691802 100644
--- a/core/spi/src/main/java/org/apache/polygene/serialization/javaxjson/JavaxJsonFactories.java
+++ b/core/spi/src/main/java/org/apache/polygene/serialization/javaxjson/JavaxJsonFactories.java
@@ -51,16 +51,55 @@ public interface JavaxJsonFactories
 
     JsonWriterFactory writerFactory();
 
+    /**
+     * Creates a {@link JsonString} with the {@link Object#toString()} result on the given
object.
+     *
+     * @param object the object
+     * @return the JsonString
+     */
     JsonString toJsonString( Object object );
 
+    /**
+     * Creates a {@link JsonObjectBuilder} populated with the state of a {@link JsonObject}.
+     *
+     * @param jsonObject the JsonObject
+     * @return the builder
+     */
     JsonObjectBuilder cloneBuilder( JsonObject jsonObject );
 
+    /**
+     * Creates a {@link JsonObjectBuilder} populated with the state of a {@link JsonObject},
including only some keys.
+     *
+     * @param jsonObject the JsonObject
+     * @param keys the keys to include
+     * @return the builder
+     */
     JsonObjectBuilder cloneBuilderInclude( JsonObject jsonObject, String... keys );
 
+    /**
+     * Creates a {@link JsonObjectBuilder} populated with the state of a {@link JsonObject},
excluding some keys.
+     *
+     * @param jsonObject the JsonObject
+     * @param keys the keys to exclude
+     * @return the builder
+     */
     JsonObjectBuilder cloneBuilderExclude( JsonObject jsonObject, String... keys );
 
+    /**
+     * Creates a {@link JsonArrayBuilder} populated with the state of a {@link JsonArray}.
+     *
+     * @param jsonArray the JsonArray
+     * @return the builder
+     */
     JsonArrayBuilder cloneBuilder( JsonArray jsonArray );
 
+    /**
+     * Creates a {@link JsonArrayBuilder} populated with the state of a {@link JsonArray},
excluding some values.
+     *
+     * @param jsonArray the JsonArray
+     * @param values the values to exclude
+     * @return the builder
+     */
     JsonArrayBuilder cloneBuilderExclude( JsonArray jsonArray, JsonValue... values );
 
     class Mixin implements JavaxJsonFactories, Initializable
@@ -188,12 +227,6 @@ public interface JavaxJsonFactories
             return builder;
         }
 
-        /**
-         * Create a {@link JsonArrayBuilder} populated with the state of a {@link JsonArray}.
-         *
-         * @param jsonArray the JsonArray
-         * @return the builder
-         */
         @Override
         public JsonArrayBuilder cloneBuilder( JsonArray jsonArray )
         {


Mime
View raw message