summaryrefslogtreecommitdiff
path: root/src/unitConverter/unit
diff options
context:
space:
mode:
Diffstat (limited to 'src/unitConverter/unit')
-rw-r--r--src/unitConverter/unit/AbstractUnit.java14
-rwxr-xr-xsrc/unitConverter/unit/BaseUnit.java11
-rwxr-xr-xsrc/unitConverter/unit/DefaultUnitPrefix.java3
-rw-r--r--src/unitConverter/unit/LinearUnit.java14
-rwxr-xr-xsrc/unitConverter/unit/NonlinearUnits.java1
-rw-r--r--src/unitConverter/unit/SI.java2
-rwxr-xr-xsrc/unitConverter/unit/SIPrefix.java5
-rwxr-xr-xsrc/unitConverter/unit/Unit.java7
-rwxr-xr-xsrc/unitConverter/unit/UnitPrefix.java2
-rwxr-xr-xsrc/unitConverter/unit/UnitSystem.java5
-rwxr-xr-xsrc/unitConverter/unit/UnitTest.java2
11 files changed, 60 insertions, 6 deletions
diff --git a/src/unitConverter/unit/AbstractUnit.java b/src/unitConverter/unit/AbstractUnit.java
index d3d6dbd..24814e8 100644
--- a/src/unitConverter/unit/AbstractUnit.java
+++ b/src/unitConverter/unit/AbstractUnit.java
@@ -24,13 +24,15 @@ import unitConverter.dimension.UnitDimension;
* The default abstract implementation of the {@code Unit} interface.
*
* @author Adrien Hopkins
- * @since 2019-01-25
+ * @since 2018-12-22
+ * @since v0.1.0
*/
public abstract class AbstractUnit implements Unit {
/**
* The number of units created, including base units.
*
* @since 2019-01-02
+ * @since v0.1.0
*/
private static long unitCount = 0;
@@ -38,12 +40,14 @@ public abstract class AbstractUnit implements Unit {
* The number of base units created.
*
* @since 2019-01-02
+ * @since v0.1.0
*/
private static long baseUnitCount = 0;
/**
* @return number of base units created
* @since 2019-01-02
+ * @since v0.1.0
*/
public static final long getBaseUnitCount() {
return baseUnitCount;
@@ -52,6 +56,7 @@ public abstract class AbstractUnit implements Unit {
/**
* @return number of units created
* @since 2019-01-02
+ * @since v0.1.0
*/
public static final long getUnitCount() {
return unitCount;
@@ -61,6 +66,7 @@ public abstract class AbstractUnit implements Unit {
* Increments the number of base units.
*
* @since 2019-01-15
+ * @since v0.1.0
*/
public static final void incrementBaseUnitCounter() {
baseUnitCount++;
@@ -70,6 +76,7 @@ public abstract class AbstractUnit implements Unit {
* Increments the number of units.
*
* @since 2019-01-15
+ * @since v0.1.0
*/
public static final void incrementUnitCounter() {
unitCount++;
@@ -79,6 +86,7 @@ public abstract class AbstractUnit implements Unit {
* The dimension, or what the unit measures.
*
* @since 2018-12-22
+ * @since v0.1.0
*/
private final UnitDimension dimension;
@@ -87,6 +95,7 @@ public abstract class AbstractUnit implements Unit {
* unit.
*
* @since 2018-12-22
+ * @since v0.1.0
*/
private final BaseUnit base;
@@ -94,6 +103,7 @@ public abstract class AbstractUnit implements Unit {
* The system that this unit is a part of.
*
* @since 2018-12-23
+ * @since v0.1.0
*/
private final UnitSystem system;
@@ -105,6 +115,7 @@ public abstract class AbstractUnit implements Unit {
* @throws NullPointerException
* if name, symbol or base is null
* @since 2018-12-22
+ * @since v0.1.0
*/
public AbstractUnit(final BaseUnit base) {
this.base = Objects.requireNonNull(base, "base must not be null.");
@@ -125,6 +136,7 @@ public abstract class AbstractUnit implements Unit {
* @throws NullPointerException
* if name, symbol or dimension is null
* @since 2018-12-23
+ * @since v0.1.0
*/
AbstractUnit(final UnitDimension dimension, final UnitSystem system) {
// try to set this as a base unit
diff --git a/src/unitConverter/unit/BaseUnit.java b/src/unitConverter/unit/BaseUnit.java
index 204b1cd..d4a1e9c 100755
--- a/src/unitConverter/unit/BaseUnit.java
+++ b/src/unitConverter/unit/BaseUnit.java
@@ -26,12 +26,14 @@ import unitConverter.dimension.UnitDimension;
*
* @author Adrien Hopkins
* @since 2018-12-23
+ * @since v0.1.0
*/
public final class BaseUnit extends AbstractUnit {
/**
* Is this unit a full base (i.e. m, s, ... but not N, J, ...)
*
* @since 2019-01-15
+ * @since v0.1.0
*/
private final boolean isFullBase;
@@ -47,6 +49,7 @@ public final class BaseUnit extends AbstractUnit {
* @param symbol
* symbol of unit
* @since 2018-12-23
+ * @since v0.1.0
*/
BaseUnit(final UnitDimension dimension, final UnitSystem system) {
super(dimension, system);
@@ -56,6 +59,7 @@ public final class BaseUnit extends AbstractUnit {
/**
* @return this unit as a {@code LinearUnit}
* @since 2019-01-25
+ * @since v0.1.0
*/
public LinearUnit asLinearUnit() {
return this.times(1);
@@ -82,6 +86,7 @@ public final class BaseUnit extends AbstractUnit {
* @throws NullPointerException
* if other is null
* @since 2018-12-22
+ * @since v0.1.0
*/
public BaseUnit dividedBy(final BaseUnit other) {
Objects.requireNonNull(other, "other must not be null.");
@@ -97,6 +102,7 @@ public final class BaseUnit extends AbstractUnit {
* amount to divide by
* @return quotient
* @since 2018-12-23
+ * @since v0.1.0
*/
public LinearUnit dividedBy(final double divisor) {
return new LinearUnit(this, 1 / divisor);
@@ -113,6 +119,7 @@ public final class BaseUnit extends AbstractUnit {
* @throws NullPointerException
* if other is null
* @since 2018-12-22
+ * @since v0.1.0
*/
public BaseUnit times(final BaseUnit other) {
Objects.requireNonNull(other, "other must not be null.");
@@ -127,7 +134,8 @@ public final class BaseUnit extends AbstractUnit {
* @param multiplier
* amount to multiply by
* @return product
- * @since 2018-12-23B
+ * @since 2018-12-23
+ * @since v0.1.0
*/
public LinearUnit times(final double multiplier) {
return new LinearUnit(this, multiplier);
@@ -140,6 +148,7 @@ public final class BaseUnit extends AbstractUnit {
* exponent
* @return result of exponentiation
* @since 2019-01-15
+ * @since v0.1.0
*/
public BaseUnit toExponent(final int exponent) {
return this.getSystem().getBaseUnit(this.getDimension().toExponent(exponent));
diff --git a/src/unitConverter/unit/DefaultUnitPrefix.java b/src/unitConverter/unit/DefaultUnitPrefix.java
index 1cce413..d19161b 100755
--- a/src/unitConverter/unit/DefaultUnitPrefix.java
+++ b/src/unitConverter/unit/DefaultUnitPrefix.java
@@ -19,8 +19,11 @@ package unitConverter.unit;
import java.util.Objects;
/**
+ * The default implementation of {@code UnitPrefix}, which contains a multiplier and nothing else.
+ *
* @author Adrien Hopkins
* @since 2019-01-14
+ * @since v0.1.0
*/
public final class DefaultUnitPrefix implements UnitPrefix {
private final double multiplier;
diff --git a/src/unitConverter/unit/LinearUnit.java b/src/unitConverter/unit/LinearUnit.java
index e2c9eb2..6514ff4 100644
--- a/src/unitConverter/unit/LinearUnit.java
+++ b/src/unitConverter/unit/LinearUnit.java
@@ -24,13 +24,15 @@ import unitConverter.dimension.UnitDimension;
* A unit that is equal to a certain number multiplied by its base.
*
* @author Adrien Hopkins
- * @since 2019-01-25
+ * @since 2018-12-22
+ * @since v0.1.0
*/
public final class LinearUnit extends AbstractUnit {
/**
* The value of one of this unit in this unit's base unit
*
* @since 2018-12-22
+ * @since v0.1.0
*/
private final double conversionFactor;
@@ -43,6 +45,7 @@ public final class LinearUnit extends AbstractUnit {
* @param conversionFactor
* value of one of this unit in its base
* @since 2018-12-23
+ * @since v0.1.0
*/
LinearUnit(final BaseUnit base, final double conversionFactor) {
super(base);
@@ -57,6 +60,7 @@ public final class LinearUnit extends AbstractUnit {
* @param system
* system unit is part of
* @since 2019-01-25
+ * @since v0.1.0
*/
LinearUnit(final UnitDimension dimension, final UnitSystem system, final double conversionFactor) {
super(dimension, system);
@@ -80,6 +84,7 @@ public final class LinearUnit extends AbstractUnit {
* scalar to divide by
* @return quotient
* @since 2018-12-23
+ * @since v0.1.0
*/
public LinearUnit dividedBy(final double divisor) {
return new LinearUnit(this.getBase(), this.getConversionFactor() / divisor);
@@ -94,6 +99,7 @@ public final class LinearUnit extends AbstractUnit {
* @throws NullPointerException
* if other is null
* @since 2018-12-22
+ * @since v0.1.0
*/
public LinearUnit dividedBy(final LinearUnit other) {
Objects.requireNonNull(other, "other must not be null");
@@ -103,7 +109,8 @@ public final class LinearUnit extends AbstractUnit {
/**
* @return conversionFactor
- * @since 2019-01-25
+ * @since 2018-12-22
+ * @since v0.1.0
*/
public final double getConversionFactor() {
return this.conversionFactor;
@@ -116,6 +123,7 @@ public final class LinearUnit extends AbstractUnit {
* scalar to multiply by
* @return product
* @since 2018-12-23
+ * @since v0.1.0
*/
public LinearUnit times(final double multiplier) {
return new LinearUnit(this.getBase(), this.getConversionFactor() * multiplier);
@@ -130,6 +138,7 @@ public final class LinearUnit extends AbstractUnit {
* @throws NullPointerException
* if other is null
* @since 2018-12-22
+ * @since v0.1.0
*/
public LinearUnit times(final LinearUnit other) {
Objects.requireNonNull(other, "other must not be null");
@@ -144,6 +153,7 @@ public final class LinearUnit extends AbstractUnit {
* exponent to exponientate unit to
* @return exponientated unit
* @since 2019-01-15
+ * @since v0.1.0
*/
public LinearUnit toExponent(final int exponent) {
return new LinearUnit(this.getBase().toExponent(exponent), Math.pow(this.conversionFactor, exponent));
diff --git a/src/unitConverter/unit/NonlinearUnits.java b/src/unitConverter/unit/NonlinearUnits.java
index f7e257c..ec1874c 100755
--- a/src/unitConverter/unit/NonlinearUnits.java
+++ b/src/unitConverter/unit/NonlinearUnits.java
@@ -21,6 +21,7 @@ package unitConverter.unit;
*
* @author Adrien Hopkins
* @since 2019-01-14
+ * @since v0.1.0
*/
public final class NonlinearUnits {
public static final Unit CELSIUS = new AbstractUnit(SI.KELVIN) {
diff --git a/src/unitConverter/unit/SI.java b/src/unitConverter/unit/SI.java
index cda42e7..54eb4c5 100644
--- a/src/unitConverter/unit/SI.java
+++ b/src/unitConverter/unit/SI.java
@@ -28,6 +28,7 @@ import unitConverter.dimension.UnitDimension;
*
* @author Adrien Hopkins
* @since 2018-12-23
+ * @since v0.1.0
*/
public enum SI implements UnitSystem {
SI;
@@ -36,6 +37,7 @@ public enum SI implements UnitSystem {
* This system's base units.
*
* @since 2019-01-25
+ * @since v0.1.0
*/
private static final Set<BaseUnit> baseUnits = new HashSet<>();
diff --git a/src/unitConverter/unit/SIPrefix.java b/src/unitConverter/unit/SIPrefix.java
index 39f1a8c..54625fb 100755
--- a/src/unitConverter/unit/SIPrefix.java
+++ b/src/unitConverter/unit/SIPrefix.java
@@ -17,8 +17,11 @@
package unitConverter.unit;
/**
+ * The SI prefixes.
+ *
* @author Adrien Hopkins
* @since 2019-01-14
+ * @since v0.1.0
*/
public enum SIPrefix implements UnitPrefix {
DECA(10), HECTO(100), KILO(1e3), MEGA(1e6), GIGA(1e9), TERA(1e12), PETA(1e15), EXA(1e18), ZETTA(1e21), YOTTA(
@@ -33,6 +36,7 @@ public enum SIPrefix implements UnitPrefix {
* @param multiplier
* prefix's multiplier
* @since 2019-01-14
+ * @since v0.1.0
*/
private SIPrefix(final double multiplier) {
this.multiplier = multiplier;
@@ -41,6 +45,7 @@ public enum SIPrefix implements UnitPrefix {
/**
* @return value
* @since 2019-01-14
+ * @since v0.1.0
*/
@Override
public final double getMultiplier() {
diff --git a/src/unitConverter/unit/Unit.java b/src/unitConverter/unit/Unit.java
index 9e1375a..54f1423 100755
--- a/src/unitConverter/unit/Unit.java
+++ b/src/unitConverter/unit/Unit.java
@@ -25,6 +25,7 @@ import unitConverter.dimension.UnitDimension;
*
* @author Adrien Hopkins
* @since 2018-12-22
+ * @since v0.1.0
*/
public interface Unit {
/**
@@ -34,6 +35,7 @@ public interface Unit {
* unit to test with
* @return true if the units are compatible
* @since 2019-01-13
+ * @since v0.1.0
*/
default boolean canConvertTo(final Unit other) {
return Objects.equals(this.getBase(), other.getBase());
@@ -53,6 +55,7 @@ public interface Unit {
* value expressed in <b>base</b> unit
* @return value expressed in <b>this</b> unit
* @since 2018-12-22
+ * @since v0.1.0
*/
double convertFromBase(double value);
@@ -70,6 +73,7 @@ public interface Unit {
* value expressed in <b>this</b> unit
* @return value expressed in <b>base</b> unit
* @since 2018-12-22
+ * @since v0.1.0
*/
double convertToBase(double value);
@@ -86,18 +90,21 @@ public interface Unit {
*
* @return base unit associated with this unit
* @since 2018-12-22
+ * @since v0.1.0
*/
BaseUnit getBase();
/**
* @return dimension measured by this unit
* @since 2018-12-22
+ * @since v0.1.0
*/
UnitDimension getDimension();
/**
* @return system that this unit is a part of
* @since 2018-12-23
+ * @since v0.1.0
*/
UnitSystem getSystem();
}
diff --git a/src/unitConverter/unit/UnitPrefix.java b/src/unitConverter/unit/UnitPrefix.java
index cb50fd9..a0c1b7c 100755
--- a/src/unitConverter/unit/UnitPrefix.java
+++ b/src/unitConverter/unit/UnitPrefix.java
@@ -21,11 +21,13 @@ package unitConverter.unit;
*
* @author Adrien Hopkins
* @since 2019-01-14
+ * @since v0.1.0
*/
public interface UnitPrefix {
/**
* @return this prefix's multiplier
* @since 2019-01-14
+ * @since v0.1.0
*/
double getMultiplier();
}
diff --git a/src/unitConverter/unit/UnitSystem.java b/src/unitConverter/unit/UnitSystem.java
index d641832..ce8c249 100755
--- a/src/unitConverter/unit/UnitSystem.java
+++ b/src/unitConverter/unit/UnitSystem.java
@@ -25,6 +25,7 @@ import unitConverter.dimension.UnitDimension;
*
* @author Adrien Hopkins
* @since 2018-12-23
+ * @since v0.1.0
*/
public interface UnitSystem {
/**
@@ -36,6 +37,7 @@ public interface UnitSystem {
* @throws NullPointerException
* if dimension is null
* @since 2019-01-25
+ * @since v0.1.0
*/
default BaseUnit getBaseUnit(final UnitDimension dimension) {
Objects.requireNonNull(dimension, "dimension must not be null.");
@@ -44,7 +46,8 @@ public interface UnitSystem {
/**
* @return name of system
- * @since 2019-01-25
+ * @since 2018-12-23
+ * @since v0.1.0
*/
String getName();
}
diff --git a/src/unitConverter/unit/UnitTest.java b/src/unitConverter/unit/UnitTest.java
index 7e16123..c3237eb 100755
--- a/src/unitConverter/unit/UnitTest.java
+++ b/src/unitConverter/unit/UnitTest.java
@@ -26,7 +26,7 @@ import unitConverter.dimension.StandardDimensions;
* Testing the various Unit classes
*
* @author Adrien Hopkins
- * @since 2019-01-26
+ * @since 2018-12-22
*/
class UnitTest {
@Test
generated by cgit v1.2.3 (git 2.46.0) at 2025-10-03 15:30:58 +0000