Skip to content

Commit a47cd17

Browse files
Publishing javadoc for SpongePowered/Configurate 4.3.0-SNAPSHOT
1 parent f4534b8 commit a47cd17

File tree

5 files changed

+87
-8
lines changed

5 files changed

+87
-8
lines changed

configurate/core/4.3.0-SNAPSHOT/index-all.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2455,6 +2455,8 @@ <h2 class="title" id="I:S">S</h2>
24552455
<div class="block">Serialize the provided value to a supported type, testing against the
24562456
provided predicate.</div>
24572457
</dd>
2458+
<dt><a href="org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html#serialize(java.lang.reflect.AnnotatedType,V,java.util.function.Predicate)" class="member-name-link">serialize(AnnotatedType, V, Predicate&lt;Class&lt;?&gt;&gt;)</a> - Method in class org.spongepowered.configurate.serialize.<a href="org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html" title="class in org.spongepowered.configurate.serialize">ScalarSerializer.Annotated</a></dt>
2459+
<dd>&nbsp;</dd>
24582460
<dt><a href="org/spongepowered/configurate/serialize/ScalarSerializer.html#serialize(java.lang.reflect.Type,T,org.spongepowered.configurate.ConfigurationNode)" class="member-name-link">serialize(Type, T, ConfigurationNode)</a> - Method in class org.spongepowered.configurate.serialize.<a href="org/spongepowered/configurate/serialize/ScalarSerializer.html" title="class in org.spongepowered.configurate.serialize">ScalarSerializer</a></dt>
24592461
<dd>&nbsp;</dd>
24602462
<dt><a href="org/spongepowered/configurate/serialize/TypeSerializer.html#serialize(java.lang.reflect.Type,T,org.spongepowered.configurate.ConfigurationNode)" class="member-name-link">serialize(Type, T, ConfigurationNode)</a> - Method in interface org.spongepowered.configurate.serialize.<a href="org/spongepowered/configurate/serialize/TypeSerializer.html" title="interface in org.spongepowered.configurate.serialize">TypeSerializer</a></dt>
@@ -2468,6 +2470,8 @@ <h2 class="title" id="I:S">S</h2>
24682470
<div class="block">Serialize the provided value to a supported type, testing against the
24692471
provided predicate.</div>
24702472
</dd>
2473+
<dt><a href="org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html#serialize(V,java.util.function.Predicate)" class="member-name-link">serialize(V, Predicate&lt;Class&lt;?&gt;&gt;)</a> - Method in class org.spongepowered.configurate.serialize.<a href="org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html" title="class in org.spongepowered.configurate.serialize">ScalarSerializer.Annotated</a></dt>
2474+
<dd>&nbsp;</dd>
24712475
<dt><a href="org/spongepowered/configurate/ConfigurationOptions.html#serializers()" class="member-name-link">serializers()</a> - Method in class org.spongepowered.configurate.<a href="org/spongepowered/configurate/ConfigurationOptions.html" title="class in org.spongepowered.configurate">ConfigurationOptions</a></dt>
24722476
<dd>
24732477
<div class="block">Gets the <a href="org/spongepowered/configurate/serialize/TypeSerializerCollection.html" title="class in org.spongepowered.configurate.serialize"><code>TypeSerializerCollection</code></a> specified in these options.</div>

configurate/core/4.3.0-SNAPSHOT/member-search-index.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

configurate/core/4.3.0-SNAPSHOT/org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,12 +159,27 @@ <h2>Method Summary</h2>
159159
<div class="block">Given an object of unknown type, attempt to convert it into the given
160160
type.</div>
161161
</div>
162+
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>protected abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
163+
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#serialize(java.lang.reflect.AnnotatedType,V,java.util.function.Predicate)" class="member-name-link">serialize</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedType.html" title="class or interface in java.lang.reflect" class="external-link">AnnotatedType</a>&nbsp;type,
164+
<a href="ScalarSerializer.Annotated.html" title="type parameter in ScalarSerializer.Annotated">V</a>&nbsp;item,
165+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&gt;&nbsp;typeSupported)</code></div>
166+
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
167+
<div class="block">Serialize the provided value to a supported type, testing against the
168+
provided predicate.</div>
169+
</div>
170+
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
171+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serialize(V,java.util.function.Predicate)" class="member-name-link">serialize</a><wbr>(<a href="ScalarSerializer.Annotated.html" title="type parameter in ScalarSerializer.Annotated">V</a>&nbsp;item,
172+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&gt;&nbsp;typeSupported)</code></div>
173+
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
174+
<div class="block">Serialize the provided value to a supported type, testing against the
175+
provided predicate.</div>
176+
</div>
162177
</div>
163178
</div>
164179
</div>
165180
<div class="inherited-list">
166181
<h3 id="methods-inherited-from-class-org.spongepowered.configurate.serialize.ScalarSerializer">Methods inherited from class&nbsp;org.spongepowered.configurate.serialize.<a href="ScalarSerializer.html" title="class in org.spongepowered.configurate.serialize">ScalarSerializer</a></h3>
167-
<code><a href="ScalarSerializer.html#deserialize(java.lang.Object)">deserialize</a>, <a href="ScalarSerializer.html#deserialize(java.lang.reflect.AnnotatedType,org.spongepowered.configurate.ConfigurationNode)">deserialize</a>, <a href="ScalarSerializer.html#deserialize(java.lang.reflect.Type,org.spongepowered.configurate.ConfigurationNode)">deserialize</a>, <a href="ScalarSerializer.html#serialize(java.lang.reflect.AnnotatedType,T,org.spongepowered.configurate.ConfigurationNode)">serialize</a>, <a href="ScalarSerializer.html#serialize(java.lang.reflect.AnnotatedType,T,java.util.function.Predicate)">serialize</a>, <a href="ScalarSerializer.html#serialize(java.lang.reflect.Type,T,org.spongepowered.configurate.ConfigurationNode)">serialize</a>, <a href="ScalarSerializer.html#serialize(T,java.util.function.Predicate)">serialize</a>, <a href="ScalarSerializer.html#serializeToString(T)">serializeToString</a>, <a href="ScalarSerializer.html#tryDeserialize(java.lang.Object)">tryDeserialize</a>, <a href="ScalarSerializer.html#type()">type</a></code></div>
182+
<code><a href="ScalarSerializer.html#deserialize(java.lang.Object)">deserialize</a>, <a href="ScalarSerializer.html#deserialize(java.lang.reflect.AnnotatedType,org.spongepowered.configurate.ConfigurationNode)">deserialize</a>, <a href="ScalarSerializer.html#deserialize(java.lang.reflect.Type,org.spongepowered.configurate.ConfigurationNode)">deserialize</a>, <a href="ScalarSerializer.html#serialize(java.lang.reflect.AnnotatedType,T,org.spongepowered.configurate.ConfigurationNode)">serialize</a>, <a href="ScalarSerializer.html#serialize(java.lang.reflect.Type,T,org.spongepowered.configurate.ConfigurationNode)">serialize</a>, <a href="ScalarSerializer.html#serializeToString(T)">serializeToString</a>, <a href="ScalarSerializer.html#tryDeserialize(java.lang.Object)">tryDeserialize</a>, <a href="ScalarSerializer.html#type()">type</a></code></div>
168183
<div class="inherited-list">
169184
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
170185
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
@@ -266,6 +281,50 @@ <h3>deserialize</h3>
266281
</dl>
267282
</section>
268283
</li>
284+
<li>
285+
<section class="detail" id="serialize(java.lang.reflect.AnnotatedType,V,java.util.function.Predicate)">
286+
<h3 id="serialize(java.lang.reflect.AnnotatedType,java.lang.Object,java.util.function.Predicate)">serialize</h3>
287+
<div class="member-signature"><span class="modifiers">protected abstract</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html#line-314">serialize</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/reflect/AnnotatedType.html" title="class or interface in java.lang.reflect" class="external-link">AnnotatedType</a>&nbsp;type,
288+
<a href="ScalarSerializer.Annotated.html" title="type parameter in ScalarSerializer.Annotated">V</a>&nbsp;item,
289+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&gt;&nbsp;typeSupported)</span></div>
290+
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="ScalarSerializer.html#serialize(java.lang.reflect.AnnotatedType,T,java.util.function.Predicate)">ScalarSerializer</a></code></span></div>
291+
<div class="block">Serialize the provided value to a supported type, testing against the
292+
provided predicate.
293+
294+
<p>Annotated type information is provided for reference.</p></div>
295+
<dl class="notes">
296+
<dt>Overrides:</dt>
297+
<dd><code><a href="ScalarSerializer.html#serialize(java.lang.reflect.AnnotatedType,T,java.util.function.Predicate)">serialize</a></code>&nbsp;in class&nbsp;<code><a href="ScalarSerializer.html" title="class in org.spongepowered.configurate.serialize">ScalarSerializer</a>&lt;<a href="ScalarSerializer.Annotated.html" title="type parameter in ScalarSerializer.Annotated">V</a>&gt;</code></dd>
298+
<dt>Parameters:</dt>
299+
<dd><code>type</code> - the annotated type of the field being serialized</dd>
300+
<dd><code>item</code> - the value to serialize</dd>
301+
<dd><code>typeSupported</code> - a predicate to allow choosing which types are
302+
supported</dd>
303+
<dt>Returns:</dt>
304+
<dd>a serialized form of this object</dd>
305+
</dl>
306+
</section>
307+
</li>
308+
<li>
309+
<section class="detail" id="serialize(V,java.util.function.Predicate)">
310+
<h3 id="serialize(java.lang.Object,java.util.function.Predicate)">serialize</h3>
311+
<div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html#line-317">serialize</a></span><wbr><span class="parameters">(<a href="ScalarSerializer.Annotated.html" title="type parameter in ScalarSerializer.Annotated">V</a>&nbsp;item,
312+
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Predicate.html" title="class or interface in java.util.function" class="external-link">Predicate</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;&gt;&nbsp;typeSupported)</span></div>
313+
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="ScalarSerializer.html#serialize(T,java.util.function.Predicate)">ScalarSerializer</a></code></span></div>
314+
<div class="block">Serialize the provided value to a supported type, testing against the
315+
provided predicate.</div>
316+
<dl class="notes">
317+
<dt>Specified by:</dt>
318+
<dd><code><a href="ScalarSerializer.html#serialize(T,java.util.function.Predicate)">serialize</a></code>&nbsp;in class&nbsp;<code><a href="ScalarSerializer.html" title="class in org.spongepowered.configurate.serialize">ScalarSerializer</a>&lt;<a href="ScalarSerializer.Annotated.html" title="type parameter in ScalarSerializer.Annotated">V</a>&gt;</code></dd>
319+
<dt>Parameters:</dt>
320+
<dd><code>item</code> - the value to serialize</dd>
321+
<dd><code>typeSupported</code> - a predicate to allow choosing which types are
322+
supported</dd>
323+
<dt>Returns:</dt>
324+
<dd>a serialized form of this object</dd>
325+
</dl>
326+
</section>
327+
</li>
269328
</ul>
270329
</section>
271330
</li>

configurate/core/4.3.0-SNAPSHOT/src-html/org/spongepowered/configurate/serialize/ScalarSerializer.Annotated.html

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -324,9 +324,17 @@
324324
<span class="source-line-no">311</span><span id="line-311"> return this.deserialize(GenericTypeReflector.annotate(type), obj);</span>
325325
<span class="source-line-no">312</span><span id="line-312"> }</span>
326326
<span class="source-line-no">313</span><span id="line-313"></span>
327-
<span class="source-line-no">314</span><span id="line-314"> }</span>
328-
<span class="source-line-no">315</span><span id="line-315"></span>
329-
<span class="source-line-no">316</span><span id="line-316">}</span>
327+
<span class="source-line-no">314</span><span id="line-314"> @Override</span>
328+
<span class="source-line-no">315</span><span id="line-315"> protected abstract Object serialize(AnnotatedType type, V item, Predicate&lt;Class&lt;?&gt;&gt; typeSupported);</span>
329+
<span class="source-line-no">316</span><span id="line-316"></span>
330+
<span class="source-line-no">317</span><span id="line-317"> @Override</span>
331+
<span class="source-line-no">318</span><span id="line-318"> protected Object serialize(final V item, final Predicate&lt;Class&lt;?&gt;&gt; typeSupported) {</span>
332+
<span class="source-line-no">319</span><span id="line-319"> return this.serialize(GenericTypeReflector.annotate(item.getClass()), item, typeSupported);</span>
333+
<span class="source-line-no">320</span><span id="line-320"> }</span>
334+
<span class="source-line-no">321</span><span id="line-321"></span>
335+
<span class="source-line-no">322</span><span id="line-322"> }</span>
336+
<span class="source-line-no">323</span><span id="line-323"></span>
337+
<span class="source-line-no">324</span><span id="line-324">}</span>
330338

331339

332340

configurate/core/4.3.0-SNAPSHOT/src-html/org/spongepowered/configurate/serialize/ScalarSerializer.html

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -324,9 +324,17 @@
324324
<span class="source-line-no">311</span><span id="line-311"> return this.deserialize(GenericTypeReflector.annotate(type), obj);</span>
325325
<span class="source-line-no">312</span><span id="line-312"> }</span>
326326
<span class="source-line-no">313</span><span id="line-313"></span>
327-
<span class="source-line-no">314</span><span id="line-314"> }</span>
328-
<span class="source-line-no">315</span><span id="line-315"></span>
329-
<span class="source-line-no">316</span><span id="line-316">}</span>
327+
<span class="source-line-no">314</span><span id="line-314"> @Override</span>
328+
<span class="source-line-no">315</span><span id="line-315"> protected abstract Object serialize(AnnotatedType type, V item, Predicate&lt;Class&lt;?&gt;&gt; typeSupported);</span>
329+
<span class="source-line-no">316</span><span id="line-316"></span>
330+
<span class="source-line-no">317</span><span id="line-317"> @Override</span>
331+
<span class="source-line-no">318</span><span id="line-318"> protected Object serialize(final V item, final Predicate&lt;Class&lt;?&gt;&gt; typeSupported) {</span>
332+
<span class="source-line-no">319</span><span id="line-319"> return this.serialize(GenericTypeReflector.annotate(item.getClass()), item, typeSupported);</span>
333+
<span class="source-line-no">320</span><span id="line-320"> }</span>
334+
<span class="source-line-no">321</span><span id="line-321"></span>
335+
<span class="source-line-no">322</span><span id="line-322"> }</span>
336+
<span class="source-line-no">323</span><span id="line-323"></span>
337+
<span class="source-line-no">324</span><span id="line-324">}</span>
330338

331339

332340

0 commit comments

Comments
 (0)