Quality fixes and additional Javadocs added.

Author: atsticks

src/main/java/javax/money/AbstractContext.java

@@ -63,7 +63,7 @@ public Set<String> getKeys(Class<?> type) {
 
     /**
      * Get the current attribute type.
-     *
+     * @param key the entry's key, not null
      * @return the current attribute type, or null, if no such attribute exists.
      */
     public Class<?> getType(String key) {
@@ -135,6 +135,7 @@ public Integer getInt(String key) {
      * @param key the attribute's key, not null.
      * @return the value, or null.
      */
+    @SuppressWarnings("BooleanMethodNameMustStartWithQuestion")
     public Boolean getBoolean(String key) {
         return get(key, Boolean.class);
     }

src/main/java/javax/money/AbstractQuery.java

@@ -24,17 +24,17 @@ public abstract class AbstractQuery extends AbstractContext {
     /**
      * Key for storing the target providers to be queried
      */
-    public static final String KEY_QUERY_PROVIDERS = "Query.providers";
+    protected static final String KEY_QUERY_PROVIDERS = "Query.providers";
 
     /**
      * Key name for the timestamp attribute.
      */
-    public static final String KEY_QUERY_TIMESTAMP = "Query.timestamp";
+    protected static final String KEY_QUERY_TIMESTAMP = "Query.timestamp";
 
     /**
      * Key name for the target type attribute.
      */
-    public static final String KEY_QUERY_TARGET_TYPE = "Query.targetType";
+    protected static final String KEY_QUERY_TARGET_TYPE = "Query.targetType";
 
 
     /**

src/main/java/javax/money/Monetary.java

@@ -22,25 +22,25 @@
  * </ul>
  * <p>This class is thread-safe, final and serializable.</p>
  *
- * @see MonetaryAmounts#getAmountFactory(MonetaryAmountFactoryQuery)
+ * @see Monetary#getAmountFactory(MonetaryAmountFactoryQuery)
  * @see MonetaryAmountFactory
  */
 public final class MonetaryAmountFactoryQuery extends AbstractQuery implements Serializable {
 
     /**
      * Key name for the context.
      */
-    static final String KEY_PRECISION = "precision";
+    private static final String KEY_PRECISION = "precision";
 
     /**
      * Key name for the currency provider.
      */
-    static final String KEY_FIXED_SCALE = "fixedScale";
+    private static final String KEY_FIXED_SCALE = "fixedScale";
 
     /**
      * Key name for the max scale.
      */
-    static final String KEY_MAX_SCALE = "maxScale";
+    private static final String KEY_MAX_SCALE = "maxScale";
 
     /**
      * Constructor, used from the {@link MonetaryAmountFactoryQueryBuilder}.
@@ -75,7 +75,7 @@ public Integer getPrecision() {
      *
      * @return the fixed scale flag, or null, if this attribute must not be considered.
      */
-    public Boolean getFixedScale() {
+    public Boolean isFixedScale() {
         return getBoolean(KEY_FIXED_SCALE);
     }
 

src/main/java/javax/money/MonetaryAmountFactoryQuery.java

@@ -16,7 +16,7 @@
  * <p>
  * Note this class is NOT thread-safe.
  *
- * @see javax.money.MonetaryAmounts#getAmountFactory(MonetaryAmountFactoryQuery)
+ * @see javax.money.Monetary#getAmountFactory(MonetaryAmountFactoryQuery)
  * @see MonetaryAmountFactory
  */
 public final class MonetaryAmountFactoryQueryBuilder

src/main/java/javax/money/MonetaryAmountFactoryQueryBuilder.java

@@ -30,7 +30,7 @@ private MonetaryContextBuilder(MonetaryContext monetaryContext) {
      *
      * @param amountType the target amount type, not null.
      */
-    MonetaryContextBuilder(Class<? extends MonetaryAmount> amountType) {
+    private MonetaryContextBuilder(Class<? extends MonetaryAmount> amountType) {
         set(MonetaryContext.AMOUNT_TYPE, amountType);
     }
 

src/main/java/javax/money/MonetaryContextBuilder.java

@@ -12,7 +12,6 @@
  */
 package javax.money;
 
-import java.util.function.UnaryOperator;
 
 /**
  * Represents an operation on a single {@link MonetaryAmount} that produces a

src/main/java/javax/money/MonetaryOperator.java

@@ -75,7 +75,7 @@ public ConversionContextBuilder() {
 
     /**
      * Creates a new {@link javax.money.convert.ConversionContextBuilder} instance.
-     *
+     * @param conversionContext the conversion context to be used to initialize the new builder instance, not null.
      * @return a new {@link javax.money.convert.ConversionContextBuilder} instance, never null.
      */
     public static ConversionContextBuilder of(ConversionContext conversionContext) {

src/main/java/javax/money/convert/ConversionContextBuilder.java

@@ -10,139 +10,137 @@
  */
 package javax.money.convert;
 
-import java.util.Objects;
-
 import javax.money.CurrencyUnit;
 import javax.money.MonetaryException;
+import java.util.Objects;
 
 /**
  * Exception thrown when a monetary conversion operation fails.
- * 
+ *
  * @author Werner Keil
  * @author Stephen Colebourne
  * @author Anatole Tresch
  */
 public class CurrencyConversionException extends MonetaryException {
 
-	/** Serialization lock. */
-	private static final long serialVersionUID = -7743240650686883450L;
+    /**
+     * Serialization lock.
+     */
+    private static final long serialVersionUID = -7743240650686883450L;
 
-	/** Base currency. */
-	private CurrencyUnit base;
-	/** Terminating currency. */
-	private CurrencyUnit term;
-	/** The acquired {@link ConversionContext}, may be null. */
-	private ConversionContext conversionContext;
+    /**
+     * Base currency.
+     */
+    private final CurrencyUnit base;
+    /**
+     * Terminating currency.
+     */
+    private final CurrencyUnit term;
+    /**
+     * The acquired {@link ConversionContext}, may be null.
+     */
+    private final ConversionContext conversionContext;
 
-	/**
-	 * Constructs an <code>CurrencyConversionException</code> with the specified
-	 * detail message, timestamp, source and target currency.
-	 * 
-	 * @param base
-	 *            the source currency, may be null.
-	 * 
-	 * @param term
-	 *            the target currency, may be null.
-	 * 
-	 * @param message
-	 *            the detail message.
-	 */
-	public CurrencyConversionException(CurrencyUnit base, CurrencyUnit term,
-			ConversionContext conversionContext, String message) {
-		super("Cannot convert " + String.valueOf(base) + " into "
-				+ String.valueOf(term) + ": " + message);
-		this.base = base;
-		this.term = term;
-		this.conversionContext = conversionContext;
-	}
+    /**
+     * Constructs an <code>CurrencyConversionException</code> with the specified
+     * detail message, timestamp, source and target currency.
+     *
+     * @param base              the source currency, may be null.
+     * @param term              the target currency, may be null.
+     * @param conversionContext the {@link javax.money.convert.ConversionContext} in place.
+     * @param message           the detail message.
+     */
+    public CurrencyConversionException(CurrencyUnit base, CurrencyUnit term,
+                                       ConversionContext conversionContext, String message) {
+        super("Cannot convert " + String.valueOf(base) + " into "
+                + String.valueOf(term) + ": " + message);
+        this.base = base;
+        this.term = term;
+        this.conversionContext = conversionContext;
+    }
 
-	/**
-	 * Constructs an <code>CurrencyConversionException</code> with the specified
-	 * source and target currency.
-	 * 
-	 * @param base
-	 *            the source currency, may be null.
-	 * 
-	 * @param term
-	 *            the target currency, may be null.
-	 */
-	public CurrencyConversionException(CurrencyUnit base, CurrencyUnit term,
-			ConversionContext conversionContext) {
-		super("Cannot convert " + String.valueOf(base) + " into "
-				+ String.valueOf(term));
-		this.base = base;
-		this.term = term;
-		this.conversionContext = conversionContext;
-	}
+    /**
+     * Constructs an <code>CurrencyConversionException</code> with the specified
+     * source and target currency.
+     *
+     * @param base the source currency, may be null.
+     * @param term the target currency, may be null.
+     * @param conversionContext the {@link javax.money.convert.ConversionContext} in place.
+     */
+    public CurrencyConversionException(CurrencyUnit base, CurrencyUnit term,
+                                       ConversionContext conversionContext) {
+        super("Cannot convert " + String.valueOf(base) + " into "
+                + String.valueOf(term));
+        this.base = base;
+        this.term = term;
+        this.conversionContext = conversionContext;
+    }
 
-	/**
-	 * Constructs a new exception with the specified source and target currency,
-	 * detail message and cause.
-	 * 
-	 * <p>
-	 * Note that the detail message associated with <code>cause</code> is
-	 * <i>not</i> automatically incorporated in this exception's detail message.
-	 * 
-	 * @param base
-	 *            the source currency, may be null.
-	 * @param term
-	 *            the target currency, may be null.
-	 * @param message
-	 *            the detail message (which is saved for later retrieval by the
-	 *            {@link Throwable#getMessage()} method).
-	 * @param cause
-	 *            the cause (which is saved for later retrieval by the
-	 *            {@link Throwable#getCause()} method). (A <tt>null</tt> value
-	 *            is permitted, and indicates that the cause is nonexistent or
-	 *            unknown.)
-	 */
-	public CurrencyConversionException(CurrencyUnit base, CurrencyUnit term,
-			ConversionContext conversionContext, String message, Throwable cause) {
-		super("Cannot convert " + String.valueOf(base) + " into "
-				+ String.valueOf(term)
-				+ (Objects.nonNull(message) ? ": " + message : ""), cause);
-		this.base = base;
-		this.term = term;
-		this.conversionContext = conversionContext;
-	}
+    /**
+     * Constructs a new exception with the specified source and target currency,
+     * detail message and cause.
+     * <p/>
+     * <p/>
+     * Note that the detail message associated with <code>cause</code> is
+     * <i>not</i> automatically incorporated in this exception's detail message.
+     *
+     * @param base    the source currency, may be null.
+     * @param term    the target currency, may be null.
+     * @param message the detail message (which is saved for later retrieval by the
+     *                {@link Throwable#getMessage()} method).
+     * @param cause   the cause (which is saved for later retrieval by the
+     *                {@link Throwable#getCause()} method). (A <tt>null</tt> value
+     *                is permitted, and indicates that the cause is nonexistent or
+     *                unknown.)
+     * @param conversionContext the {@link javax.money.convert.ConversionContext} in place.
+     */
+    public CurrencyConversionException(CurrencyUnit base, CurrencyUnit term,
+                                       ConversionContext conversionContext, String message, Throwable cause) {
+        super("Cannot convert " + String.valueOf(base) + " into "
+                + String.valueOf(term)
+                + (Objects.nonNull(message) ? ": " + message : ""), cause);
+        this.base = base;
+        this.term = term;
+        this.conversionContext = conversionContext;
+    }
 
-	/**
-	 * Gets the first currency at fault.
-	 * 
-	 * @return the currency at fault, may be null
-	 */
-    public CurrencyUnit getBaseCurrency(){
+    /**
+     * Gets the first currency at fault.
+     *
+     * @return the currency at fault, may be null
+     */
+    public CurrencyUnit getBaseCurrency() {
         return base;
-	}
+    }
 
-	/**
-	 * Gets the second currency at fault.
-	 * 
-	 * @return the currency at fault, may be null
-	 */
-    public CurrencyUnit getTermCurrency(){
+    /**
+     * Gets the second currency at fault.
+     *
+     * @return the currency at fault, may be null
+     */
+    public CurrencyUnit getTermCurrency() {
         return term;
-	}
+    }
 
-	/**
-	 * Gets the queried timestamp at fault.
-	 * 
-	 * @return the queried timestamp, or {@code null}.
-	 */
-	public ConversionContext getConversionContext() {
-		return this.conversionContext;
-	}
+    /**
+     * Gets the queried timestamp at fault.
+     *
+     * @return the queried timestamp, or {@code null}.
+     */
+    public ConversionContext getConversionContext() {
+        return this.conversionContext;
+    }
 
-	/*
-	 * (non-Javadoc)
-	 * 
-	 * @see java.lang.Object#toString()
-	 */
-	@Override
-	public String toString() {
-		return "CurrencyConversionException [base=" + base + ", term=" + term
-				+ ", conversionContext=" + conversionContext + "]: "
-				+ getMessage();
-	}
+    /*
+     * (non-Javadoc)
+     *
+     * @see java.lang.Object#toString()
+     */
+    @Override
+    public String toString() {
+        return "CurrencyConversionException [base=" + base + ", term=" + term
+                + ", conversionContext=" + conversionContext + "]: "
+                + getMessage();
+    }
 
 }

src/main/java/javax/money/convert/CurrencyConversionException.java

@@ -87,7 +87,7 @@ public ProviderContextBuilder setRateTypes(RateType... rateTypes) {
     @SuppressWarnings({"unchecked", "rawtypes"})
     public ProviderContextBuilder setRateTypes(Collection<RateType> rateTypes) {
         Objects.requireNonNull(rateTypes);
-        if (rateTypes.size() == 0) {
+        if (rateTypes.isEmpty()) {
             throw new IllegalArgumentException("At least one RateType is required.");
         }
         Set rtSet = new HashSet<>();

src/main/java/javax/money/convert/ProviderContextBuilder.java

@@ -39,8 +39,7 @@ public enum RateType{
     OTHER,
     /**
      * Any type of rates. This can be used, where any type of rate is suitable. This may be feasible if you
-     * access a specific chain of rate providers, e.g. by calling {@link MonetaryConversions#getConversion(String,
-     * ConversionContext, String...)},
+     * access a specific chain of rate providers,
      * where the order of providers already implies a prioritization and the rate type in that scenario is not relevant.
      */
     ANY

src/main/java/javax/money/convert/RateType.java

@@ -80,6 +80,7 @@ public MonetaryAmountFactory getMonetaryAmountFactory() {
      *
      * @param locale    the target locale, not null.
      * @param providers the providers to be used, not null.
+     * @return a new query instance
      */
     public static AmountFormatQuery of(Locale locale, String... providers) {
         return AmountFormatQueryBuilder.of(locale).setProviderNames(providers).build();