summaryrefslogtreecommitdiff
path: root/src/org/unitConverter/unit/BaseUnit.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/org/unitConverter/unit/BaseUnit.java')
-rw-r--r--src/org/unitConverter/unit/BaseUnit.java86
1 files changed, 42 insertions, 44 deletions
diff --git a/src/org/unitConverter/unit/BaseUnit.java b/src/org/unitConverter/unit/BaseUnit.java
index d9f7965..6757bd0 100644
--- a/src/org/unitConverter/unit/BaseUnit.java
+++ b/src/org/unitConverter/unit/BaseUnit.java
@@ -23,8 +23,9 @@ import java.util.Set;
/**
* A unit that other units are defined by.
* <p>
- * Note that BaseUnits <b>must</b> have names and symbols. This is because they are used for toString code. Therefore,
- * the Optionals provided by {@link #getPrimaryName} and {@link #getSymbol} will always contain a value.
+ * Note that BaseUnits <b>must</b> have names and symbols. This is because they
+ * are used for toString code. Therefore, the Optionals provided by
+ * {@link #getPrimaryName} and {@link #getSymbol} will always contain a value.
*
* @author Adrien Hopkins
* @since 2019-10-16
@@ -33,63 +34,56 @@ public final class BaseUnit extends Unit {
/**
* Gets a base unit from the dimension it measures, its name and its symbol.
*
- * @param dimension
- * dimension measured by this unit
- * @param name
- * name of unit
- * @param symbol
- * symbol of unit
+ * @param dimension dimension measured by this unit
+ * @param name name of unit
+ * @param symbol symbol of unit
* @return base unit
* @since 2019-10-16
*/
- public static BaseUnit valueOf(final BaseDimension dimension, final String name, final String symbol) {
+ public static BaseUnit valueOf(final BaseDimension dimension,
+ final String name, final String symbol) {
return new BaseUnit(dimension, name, symbol, new HashSet<>());
}
-
+
/**
* Gets a base unit from the dimension it measures, its name and its symbol.
*
- * @param dimension
- * dimension measured by this unit
- * @param name
- * name of unit
- * @param symbol
- * symbol of unit
+ * @param dimension dimension measured by this unit
+ * @param name name of unit
+ * @param symbol symbol of unit
* @return base unit
* @since 2019-10-21
*/
- public static BaseUnit valueOf(final BaseDimension dimension, final String name, final String symbol,
- final Set<String> otherNames) {
+ public static BaseUnit valueOf(final BaseDimension dimension,
+ final String name, final String symbol, final Set<String> otherNames) {
return new BaseUnit(dimension, name, symbol, otherNames);
}
-
+
/**
* The dimension measured by this base unit.
*/
private final BaseDimension dimension;
-
+
/**
* Creates the {@code BaseUnit}.
*
- * @param dimension
- * dimension of unit
- * @param primaryName
- * name of unit
- * @param symbol
- * symbol of unit
- * @throws NullPointerException
- * if any argument is null
+ * @param dimension dimension of unit
+ * @param primaryName name of unit
+ * @param symbol symbol of unit
+ * @throws NullPointerException if any argument is null
* @since 2019-10-16
*/
- private BaseUnit(final BaseDimension dimension, final String primaryName, final String symbol,
- final Set<String> otherNames) {
+ private BaseUnit(final BaseDimension dimension, final String primaryName,
+ final String symbol, final Set<String> otherNames) {
super(primaryName, symbol, otherNames);
- this.dimension = Objects.requireNonNull(dimension, "dimension must not be null.");
+ this.dimension = Objects.requireNonNull(dimension,
+ "dimension must not be null.");
}
-
+
/**
- * Returns a {@code LinearUnit} with this unit as a base and a conversion factor of 1. This operation must be done
- * in order to allow units to be created with operations.
+ * Returns a {@code LinearUnit} with this unit as a base and a conversion
+ * factor of 1. This operation must be done in order to allow units to be
+ * created with operations.
*
* @return this unit as a {@code LinearUnit}
* @since 2019-10-16
@@ -97,17 +91,17 @@ public final class BaseUnit extends Unit {
public LinearUnit asLinearUnit() {
return LinearUnit.valueOf(this.getBase(), 1);
}
-
+
@Override
- public double convertFromBase(final double value) {
+ protected double convertFromBase(final double value) {
return value;
}
-
+
@Override
- public double convertToBase(final double value) {
+ protected double convertToBase(final double value) {
return value;
}
-
+
/**
* @return dimension
* @since 2019-10-16
@@ -115,21 +109,25 @@ public final class BaseUnit extends Unit {
public final BaseDimension getBaseDimension() {
return this.dimension;
}
-
+
@Override
public String toString() {
return this.getPrimaryName().orElse("Unnamed unit")
- + (this.getSymbol().isPresent() ? String.format(" (%s)", this.getSymbol().get()) : "");
+ + (this.getSymbol().isPresent()
+ ? String.format(" (%s)", this.getSymbol().get())
+ : "");
}
-
+
@Override
public BaseUnit withName(final NameSymbol ns) {
Objects.requireNonNull(ns, "ns must not be null.");
if (!ns.getPrimaryName().isPresent())
- throw new IllegalArgumentException("BaseUnits must have primary names.");
+ throw new IllegalArgumentException(
+ "BaseUnits must have primary names.");
if (!ns.getSymbol().isPresent())
throw new IllegalArgumentException("BaseUnits must have symbols.");
- return BaseUnit.valueOf(this.getBaseDimension(), ns.getPrimaryName().get(), ns.getSymbol().get(),
+ return BaseUnit.valueOf(this.getBaseDimension(),
+ ns.getPrimaryName().get(), ns.getSymbol().get(),
ns.getOtherNames());
}
}