summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnits/unit/UnitPrefix.java
diff options
context:
space:
mode:
authorAdrien Hopkins <adrien.p.hopkins@gmail.com>2024-03-24 13:14:11 -0500
committerAdrien Hopkins <adrien.p.hopkins@gmail.com>2024-03-24 13:14:11 -0500
commit26291e672b0e683edc9d57710a9a9d96ca199c45 (patch)
treedf88f3d3f110e50f38b8a2752d55df4a0c777677 /src/main/java/sevenUnits/unit/UnitPrefix.java
parentcc45a65c78c578eb404d8773b22e5b046917621f (diff)
Format source code & set explicit UTF-8
Diffstat (limited to 'src/main/java/sevenUnits/unit/UnitPrefix.java')
-rw-r--r--src/main/java/sevenUnits/unit/UnitPrefix.java32
1 files changed, 17 insertions, 15 deletions
diff --git a/src/main/java/sevenUnits/unit/UnitPrefix.java b/src/main/java/sevenUnits/unit/UnitPrefix.java
index 824f60b..9035969 100644
--- a/src/main/java/sevenUnits/unit/UnitPrefix.java
+++ b/src/main/java/sevenUnits/unit/UnitPrefix.java
@@ -40,7 +40,7 @@ public final class UnitPrefix implements Nameable {
public static UnitPrefix valueOf(final double multiplier) {
return new UnitPrefix(multiplier, NameSymbol.EMPTY);
}
-
+
/**
* Gets a {@code UnitPrefix} from a multiplier and a name
*
@@ -55,21 +55,21 @@ public final class UnitPrefix implements Nameable {
return new UnitPrefix(multiplier,
Objects.requireNonNull(ns, "ns must not be null."));
}
-
+
/**
* This prefix's name(s) and symbol.
*
* @since 2022-04-16
*/
private final NameSymbol nameSymbol;
-
+
/**
* The number that this prefix multiplies units by
*
* @since 2019-10-16
*/
private final double multiplier;
-
+
/**
* Creates the {@code DefaultUnitPrefix}.
*
@@ -81,7 +81,7 @@ public final class UnitPrefix implements Nameable {
this.multiplier = multiplier;
this.nameSymbol = ns;
}
-
+
/**
* Divides this prefix by a scalar
*
@@ -92,7 +92,7 @@ public final class UnitPrefix implements Nameable {
public UnitPrefix dividedBy(final double divisor) {
return valueOf(this.getMultiplier() / divisor);
}
-
+
/**
* Divides this prefix by {@code other}.
*
@@ -104,7 +104,7 @@ public final class UnitPrefix implements Nameable {
public UnitPrefix dividedBy(final UnitPrefix other) {
return valueOf(this.getMultiplier() / other.getMultiplier());
}
-
+
/**
* {@inheritDoc}
*
@@ -122,7 +122,7 @@ public final class UnitPrefix implements Nameable {
return DecimalComparison.equals(this.getMultiplier(),
other.getMultiplier());
}
-
+
/**
* @return prefix's multiplier
* @since 2019-11-26
@@ -130,12 +130,12 @@ public final class UnitPrefix implements Nameable {
public double getMultiplier() {
return this.multiplier;
}
-
+
@Override
public NameSymbol getNameSymbol() {
return this.nameSymbol;
}
-
+
/**
* {@inheritDoc}
*
@@ -145,7 +145,7 @@ public final class UnitPrefix implements Nameable {
public int hashCode() {
return DecimalComparison.hash(this.getMultiplier());
}
-
+
/**
* Multiplies this prefix by a scalar
*
@@ -156,9 +156,10 @@ public final class UnitPrefix implements Nameable {
public UnitPrefix times(final double multiplicand) {
return valueOf(this.getMultiplier() * multiplicand);
}
-
+
/**
* Adds {@code other} to this prefix and returns the result.
+ *
* @since 2024-03-03
*/
public UnitPrefix plus(final UnitPrefix other) {
@@ -167,6 +168,7 @@ public final class UnitPrefix implements Nameable {
/**
* Subtracts {@code other} from this prefix and returns the result.
+ *
* @since 2024-03-03
*/
public UnitPrefix minus(final UnitPrefix other) {
@@ -184,7 +186,7 @@ public final class UnitPrefix implements Nameable {
public UnitPrefix times(final UnitPrefix other) {
return valueOf(this.getMultiplier() * other.getMultiplier());
}
-
+
/**
* Raises this prefix to an exponent.
*
@@ -196,7 +198,7 @@ public final class UnitPrefix implements Nameable {
public UnitPrefix toExponent(final double exponent) {
return valueOf(Math.pow(this.getMultiplier(), exponent));
}
-
+
/**
* @return a string describing the prefix and its multiplier
*/
@@ -211,7 +213,7 @@ public final class UnitPrefix implements Nameable {
else
return String.format("Unit Prefix (\u00D7 %s)", this.multiplier);
}
-
+
/**
* @param ns name(s) and symbol to use
* @return copy of this prefix with provided name(s) and symbol