Skip to content

Commit

Permalink
Minor clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
@cyberphone
cyberphone committed Aug 2, 2019
1 parent d3e64bd commit 43a7231
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 19 deletions.
4 changes: 2 additions & 2 deletions openkeystore/javaapi/index-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2175,7 +2175,7 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Read a Money property.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/webpki/json/JSONObjectReader.html#getMoney-java.lang.String-java.lang.Integer-">getMoney(String, Integer)</a></span> - Method in class org.webpki.json.<a href="org/webpki/json/JSONObjectReader.html" title="class in org.webpki.json">JSONObjectReader</a></dt>
<dt><span class="memberNameLink"><a href="org/webpki/json/JSONObjectReader.html#getMoney-java.lang.String-int-">getMoney(String, int)</a></span> - Method in class org.webpki.json.<a href="org/webpki/json/JSONObjectReader.html" title="class in org.webpki.json">JSONObjectReader</a></dt>
<dd>
<div class="block">Read a Money property.</div>
</dd>
Expand Down Expand Up @@ -4765,7 +4765,7 @@ <h2 class="title">S</h2>
<dd>
<div class="block">Set a <code>Money</code> property.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-java.lang.Integer-">setMoney(String, BigDecimal, Integer)</a></span> - Method in class org.webpki.json.<a href="org/webpki/json/JSONObjectWriter.html" title="class in org.webpki.json">JSONObjectWriter</a></dt>
<dt><span class="memberNameLink"><a href="org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-int-">setMoney(String, BigDecimal, int)</a></span> - Method in class org.webpki.json.<a href="org/webpki/json/JSONObjectWriter.html" title="class in org.webpki.json">JSONObjectWriter</a></dt>
<dd>
<div class="block">Set a <code>Money</code> property.</div>
</dd>
Expand Down
13 changes: 6 additions & 7 deletions openkeystore/javaapi/org/webpki/json/JSONObjectReader.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -333,8 +333,8 @@ <h3>Method Summary</h3>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/webpki/json/JSONObjectReader.html#getMoney-java.lang.String-java.lang.Integer-">getMoney</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;decimals)</code>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/webpki/json/JSONObjectReader.html#getMoney-java.lang.String-int-">getMoney</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;decimals)</code>
<div class="block">Read a Money property.</div>
</td>
</tr>
Expand Down Expand Up @@ -1035,8 +1035,7 @@ <h4>getMoney</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;getMoney(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Read a Money property.<p>
Note: Since JSON does not support a native Money type, this method builds on <i>mapping</i>.</p>
Note: This method is equivalent to <code>getMoney(name, null)</code>.</div>
Note: Since JSON does not support a native Money type, this method builds on <i>mapping</i>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Property</dd>
Expand All @@ -1049,14 +1048,14 @@ <h4>getMoney</h4>
</dl>
</li>
</ul>
<a name="getMoney-java.lang.String-java.lang.Integer-">
<a name="getMoney-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMoney</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;getMoney(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;decimals)
int&nbsp;decimals)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Read a Money property.<p>
Note: Since JSON does not support a native Money type, this method builds on <i>mapping</i>.</p></div>
Expand All @@ -1069,7 +1068,7 @@ <h4>getMoney</h4>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - &nbsp;</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-java.lang.Integer-"><code>JSONObjectWriter.setMoney(String, BigDecimal, Integer)</code></a></dd>
<dd><a href="../../../org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-int-"><code>JSONObjectWriter.setMoney(String, BigDecimal, int)</code></a></dd>
</dl>
</li>
</ul>
Expand Down
24 changes: 16 additions & 8 deletions openkeystore/javaapi/org/webpki/json/JSONObjectWriter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -366,9 +366,9 @@ <h3>Method Summary</h3>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../org/webpki/json/JSONObjectWriter.html" title="class in org.webpki.json">JSONObjectWriter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-java.lang.Integer-">setMoney</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-int-">setMoney</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;decimals)</code>
int&nbsp;decimals)</code>
<div class="block">Set a <code>Money</code> property.</div>
</td>
</tr>
Expand Down Expand Up @@ -1073,10 +1073,12 @@ <h4>setMoney</h4>
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;value)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Set a <code>Money</code> property.<p>
Note: this is a <i>mapped</i> type since there is no <code>Money</code> type in JSON.</p><p>
Note: this is a <i>mapped</i> type since there is no <code>Money</code> type in JSON.</p>
<p>Specification: <a href="https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value"
target="_blank">https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value</a>.</p>
Sample:
<pre>
"amount": "568790.25"
"amount": "460.25"
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Expand All @@ -1087,22 +1089,28 @@ <h4>setMoney</h4>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - &nbsp;</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-java.lang.Integer-"><code>setMoney(String, BigDecimal, Integer)</code></a></dd>
<dd><a href="../../../org/webpki/json/JSONObjectWriter.html#setMoney-java.lang.String-java.math.BigDecimal-int-"><code>setMoney(String, BigDecimal, int)</code></a></dd>
</dl>
</li>
</ul>
<a name="setMoney-java.lang.String-java.math.BigDecimal-java.lang.Integer-">
<a name="setMoney-java.lang.String-java.math.BigDecimal-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMoney</h4>
<pre>public&nbsp;<a href="../../../org/webpki/json/JSONObjectWriter.html" title="class in org.webpki.json">JSONObjectWriter</a>&nbsp;setMoney(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math">BigDecimal</a>&nbsp;value,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&nbsp;decimals)
int&nbsp;decimals)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Set a <code>Money</code> property.<p>
Note: this is a <i>mapped</i> type since there is no <code>Money</code> type in JSON.</p></div>
Note: this is a <i>mapped</i> type since there is no <code>Money</code> type in JSON.</p>
<p>Specification: <a href="https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value"
target="_blank">https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value</a>.</p>
Sample:
<pre>
"amount": "460.25"
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Property</dd>
Expand Down
Loading

0 comments on commit 43a7231

Please sign in to comment.