You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polygene.apache.org by pa...@apache.org on 2017/03/13 15:28:29 UTC
[06/48] polygene-java git commit: Moar javadocs
Moar javadocs
POLYGENE-231
Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo
Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/70b2871b
Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/70b2871b
Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/70b2871b
Branch: refs/heads/serialization-3.0
Commit: 70b2871b00f502c27c0dde15ca7c4f047023af1b
Parents: 37792b2
Author: Paul Merlin <pa...@apache.org>
Authored: Mon Mar 13 15:12:24 2017 +0100
Committer: Paul Merlin <pa...@apache.org>
Committed: Mon Mar 13 16:27:47 2017 +0100
----------------------------------------------------------------------
.../polygene/api/serialization/package.html | 16 +++++----
.../polygene/spi/serialization/package.html | 35 +++++++++++++++-----
2 files changed, 36 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/polygene-java/blob/70b2871b/core/api/src/main/java/org/apache/polygene/api/serialization/package.html
----------------------------------------------------------------------
diff --git a/core/api/src/main/java/org/apache/polygene/api/serialization/package.html b/core/api/src/main/java/org/apache/polygene/api/serialization/package.html
index 467fc65..9f2886c 100644
--- a/core/api/src/main/java/org/apache/polygene/api/serialization/package.html
+++ b/core/api/src/main/java/org/apache/polygene/api/serialization/package.html
@@ -19,17 +19,21 @@
<body>
<h2>Serialization API.</h2>
<p>
- {@link Serialization} extends {@link Serializer} and {@link Deserializer}.
+ {@link org.apache.polygene.api.serialization.Serialization}
+ extends {@link org.apache.polygene.api.serialization.Serializer}
+ and {@link org.apache.polygene.api.serialization.Deserializer}.
<br/>
- {@link SerializationException} is thrown when something goes wrong.
+ {@link org.apache.polygene.api.serialization.SerializationException}
+ is thrown when something goes wrong.
</p>
<p>
- Serialization implementations should be tagged with {@link Serialization.Format} at assembly time so that consumers
- can specify which format they need:
+ Serialization implementations should be tagged with
+ {@link org.apache.polygene.api.serialization.Serialization.Format}
+ at assembly time so that consumers can specify which format they need:
</p>
<pre><code>@Service @Tagged( Serialization.Format.JSON ) Serialization serialization;</code></pre>
<p>
- {@link Serializer}s and {@link Deserializers} provides methods and functions to (de)serialize objects
+ {@literal Serializer}s and {@literal Deserializer}s provides methods and functions to (de)serialize objects
and set of objects.
</p>
<p>
@@ -37,7 +41,7 @@
Implementations are free to use any codec to encode/decode from/to text and bytes but it must be bi-directional.
</p>
<p>
- The serialization behavior can be influenced using {@link Serializer.Options}.
+ The serialization behavior can be influenced using {@link org.apache.polygene.api.serialization.Serializer.Options}.
</p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/polygene-java/blob/70b2871b/core/spi/src/main/java/org/apache/polygene/spi/serialization/package.html
----------------------------------------------------------------------
diff --git a/core/spi/src/main/java/org/apache/polygene/spi/serialization/package.html b/core/spi/src/main/java/org/apache/polygene/spi/serialization/package.html
index 8078138..8af1964 100644
--- a/core/spi/src/main/java/org/apache/polygene/spi/serialization/package.html
+++ b/core/spi/src/main/java/org/apache/polygene/spi/serialization/package.html
@@ -20,8 +20,8 @@
<h2>Serialization SPI.</h2>
<p>
This package contains specialized serialization APIs for the {@literal JSON} and {@literal XML} formats.
- See {@link @JsonSerialization}, based on {@literal javax.json},
- and {@link XmlSerialization}, based on {@literal javax.xml}.
+ See {@link org.apache.polygene.spi.serialization.JsonSerialization}, based on {@literal javax.json},
+ and {@link org.apache.polygene.spi.serialization.XmlSerialization}, based on {@literal javax.xml}.
</p>
<p>
This package also contains base implementations, mixins and helpers for serialization API implementations:
@@ -29,23 +29,40 @@
<p><strong>Base implementations</strong></p>
<ul>
<li>
- Use {@link AbstractTextSerializer} and {@link AbstractTextDeserializer} as a basis to implement the
- serialization API for text representations.
+ Use {@link org.apache.polygene.spi.serialization.AbstractTextSerializer}
+ and {@link org.apache.polygene.spi.serialization.AbstractTextDeserializer}
+ as a basis to implement the serialization API for text representations.
</li>
<li>
- Use {@link AbstractBinarySerializer} and {@link AbstractBinaryDeserializer} as a basis to implement the
- serialization API for binary representations.
+ Use {@link org.apache.polygene.spi.serialization.AbstractBinarySerializer}
+ and {@link org.apache.polygene.spi.serialization.AbstractBinaryDeserializer}
+ as a basis to implement the serialization API for binary representations.
</li>
<li>
- Use {@link AbstractSerializer} and {@link AbstractDeserializer} if you need to handle text/binary conversion
- yourself.
+ Use {@link org.apache.polygene.spi.serialization.AbstractSerializer}
+ and {@link org.apache.polygene.spi.serialization.AbstractDeserializer}
+ if you need to handle text/binary conversion yourself.
</li>
</ul>
<p>
<strong>Mixins</strong>
</p>
<ul>
- <li>{@link BuiltInConverters} provides built-in {@link Converter}s for types supported by the Polygene Runtime.</li>
+ <li>
+ {@link org.apache.polygene.spi.serialization.BuiltInConverters} provides built-in
+ {@link org.apache.polygene.api.serialization.Converter}s for types supported by the Polygene Runtime.
+ </li>
+</ul>
+<p>
+ <strong>Helpers</strong>
+</p>
+<ul>
+ <li>
+ {@link org.apache.polygene.spi.serialization.SerializationSettings}
+ can be used to register custom Converters at assembly time.
+ Serialization implementations might extend this with additional specialized settings,
+ see their respective documentation for details.
+ </li>
</ul>
</body>
</html>