diff options
Diffstat (limited to 'src/org/unitConverter/unit/UnitPrefix.java')
-rw-r--r-- | src/org/unitConverter/unit/UnitPrefix.java | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/src/org/unitConverter/unit/UnitPrefix.java b/src/org/unitConverter/unit/UnitPrefix.java index 514fa1c..360b0c1 100644 --- a/src/org/unitConverter/unit/UnitPrefix.java +++ b/src/org/unitConverter/unit/UnitPrefix.java @@ -80,6 +80,11 @@ public final class UnitPrefix { return valueOf(this.getMultiplier() / other.getMultiplier()); } + /** + * {@inheritDoc} + * + * Uses the prefix's multiplier to determine equality. + */ @Override public boolean equals(final Object obj) { if (this == obj) @@ -92,10 +97,19 @@ public final class UnitPrefix { return DecimalComparison.equals(this.getMultiplier(), other.getMultiplier()); } + /** + * @return prefix's multiplier + * @since 2019-11-26 + */ public double getMultiplier() { return this.multiplier; } + /** + * {@inheritDoc} + * + * Uses the prefix's multiplier to determine a hash code. + */ @Override public int hashCode() { return DecimalComparison.hash(this.getMultiplier()); @@ -139,8 +153,11 @@ public final class UnitPrefix { return valueOf(Math.pow(this.getMultiplier(), exponent)); } + /** + * @return a string describing the prefix and its multiplier + */ @Override public String toString() { - return String.format("Unit prefix equal to %s", this.multiplier); + return String.format("Unit prefix with multiplier %s", this.multiplier); } } |