Fixed javadocs.

Author: atsticks

calc/src/main/java/org/javamoney/calc/CalculationContext.java

@@ -37,12 +37,18 @@ private CalculationContext(){
         init(MathContext.DECIMAL64);
     }
 
+    /**
+     * Math context math context.
+     *
+     * @return the math context
+     */
     public static MathContext mathContext(){
         return instance.mathContext;
     }
 
     /**
      * Accesses the number '1' initialized with the current {@link MathContext}.
+     *
      * @return the number instance, never null.
      */
     public static BigDecimal one() {
@@ -51,6 +57,7 @@ public static BigDecimal one() {
 
     /**
      * Accesses the number '1' initialized with the current {@link MathContext}.
+     *
      * @return the number instance, never null.
      */
     public static BigDecimal zero() {
@@ -59,6 +66,7 @@ public static BigDecimal zero() {
 
     /**
      * Accesses the number '10' initialized with the current {@link MathContext}.
+     *
      * @return the number instance, never null.
      */
     public static BigDecimal ten() {
@@ -67,6 +75,7 @@ public static BigDecimal ten() {
 
     /**
      * Creates the given number initialized with the current {@link MathContext}.
+     *
      * @param num the number instance.
      * @return the number instance, never null.
      */
@@ -76,6 +85,7 @@ public static BigDecimal bigDecimal(long num) {
 
     /**
      * Creates the given number initialized with the current {@link MathContext}.
+     *
      * @param num the number instance.
      * @return the number instance, never null.
      */
@@ -85,6 +95,7 @@ public static BigDecimal bigDecimal(double num) {
 
     /**
      * Creates the given number initialized with the current {@link MathContext}.
+     *
      * @param num the number instance.
      * @return the number instance, never null.
      */
@@ -96,6 +107,7 @@ public static BigDecimal bigDecimal(BigDecimal num) {
     /**
      * This method allows o set the {@link MathContext} used for doing calculations.
      * Not te that this affects all calculations at all stages.
+     *
      * @param mathContext the new match context, not null.
      */
     public static void setMathContext(MathContext mathContext){

calc/src/main/java/org/javamoney/calc/CompositeMonetaryOperator.java

@@ -37,6 +37,11 @@ public class CompositeMonetaryOperator implements MonetaryOperator {
 
     private final List<MonetaryOperator> functions = new ArrayList<>();
 
+    /**
+     * Instantiates a new Composite monetary operator.
+     *
+     * @param operations the operations
+     */
     @SafeVarargs
     public CompositeMonetaryOperator(Iterable<MonetaryOperator>... operations) {
         if (operations != null) {
@@ -48,6 +53,12 @@ public CompositeMonetaryOperator(Iterable<MonetaryOperator>... operations) {
         }
     }
 
+    /**
+     * Instantiates a new Composite monetary operator.
+     *
+     * @param name       the name
+     * @param operations the operations
+     */
     public CompositeMonetaryOperator(String name, MonetaryOperator... operations) {
         Objects.requireNonNull(name);
         Collections.addAll(functions, operations);

calc/src/main/java/org/javamoney/calc/ValidatedAmount.java

@@ -31,7 +31,7 @@
  * <ul>
  * <li>immutable</li>
  * <li>final</li>
- * <li>thread-safe/li>
+ * <li>thread-safe</li>
  * <li>serializable</li>
  * </ul>
  *
@@ -60,9 +60,9 @@ public static MonetaryAmount unsignedAmount(MonetaryAmount amount) {
      * Creates an predicated {@link MonetaryAmount} based on the given
      * {@link MonetaryAmount}.
      *
-     * @param amount The amount to decorated.
-     * @return a predicated instance, that ensures the given predicate is always
-     * ensured on all operations.
+     * @param amount    The amount to decorated.
+     * @param predicate the predicate
+     * @return a predicated instance, that ensures the given predicate is always ensured on all operations.
      */
     public static MonetaryAmount of(MonetaryAmount amount,
                                     Predicate<MonetaryAmount> predicate) {

calc/src/main/java/org/javamoney/calc/ValidatedMoney.java

@@ -54,7 +54,8 @@ final class ValidatedMoney implements
     /**
      * Creates a new wrapper instance.
      *
-     * @param amount the underlying amount, not null and not negative.
+     * @param amount    the underlying amount, not null and not negative.
+     * @param predicate the predicate
      * @throws IllegalArgumentException if the amount passed is negative.
      */
     ValidatedMoney(MonetaryAmount amount,
@@ -74,7 +75,7 @@ final class ValidatedMoney implements
     }
 
     /**
-     * Access an {@link ValidatedMoney} based on the given
+     * Access an ValidatedMoney based on the given
      * {@link MonetaryAmount}.
      * @param predicate the validation function, not null.
      * @param amount the amount to decorate
@@ -406,6 +407,11 @@ private final class ValidatedAmountFactory implements MonetaryAmountFactory<Vali
         private Predicate<MonetaryAmount> predicate;
         private MonetaryAmountFactory<?> factory = Monetary.getDefaultAmountFactory();
 
+        /**
+         * Instantiates a new Validated amount factory.
+         *
+         * @param amount the amount
+         */
         public ValidatedAmountFactory(ValidatedMoney amount){
             this.predicate = amount.predicate;
         }

calc/src/main/java/org/javamoney/calc/banking/AnnualPercentageYield.java

@@ -26,13 +26,10 @@
 import java.util.Objects;
 
 /**
- * <img src= "http://www.financeformulas.net/formulaimages/APY%201.gif" />
- * <p>
  * The Annual Percentage Yield (APY), referenced as the effective annual rate in finance,
  * is the rate of interest that is earned when taking into consideration the effect of
  * compounding.
  *
- *
  * There are various terms used when compounding is not considered including nominal interest
  * rate, stated annual interest rate, and annual percentage rate(APR).
  *
@@ -45,7 +42,7 @@
  *
  * @author Anatole Tresch
  * @author Werner Keil
- * @link http://www.financeformulas.net/Compound_Interest.html
+ * @see <a href="http://www.financeformulas.net/Compound_Interest.html">http://www.financeformulas.net/Compound_Interest.html</a>
  */
 public final class AnnualPercentageYield implements MonetaryOperator {
 
@@ -54,7 +51,7 @@ public final class AnnualPercentageYield implements MonetaryOperator {
      */
     private final Rate rate;
     /**
-     * the periods, >= 0.
+     * the periods, &gt;= 0.
      */
     private final int periods;
 
@@ -63,7 +60,7 @@ public final class AnnualPercentageYield implements MonetaryOperator {
      * Private constructor.
      *
      * @param rate    the target rate, not null.
-     * @param periods the periods, >= 0.
+     * @param periods the periods, &gt;= 0.
      */
     private AnnualPercentageYield(Rate rate, int periods) {
         this.rate = Objects.requireNonNull(rate);
@@ -73,10 +70,20 @@ private AnnualPercentageYield(Rate rate, int periods) {
         this.periods = periods;
     }
 
+    /**
+     * Gets periods.
+     *
+     * @return the periods
+     */
     public int getPeriods() {
         return periods;
     }
 
+    /**
+     * Gets rate.
+     *
+     * @return the rate
+     */
     public Rate getRate() {
         return rate;
     }
@@ -86,7 +93,7 @@ public Rate getRate() {
      * Access a MonetaryOperator for calculation.
      *
      * @param rate    the target rate, not null.
-     * @param periods the periods, >= 0.
+     * @param periods the periods, &gt;= 0.
      * @return the operator, never null.
      */
     public static AnnualPercentageYield of(Rate rate, int periods){
@@ -97,7 +104,7 @@ public static AnnualPercentageYield of(Rate rate, int periods){
      * Performs the calculation.
      *
      * @param rate    the target rate, not null.
-     * @param periods the periods, >= 0.
+     * @param periods the periods, &gt;= 0.
      * @return the resulting amount, never null.
      */
     public static Rate calculate(Rate rate, int periods) {
@@ -116,7 +123,7 @@ public static Rate calculate(Rate rate, int periods) {
      *
      * @param amount  the base amount, not null.
      * @param rate    the target rate, not null.
-     * @param periods the periods, >= 0.
+     * @param periods the periods, &gt;= 0.
      * @return the resulting amount, never null.
      */
     public static MonetaryAmount calculate(MonetaryAmount amount, Rate rate, int periods) {

calc/src/main/java/org/javamoney/calc/banking/BalloonLoanPayment.java

@@ -30,8 +30,6 @@
 import static org.javamoney.calc.CalculationContext.one;
 
 /**
- * <img src= "http://www.financeformulas.net/formulaimages/Balloon%20Loan%20Payment%201.gif" />
- * <p>
  * The balloon loan payment formula is used to calculate the payments on a loan that has a balance
  * remaining after all periodic payments are made. Examples of loans that may use the balloon loan
  * payment formula would be auto leases, balloon mortgages, and any other form of loan not paid
@@ -53,7 +51,7 @@
  *
  * @author Anatole Tresch
  * @author Werner Keil
- * @link http://www.financeformulas.net/Compound_Interest.html
+ * @see <a href="http://www.financeformulas.net/Compound_Interest.html">http://www.financeformulas.net/Compound_Interest.html</a>
  */
 public final class BalloonLoanPayment extends AbstractRateAndPeriodBasedOperator{
 
@@ -84,14 +82,20 @@ private BalloonLoanPayment(RateAndPeriods rateAndPeriods, MonetaryAmount balloon
         this.balloonAmount = Objects.requireNonNull(balloonAmount);
     }
 
+    /**
+     * Get balloon amount monetary amount.
+     *
+     * @return the monetary amount
+     */
     public MonetaryAmount getBalloonAmount(){
         return balloonAmount;
     }
 
     /**
      * Access a MonetaryOperator for calculation.
      *
-     * @param rateAndPeriods    the target rate and periods, not null.
+     * @param rateAndPeriods the target rate and periods, not null.
+     * @param balloonAmount  the balloon amount
      * @return the operator, never null.
      */
     public static BalloonLoanPayment of(RateAndPeriods rateAndPeriods, MonetaryAmount balloonAmount){
@@ -118,9 +122,9 @@ public String toString() {
     /**
      * Performs the calculation.
      *
-     * @param amountPV  the present value, not null.
-     * @param balloonAmount the balloon amount, not null and currency compatible with {@code amountPV}.
-     * @param rateAndPeriods    the target rate and periods, not null.
+     * @param amountPV       the present value, not null.
+     * @param balloonAmount  the balloon amount, not null and currency compatible with {@code amountPV}.
+     * @param rateAndPeriods the target rate and periods, not null.
      * @return the resulting amount, never null.
      */
     public static MonetaryAmount calculate(MonetaryAmount amountPV, MonetaryAmount balloonAmount,

calc/src/main/java/org/javamoney/calc/banking/package-info.java

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2012, 2018, Werner Keil, Anatole Tresch and others.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ *
+ * Contributors: @atsticks, @keilw
+ */
+
+/**
+ * Banking related financial calculations.
+ */
+package org.javamoney.calc.banking;

calc/src/main/java/org/javamoney/calc/common/AbstractRateAndPeriodBasedOperator.java

@@ -35,14 +35,15 @@ public abstract class AbstractRateAndPeriodBasedOperator implements MonetaryOper
     /**
      * Constructor.
      *
-     * @param rateAndPeriods    the target rate and periods, not null.
+     * @param rateAndPeriods the target rate and periods, not null.
      */
     protected AbstractRateAndPeriodBasedOperator(RateAndPeriods rateAndPeriods) {
         this.rateAndPeriods = Objects.requireNonNull(rateAndPeriods);
     }
 
     /**
      * Get the rate and periods.
+     *
      * @return the rate and periods, never null.
      */
     public RateAndPeriods getRateAndPeriods() {
@@ -51,6 +52,7 @@ public RateAndPeriods getRateAndPeriods() {
 
     /**
      * Get the current rate.
+     *
      * @return the current rate, never null.
      */
     public Rate getRate(){
@@ -59,7 +61,8 @@ public Rate getRate(){
 
     /**
      * Get the current periods, never null.
-     * @return the current periods, >= 0.
+     *
+     * @return the current periods, >= 0.
      */
     public int getPeriods(){
         return rateAndPeriods.getPeriods();