From 2c146c894972e2c6ab701b3c66dcf242d7be656f Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Tue, 24 Dec 2019 16:16:13 -0500 Subject: Added Javadoc to the project. --- doc/org/unitConverter/unit/BaseDimension.html | 313 +++++ doc/org/unitConverter/unit/BaseUnit.html | 452 +++++++ .../unitConverter/unit/BritishImperial.Area.html | 349 ++++++ .../unitConverter/unit/BritishImperial.Length.html | 443 +++++++ .../unitConverter/unit/BritishImperial.Mass.html | 388 ++++++ .../unitConverter/unit/BritishImperial.Volume.html | 414 ++++++ doc/org/unitConverter/unit/BritishImperial.html | 384 ++++++ doc/org/unitConverter/unit/FunctionalUnit.html | 504 ++++++++ doc/org/unitConverter/unit/LinearUnit.html | 800 ++++++++++++ doc/org/unitConverter/unit/NameSymbol.html | 641 ++++++++++ doc/org/unitConverter/unit/SI.BaseDimensions.html | 347 ++++++ doc/org/unitConverter/unit/SI.BaseUnits.html | 347 ++++++ doc/org/unitConverter/unit/SI.Constants.html | 284 +++++ doc/org/unitConverter/unit/SI.Dimensions.html | 789 ++++++++++++ doc/org/unitConverter/unit/SI.html | 1313 ++++++++++++++++++++ doc/org/unitConverter/unit/USCustomary.Area.html | 336 +++++ doc/org/unitConverter/unit/USCustomary.Length.html | 492 ++++++++ doc/org/unitConverter/unit/USCustomary.Mass.html | 388 ++++++ doc/org/unitConverter/unit/USCustomary.Volume.html | 583 +++++++++ doc/org/unitConverter/unit/USCustomary.html | 423 +++++++ doc/org/unitConverter/unit/Unit.html | 632 ++++++++++ ...Map.PrefixedUnitEntrySet.PrefixedUnitEntry.html | 499 ++++++++ ...ixedUnitEntrySet.PrefixedUnitEntryIterator.html | 542 ++++++++ ...abase.PrefixedUnitMap.PrefixedUnitEntrySet.html | 761 ++++++++++++ ...efixedUnitNameSet.PrefixedUnitNameIterator.html | 542 ++++++++ ...tabase.PrefixedUnitMap.PrefixedUnitNameSet.html | 754 +++++++++++ .../unit/UnitDatabase.PrefixedUnitMap.html | 930 ++++++++++++++ doc/org/unitConverter/unit/UnitDatabase.html | 789 ++++++++++++ doc/org/unitConverter/unit/UnitDatabaseTest.html | 643 ++++++++++ doc/org/unitConverter/unit/UnitPrefix.html | 570 +++++++++ doc/org/unitConverter/unit/UnitTest.html | 420 +++++++ .../unit/class-use/BaseDimension.html | 470 +++++++ doc/org/unitConverter/unit/class-use/BaseUnit.html | 296 +++++ .../unit/class-use/BritishImperial.Area.html | 124 ++ .../unit/class-use/BritishImperial.Length.html | 124 ++ .../unit/class-use/BritishImperial.Mass.html | 124 ++ .../unit/class-use/BritishImperial.Volume.html | 124 ++ .../unit/class-use/BritishImperial.html | 124 ++ .../unit/class-use/FunctionalUnit.html | 199 +++ .../unitConverter/unit/class-use/LinearUnit.html | 926 ++++++++++++++ .../unitConverter/unit/class-use/NameSymbol.html | 324 +++++ .../unit/class-use/SI.BaseDimensions.html | 124 ++ .../unitConverter/unit/class-use/SI.BaseUnits.html | 124 ++ .../unitConverter/unit/class-use/SI.Constants.html | 124 ++ .../unit/class-use/SI.Dimensions.html | 124 ++ doc/org/unitConverter/unit/class-use/SI.html | 124 ++ .../unit/class-use/USCustomary.Area.html | 124 ++ .../unit/class-use/USCustomary.Length.html | 124 ++ .../unit/class-use/USCustomary.Mass.html | 124 ++ .../unit/class-use/USCustomary.Volume.html | 124 ++ .../unitConverter/unit/class-use/USCustomary.html | 124 ++ doc/org/unitConverter/unit/class-use/Unit.html | 312 +++++ ...Map.PrefixedUnitEntrySet.PrefixedUnitEntry.html | 149 +++ ...ixedUnitEntrySet.PrefixedUnitEntryIterator.html | 149 +++ ...abase.PrefixedUnitMap.PrefixedUnitEntrySet.html | 149 +++ ...efixedUnitNameSet.PrefixedUnitNameIterator.html | 149 +++ ...tabase.PrefixedUnitMap.PrefixedUnitNameSet.html | 149 +++ .../class-use/UnitDatabase.PrefixedUnitMap.html | 233 ++++ .../unitConverter/unit/class-use/UnitDatabase.html | 124 ++ .../unit/class-use/UnitDatabaseTest.html | 149 +++ .../unitConverter/unit/class-use/UnitPrefix.html | 381 ++++++ doc/org/unitConverter/unit/class-use/UnitTest.html | 149 +++ doc/org/unitConverter/unit/package-frame.html | 41 + doc/org/unitConverter/unit/package-summary.html | 279 +++++ doc/org/unitConverter/unit/package-tree.html | 161 +++ doc/org/unitConverter/unit/package-use.html | 186 +++ 66 files changed, 23907 insertions(+) create mode 100644 doc/org/unitConverter/unit/BaseDimension.html create mode 100644 doc/org/unitConverter/unit/BaseUnit.html create mode 100644 doc/org/unitConverter/unit/BritishImperial.Area.html create mode 100644 doc/org/unitConverter/unit/BritishImperial.Length.html create mode 100644 doc/org/unitConverter/unit/BritishImperial.Mass.html create mode 100644 doc/org/unitConverter/unit/BritishImperial.Volume.html create mode 100644 doc/org/unitConverter/unit/BritishImperial.html create mode 100644 doc/org/unitConverter/unit/FunctionalUnit.html create mode 100644 doc/org/unitConverter/unit/LinearUnit.html create mode 100644 doc/org/unitConverter/unit/NameSymbol.html create mode 100644 doc/org/unitConverter/unit/SI.BaseDimensions.html create mode 100644 doc/org/unitConverter/unit/SI.BaseUnits.html create mode 100644 doc/org/unitConverter/unit/SI.Constants.html create mode 100644 doc/org/unitConverter/unit/SI.Dimensions.html create mode 100644 doc/org/unitConverter/unit/SI.html create mode 100644 doc/org/unitConverter/unit/USCustomary.Area.html create mode 100644 doc/org/unitConverter/unit/USCustomary.Length.html create mode 100644 doc/org/unitConverter/unit/USCustomary.Mass.html create mode 100644 doc/org/unitConverter/unit/USCustomary.Volume.html create mode 100644 doc/org/unitConverter/unit/USCustomary.html create mode 100644 doc/org/unitConverter/unit/Unit.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html create mode 100644 doc/org/unitConverter/unit/UnitDatabase.html create mode 100644 doc/org/unitConverter/unit/UnitDatabaseTest.html create mode 100644 doc/org/unitConverter/unit/UnitPrefix.html create mode 100644 doc/org/unitConverter/unit/UnitTest.html create mode 100644 doc/org/unitConverter/unit/class-use/BaseDimension.html create mode 100644 doc/org/unitConverter/unit/class-use/BaseUnit.html create mode 100644 doc/org/unitConverter/unit/class-use/BritishImperial.Area.html create mode 100644 doc/org/unitConverter/unit/class-use/BritishImperial.Length.html create mode 100644 doc/org/unitConverter/unit/class-use/BritishImperial.Mass.html create mode 100644 doc/org/unitConverter/unit/class-use/BritishImperial.Volume.html create mode 100644 doc/org/unitConverter/unit/class-use/BritishImperial.html create mode 100644 doc/org/unitConverter/unit/class-use/FunctionalUnit.html create mode 100644 doc/org/unitConverter/unit/class-use/LinearUnit.html create mode 100644 doc/org/unitConverter/unit/class-use/NameSymbol.html create mode 100644 doc/org/unitConverter/unit/class-use/SI.BaseDimensions.html create mode 100644 doc/org/unitConverter/unit/class-use/SI.BaseUnits.html create mode 100644 doc/org/unitConverter/unit/class-use/SI.Constants.html create mode 100644 doc/org/unitConverter/unit/class-use/SI.Dimensions.html create mode 100644 doc/org/unitConverter/unit/class-use/SI.html create mode 100644 doc/org/unitConverter/unit/class-use/USCustomary.Area.html create mode 100644 doc/org/unitConverter/unit/class-use/USCustomary.Length.html create mode 100644 doc/org/unitConverter/unit/class-use/USCustomary.Mass.html create mode 100644 doc/org/unitConverter/unit/class-use/USCustomary.Volume.html create mode 100644 doc/org/unitConverter/unit/class-use/USCustomary.html create mode 100644 doc/org/unitConverter/unit/class-use/Unit.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabase.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitDatabaseTest.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitPrefix.html create mode 100644 doc/org/unitConverter/unit/class-use/UnitTest.html create mode 100644 doc/org/unitConverter/unit/package-frame.html create mode 100644 doc/org/unitConverter/unit/package-summary.html create mode 100644 doc/org/unitConverter/unit/package-tree.html create mode 100644 doc/org/unitConverter/unit/package-use.html (limited to 'doc/org/unitConverter/unit') diff --git a/doc/org/unitConverter/unit/BaseDimension.html b/doc/org/unitConverter/unit/BaseDimension.html new file mode 100644 index 0000000..c5c27c7 --- /dev/null +++ b/doc/org/unitConverter/unit/BaseDimension.html @@ -0,0 +1,313 @@ + + + + + +BaseDimension + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class BaseDimension

+
+
+ +
+
    +
  • +
    +
    +
    public final class BaseDimension
+extends java.lang.Object
    +
    A dimension that defines a BaseUnit
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetName() 
      java.lang.StringgetSymbol() 
      java.lang.StringtoString() 
      static BaseDimensionvalueOf(java.lang.String name, + java.lang.String symbol) +
      Gets a BaseDimension with the provided name and symbol.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        valueOf

        +
        public static BaseDimension valueOf(java.lang.String name,
+                                    java.lang.String symbol)
        +
        Gets a BaseDimension with the provided name and symbol.
        +
        +
        Parameters:
        +
        name - name of dimension
        +
        symbol - symbol used for dimension
        +
        Returns:
        +
        dimension
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        getName

        +
        public final java.lang.String getName()
        +
        +
        Returns:
        +
        name
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        getSymbol

        +
        public final java.lang.String getSymbol()
        +
        +
        Returns:
        +
        symbol
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/BaseUnit.html b/doc/org/unitConverter/unit/BaseUnit.html new file mode 100644 index 0000000..56fb19c --- /dev/null +++ b/doc/org/unitConverter/unit/BaseUnit.html @@ -0,0 +1,452 @@ + + + + + +BaseUnit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class BaseUnit

+
+
+ +
+
    +
  • +
    +
    +
    public final class BaseUnit
+extends Unit
    +
    A unit that other units are defined by. +

    + Note that BaseUnits must have names and symbols. This is because they are used for toString code. Therefore, + the Optionals provided by Unit.getPrimaryName() and Unit.getSymbol() will always contain a value.

    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        valueOf

        +
        public static BaseUnit valueOf(BaseDimension dimension,
+                               java.lang.String name,
+                               java.lang.String symbol)
        +
        Gets a base unit from the dimension it measures, its name and its symbol.
        +
        +
        Parameters:
        +
        dimension - dimension measured by this unit
        +
        name - name of unit
        +
        symbol - symbol of unit
        +
        Returns:
        +
        base unit
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BaseUnit valueOf(BaseDimension dimension,
+                               java.lang.String name,
+                               java.lang.String symbol,
+                               java.util.Set<java.lang.String> otherNames)
        +
        Gets a base unit from the dimension it measures, its name and its symbol.
        +
        +
        Parameters:
        +
        dimension - dimension measured by this unit
        +
        name - name of unit
        +
        symbol - symbol of unit
        +
        Returns:
        +
        base unit
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        asLinearUnit

        +
        public LinearUnit asLinearUnit()
        +
        Returns a 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:
        +
        this unit as a LinearUnit
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        convertFromBase

        +
        public double convertFromBase(double value)
        +
        Description copied from class: Unit
        +
        Converts from a value expressed in this unit's base unit to a value expressed in this unit. +

        + This must be the inverse of convertToBase, so convertFromBase(convertToBase(value)) must be equal + to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        +
        +
        Specified by:
        +
        convertFromBase in class Unit
        +
        Parameters:
        +
        value - value expressed in base unit
        +
        Returns:
        +
        value expressed in this unit
        +
        +
        • +
      + + + +
        +
      • +

        convertToBase

        +
        public double convertToBase(double value)
        +
        Description copied from class: Unit
        +
        Converts from a value expressed in this unit to a value expressed in this unit's base unit. +

        + This must be the inverse of convertFromBase, so convertToBase(convertFromBase(value)) must be + equal to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        +
        +
        Specified by:
        +
        convertToBase in class Unit
        +
        Parameters:
        +
        value - value expressed in this unit
        +
        Returns:
        +
        value expressed in base unit
        +
        +
        • +
      + + + +
        +
      • +

        getBaseDimension

        +
        public final BaseDimension getBaseDimension()
        +
        +
        Returns:
        +
        dimension
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Unit
        +
        +
        • +
      + + + +
        +
      • +

        withName

        +
        public BaseUnit withName(NameSymbol ns)
        +
        +
        Overrides:
        +
        withName in class Unit
        +
        Parameters:
        +
        ns - name(s) and symbol to use
        +
        Returns:
        +
        a copy of this unit with provided name(s) and symbol
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/BritishImperial.Area.html b/doc/org/unitConverter/unit/BritishImperial.Area.html new file mode 100644 index 0000000..28b404b --- /dev/null +++ b/doc/org/unitConverter/unit/BritishImperial.Area.html @@ -0,0 +1,349 @@ + + + + + +BritishImperial.Area + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class BritishImperial.Area

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BritishImperial
    +
    +
    +
    +
    public static final class BritishImperial.Area
+extends java.lang.Object
    +
    Imperial units that measure area
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Area

        +
        public Area()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/BritishImperial.Length.html b/doc/org/unitConverter/unit/BritishImperial.Length.html new file mode 100644 index 0000000..f1235a8 --- /dev/null +++ b/doc/org/unitConverter/unit/BritishImperial.Length.html @@ -0,0 +1,443 @@ + + + + + +BritishImperial.Length + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class BritishImperial.Length

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BritishImperial
    +
    +
    +
    +
    public static final class BritishImperial.Length
+extends java.lang.Object
    +
    Imperial units that measure length
    +
    +
    Since:
    +
    2019-10-28
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Length

        +
        public Length()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/BritishImperial.Mass.html b/doc/org/unitConverter/unit/BritishImperial.Mass.html new file mode 100644 index 0000000..ba6d965 --- /dev/null +++ b/doc/org/unitConverter/unit/BritishImperial.Mass.html @@ -0,0 +1,388 @@ + + + + + +BritishImperial.Mass + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class BritishImperial.Mass

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BritishImperial
    +
    +
    +
    +
    public static final class BritishImperial.Mass
+extends java.lang.Object
    +
    British Imperial units that measure mass.
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/BritishImperial.Volume.html b/doc/org/unitConverter/unit/BritishImperial.Volume.html new file mode 100644 index 0000000..dc8d76a --- /dev/null +++ b/doc/org/unitConverter/unit/BritishImperial.Volume.html @@ -0,0 +1,414 @@ + + + + + +BritishImperial.Volume + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class BritishImperial.Volume

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    BritishImperial
    +
    +
    +
    +
    public static final class BritishImperial.Volume
+extends java.lang.Object
    +
    British Imperial units that measure volume
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/BritishImperial.html b/doc/org/unitConverter/unit/BritishImperial.html new file mode 100644 index 0000000..2f63c1f --- /dev/null +++ b/doc/org/unitConverter/unit/BritishImperial.html @@ -0,0 +1,384 @@ + + + + + +BritishImperial + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class BritishImperial

+
+
+ +
+
    +
  • +
    +
    +
    public final class BritishImperial
+extends java.lang.Object
    +
    A static utility class that contains units in the British Imperial system.
    +
    +
    Since:
    +
    2019-10-21
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        OUNCE_FORCE

        +
        public static final LinearUnit OUNCE_FORCE
        +
        • +
      + + + +
        +
      • +

        POUND_FORCE

        +
        public static final LinearUnit POUND_FORCE
        +
        • +
      + + + +
        +
      • +

        BRITISH_THERMAL_UNIT

        +
        public static final LinearUnit BRITISH_THERMAL_UNIT
        +
        • +
      + + + +
        +
      • +

        CALORIE

        +
        public static final LinearUnit CALORIE
        +
        • +
      + + + +
        +
      • +

        KILOCALORIE

        +
        public static final LinearUnit KILOCALORIE
        +
        • +
      + + + +
        +
      • +

        FAHRENHEIT

        +
        public static final Unit FAHRENHEIT
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BritishImperial

        +
        public BritishImperial()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/FunctionalUnit.html b/doc/org/unitConverter/unit/FunctionalUnit.html new file mode 100644 index 0000000..fc0d446 --- /dev/null +++ b/doc/org/unitConverter/unit/FunctionalUnit.html @@ -0,0 +1,504 @@ + + + + + +FunctionalUnit + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class FunctionalUnit

+
+
+ +
+
    +
  • +
    +
    final class FunctionalUnit
+extends Unit
    +
    A unit that uses functional objects to convert to and from its base.
    +
    +
    Since:
    +
    2019-05-22
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.function.DoubleUnaryOperatorconverterFrom +
      A function that accepts a value expressed in the unit's base and returns that value expressed in this unit.
      +
      private java.util.function.DoubleUnaryOperatorconverterTo +
      A function that accepts a value expressed in the unit and returns that value expressed in the unit's base.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private FunctionalUnit​(ObjectProduct<BaseUnit> base, + java.util.function.DoubleUnaryOperator converterFrom, + java.util.function.DoubleUnaryOperator converterTo) +
      Creates the FunctionalUnit.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        converterFrom

        +
        private final java.util.function.DoubleUnaryOperator converterFrom
        +
        A function that accepts a value expressed in the unit's base and returns that value expressed in this unit.
        +
        +
        Since:
        +
        2019-05-22
        +
        +
        • +
      + + + +
        +
      • +

        converterTo

        +
        private final java.util.function.DoubleUnaryOperator converterTo
        +
        A function that accepts a value expressed in the unit and returns that value expressed in the unit's base.
        +
        +
        Since:
        +
        2019-05-22
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FunctionalUnit

        +
        private FunctionalUnit​(ObjectProduct<BaseUnit> base,
+                       java.util.function.DoubleUnaryOperator converterFrom,
+                       java.util.function.DoubleUnaryOperator converterTo)
        +
        Creates the FunctionalUnit.
        +
        +
        Parameters:
        +
        base - unit's base
        +
        converterFrom - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.
        +
        converterTo - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-05-22
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        valueOf

        +
        public static FunctionalUnit valueOf​(ObjectProduct<BaseUnit> base,
+                                     java.util.function.DoubleUnaryOperator converterFrom,
+                                     java.util.function.DoubleUnaryOperator converterTo)
        +
        Returns a unit from its base and the functions it uses to convert to and from its base.
        +
        +
        Parameters:
        +
        base - unit's base
        +
        converterFrom - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.
        +
        converterTo - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.
        +
        Returns:
        +
        a unit that uses the provided functions to convert.
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-05-22
        +
        +
        • +
      + + + +
        +
      • +

        convertFromBase

        +
        public double convertFromBase​(double value)
        +
        Description copied from class: Unit
        +
        Converts from a value expressed in this unit's base unit to a value expressed in this unit. +

        + This must be the inverse of convertToBase, so convertFromBase(convertToBase(value)) must be equal + to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        +
        +
        Specified by:
        +
        convertFromBase in class Unit
        +
        Parameters:
        +
        value - value expressed in base unit
        +
        Returns:
        +
        value expressed in this unit
        +
        +
        • +
      + + + +
        +
      • +

        convertToBase

        +
        public double convertToBase​(double value)
        +
        Description copied from class: Unit
        +
        Converts from a value expressed in this unit to a value expressed in this unit's base unit. +

        + This must be the inverse of convertFromBase, so convertToBase(convertFromBase(value)) must be + equal to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        +
        +
        Specified by:
        +
        convertToBase in class Unit
        +
        Parameters:
        +
        value - value expressed in this unit
        +
        Returns:
        +
        value expressed in base unit
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/LinearUnit.html b/doc/org/unitConverter/unit/LinearUnit.html new file mode 100644 index 0000000..1e1fce2 --- /dev/null +++ b/doc/org/unitConverter/unit/LinearUnit.html @@ -0,0 +1,800 @@ + + + + + +LinearUnit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class LinearUnit

+
+
+ +
+
    +
  • +
    +
    +
    public final class LinearUnit
+extends Unit
    +
    A unit that can be expressed as a product of its base and a number. For example, kilometres, inches and pounds.
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromUnitValue

        +
        public static LinearUnit fromUnitValue(Unit unit,
+                                       double value)
        +
        Gets a LinearUnit from a unit and a value. For example, converts '59 °F' to a linear unit with the value + of '288.15 K'
        +
        +
        Parameters:
        +
        unit - unit to convert
        +
        value - value to convert
        +
        Returns:
        +
        value expressed as a LinearUnit
        +
        Throws:
        +
        java.lang.NullPointerException - if unit is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        fromUnitValue

        +
        public static LinearUnit fromUnitValue(Unit unit,
+                                       double value,
+                                       NameSymbol ns)
        +
        Gets a LinearUnit from a unit and a value. For example, converts '59 °F' to a linear unit with the value + of '288.15 K'
        +
        +
        Parameters:
        +
        unit - unit to convert
        +
        value - value to convert
        +
        ns - name(s) and symbol of unit
        +
        Returns:
        +
        value expressed as a LinearUnit
        +
        Throws:
        +
        java.lang.NullPointerException - if unit or ns is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static LinearUnit valueOf(ObjectProduct<BaseUnit> unitBase,
+                                 double conversionFactor)
        +
        Gets a LinearUnit from a unit base and a conversion factor. In other words, gets the product of + unitBase and conversionFactor, expressed as a LinearUnit.
        +
        +
        Parameters:
        +
        unitBase - unit base to multiply by
        +
        conversionFactor - number to multiply base by
        +
        Returns:
        +
        product of base and conversion factor
        +
        Throws:
        +
        java.lang.NullPointerException - if unitBase is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static LinearUnit valueOf(ObjectProduct<BaseUnit> unitBase,
+                                 double conversionFactor,
+                                 NameSymbol ns)
        +
        Gets a LinearUnit from a unit base and a conversion factor. In other words, gets the product of + unitBase and conversionFactor, expressed as a LinearUnit.
        +
        +
        Parameters:
        +
        unitBase - unit base to multiply by
        +
        conversionFactor - number to multiply base by
        +
        ns - name(s) and symbol of unit
        +
        Returns:
        +
        product of base and conversion factor
        +
        Throws:
        +
        java.lang.NullPointerException - if unitBase is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        convertFromBase

        +
        protected double convertFromBase(double value)
        +
        Converts from a value expressed in this unit's base unit to a value expressed in this unit. +

        + This must be the inverse of convertToBase, so convertFromBase(convertToBase(value)) must be equal + to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        + + Converts by dividing by conversionFactor
        +
        +
        Specified by:
        +
        convertFromBase in class Unit
        +
        Parameters:
        +
        value - value expressed in base unit
        +
        Returns:
        +
        value expressed in this unit
        +
        +
        • +
      + + + +
        +
      • +

        convertToBase

        +
        protected double convertToBase(double value)
        +
        Converts from a value expressed in this unit to a value expressed in this unit's base unit. +

        + This must be the inverse of convertFromBase, so convertToBase(convertFromBase(value)) must be + equal to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        + + Converts by multiplying by conversionFactor
        +
        +
        Specified by:
        +
        convertToBase in class Unit
        +
        Parameters:
        +
        value - value expressed in this unit
        +
        Returns:
        +
        value expressed in base unit
        +
        +
        • +
      + + + +
        +
      • +

        dividedBy

        +
        public LinearUnit dividedBy(double divisor)
        +
        Divides this unit by a scalar.
        +
        +
        Parameters:
        +
        divisor - scalar to divide by
        +
        Returns:
        +
        quotient
        +
        Since:
        +
        2018-12-23, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        dividedBy

        +
        public LinearUnit dividedBy(LinearUnit divisor)
        +
        Returns the quotient of this unit and another.
        +
        +
        Parameters:
        +
        divisor - unit to divide by
        +
        Returns:
        +
        quotient of two units
        +
        Throws:
        +
        java.lang.NullPointerException - if divisor is null
        +
        Since:
        +
        2018-12-22, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        + + Uses the base and conversion factor of units to test for equality.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getConversionFactor

        +
        public double getConversionFactor()
        +
        +
        Returns:
        +
        conversion factor
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        + + Uses the base and conversion factor to compute a hash code.
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        isBase

        +
        public boolean isBase()
        +
        +
        Returns:
        +
        whether this unit is equivalent to a BaseUnit (i.e. there is a BaseUnit b where + b.asLinearUnit().equals(this) returns true.)
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        isCoherent

        +
        public boolean isCoherent()
        +
        +
        Returns:
        +
        whether this unit is coherent (i.e. has conversion factor 1)
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public LinearUnit minus(LinearUnit subtrahendend)
        +
        Returns the difference of this unit and another. +

        + Two units can be subtracted if they have the same base. Note that Unit.canConvertTo(org.unitConverter.unit.Unit) can be used to determine + this. If subtrahend does not meet this condition, an IllegalArgumentException will be thrown. +

        +
        +
        Parameters:
        +
        subtrahend - unit to subtract
        +
        Returns:
        +
        difference of units
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if subtrahend is not compatible for subtraction as described above
        +
        java.lang.NullPointerException - if subtrahend is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public LinearUnit plus(LinearUnit addend)
        +
        Returns the sum of this unit and another. +

        + Two units can be added if they have the same base. Note that Unit.canConvertTo(org.unitConverter.unit.Unit) can be used to determine this. + If addend does not meet this condition, an IllegalArgumentException will be thrown. +

        +
        +
        Parameters:
        +
        addend - unit to add
        +
        Returns:
        +
        sum of units
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if addend is not compatible for addition as described above
        +
        java.lang.NullPointerException - if addend is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        times

        +
        public LinearUnit times(double multiplier)
        +
        Multiplies this unit by a scalar.
        +
        +
        Parameters:
        +
        multiplier - scalar to multiply by
        +
        Returns:
        +
        product
        +
        Since:
        +
        2018-12-23, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        times

        +
        public LinearUnit times(LinearUnit multiplier)
        +
        Returns the product of this unit and another.
        +
        +
        Parameters:
        +
        multiplier - unit to multiply by
        +
        Returns:
        +
        product of two units
        +
        Throws:
        +
        java.lang.NullPointerException - if multiplier is null
        +
        Since:
        +
        2018-12-22, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        toExponent

        +
        public LinearUnit toExponent(int exponent)
        +
        Returns this unit but to an exponent.
        +
        +
        Parameters:
        +
        exponent - exponent to exponentiate unit to
        +
        Returns:
        +
        exponentiated unit
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class Unit
        +
        Returns:
        +
        a string providing a definition of this unit
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        withName

        +
        public LinearUnit withName(NameSymbol ns)
        +
        +
        Overrides:
        +
        withName in class Unit
        +
        Parameters:
        +
        ns - name(s) and symbol to use
        +
        Returns:
        +
        a copy of this unit with provided name(s) and symbol
        +
        +
        • +
      + + + +
        +
      • +

        withPrefix

        +
        public LinearUnit withPrefix(UnitPrefix prefix)
        +
        Returns the result of applying prefix to this unit. +

        + If this unit and the provided prefix have a primary name, the returned unit will have a primary name (prefix's + name + unit's name).
        + If this unit and the provided prefix have a symbol, the returned unit will have a symbol.
        + This method ignores alternate names of both this unit and the provided prefix.

        +
        +
        Parameters:
        +
        prefix - prefix to apply
        +
        Returns:
        +
        unit with prefix
        +
        Throws:
        +
        java.lang.NullPointerException - if prefix is null
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/NameSymbol.html b/doc/org/unitConverter/unit/NameSymbol.html new file mode 100644 index 0000000..17b5d4e --- /dev/null +++ b/doc/org/unitConverter/unit/NameSymbol.html @@ -0,0 +1,641 @@ + + + + + +NameSymbol + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.unit
+

Class NameSymbol

+
+
+ +
+
    +
  • +
    +
    +
    public final class NameSymbol
+extends java.lang.Object
    +
    A class that can be used to specify names and a symbol for a unit.
    +
    +
    Since:
    +
    2019-10-21
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static NameSymbolEMPTY 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.util.Set<java.lang.String>getOtherNames() 
      java.util.Optional<java.lang.String>getPrimaryName() 
      java.util.Optional<java.lang.String>getSymbol() 
      static NameSymbolof(java.lang.String name, + java.lang.String symbol) +
      Gets a NameSymbol with a primary name, a symbol and no other names.
      +
      static NameSymbolof(java.lang.String name, + java.lang.String symbol, + java.util.Set<java.lang.String> otherNames) +
      Gets a NameSymbol with a primary name, a symbol and additional names.
      +
      static NameSymbolof(java.lang.String name, + java.lang.String symbol, + java.lang.String... otherNames) +
      h * Gets a NameSymbol with a primary name, a symbol and additional names.
      +
      static NameSymbolof(java.lang.String name, + java.lang.String symbol, + java.lang.String name2) +
      Gets a NameSymbol with a primary name, a symbol and an additional name.
      +
      static NameSymbolof(java.lang.String name, + java.lang.String symbol, + java.lang.String name2, + java.lang.String name3) +
      Gets a NameSymbol with a primary name, a symbol and additional names.
      +
      static NameSymbolof(java.lang.String name, + java.lang.String symbol, + java.lang.String name2, + java.lang.String name3, + java.lang.String name4) +
      Gets a NameSymbol with a primary name, a symbol and additional names.
      +
      static NameSymbolofName(java.lang.String name) +
      Gets a NameSymbol with a primary name, no symbol, and no other names.
      +
      static NameSymbolofNullable(java.lang.String name, + java.lang.String symbol, + java.util.Set<java.lang.String> otherNames) +
      Gets a NameSymbol with a primary name, a symbol and additional names.
      +
      static NameSymbolofNullable(java.lang.String name, + java.lang.String symbol, + java.lang.String... otherNames) +
      h * Gets a NameSymbol with a primary name, a symbol and additional names.
      +
      static NameSymbolofSymbol(java.lang.String symbol) +
      Gets a NameSymbol with a symbol and no names.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        of

        +
        public static final NameSymbol of(java.lang.String name,
+                                  java.lang.String symbol)
        +
        Gets a NameSymbol with a primary name, a symbol and no other names.
        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if name or symbol is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static final NameSymbol of(java.lang.String name,
+                                  java.lang.String symbol,
+                                  java.util.Set<java.lang.String> otherNames)
        +
        Gets a NameSymbol with a primary name, a symbol and additional names.
        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static final NameSymbol of(java.lang.String name,
+                                  java.lang.String symbol,
+                                  java.lang.String... otherNames)
        +
        h * Gets a NameSymbol with a primary name, a symbol and additional names.
        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static final NameSymbol of(java.lang.String name,
+                                  java.lang.String symbol,
+                                  java.lang.String name2)
        +
        Gets a NameSymbol with a primary name, a symbol and an additional name.
        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        name2 - alternate name
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static final NameSymbol of(java.lang.String name,
+                                  java.lang.String symbol,
+                                  java.lang.String name2,
+                                  java.lang.String name3)
        +
        Gets a NameSymbol with a primary name, a symbol and additional names.
        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        name2 - alternate name
        +
        name3 - alternate name
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        of

        +
        public static final NameSymbol of(java.lang.String name,
+                                  java.lang.String symbol,
+                                  java.lang.String name2,
+                                  java.lang.String name3,
+                                  java.lang.String name4)
        +
        Gets a NameSymbol with a primary name, a symbol and additional names.
        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        name2 - alternate name
        +
        name3 - alternate name
        +
        name4 - alternate name
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        ofName

        +
        public static final NameSymbol ofName(java.lang.String name)
        +
        Gets a NameSymbol with a primary name, no symbol, and no other names.
        +
        +
        Parameters:
        +
        name - name to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if name is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        ofNullable

        +
        public static final NameSymbol ofNullable(java.lang.String name,
+                                          java.lang.String symbol,
+                                          java.util.Set<java.lang.String> otherNames)
        +
        Gets a NameSymbol with a primary name, a symbol and additional names. +

        + If any argument is null, this static factory replaces it with an empty Optional or empty Set.

        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      + + + +
        +
      • +

        ofNullable

        +
        public static final NameSymbol ofNullable(java.lang.String name,
+                                          java.lang.String symbol,
+                                          java.lang.String... otherNames)
        +
        h * Gets a NameSymbol with a primary name, a symbol and additional names. +

        + If any argument is null, this static factory replaces it with an empty Optional or empty Set.

        +
        +
        Parameters:
        +
        name - name to use
        +
        symbol - symbol to use
        +
        otherNames - other names to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      + + + +
        +
      • +

        ofSymbol

        +
        public static final NameSymbol ofSymbol(java.lang.String symbol)
        +
        Gets a NameSymbol with a symbol and no names.
        +
        +
        Parameters:
        +
        symbol - symbol to use
        +
        Returns:
        +
        NameSymbol instance
        +
        Throws:
        +
        java.lang.NullPointerException - if symbol is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        getOtherNames

        +
        public final java.util.Set<java.lang.String> getOtherNames()
        +
        +
        Returns:
        +
        otherNames
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryName

        +
        public final java.util.Optional<java.lang.String> getPrimaryName()
        +
        +
        Returns:
        +
        primaryName
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        getSymbol

        +
        public final java.util.Optional<java.lang.String> getSymbol()
        +
        +
        Returns:
        +
        symbol
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/SI.BaseDimensions.html b/doc/org/unitConverter/unit/SI.BaseDimensions.html new file mode 100644 index 0000000..9b0383a --- /dev/null +++ b/doc/org/unitConverter/unit/SI.BaseDimensions.html @@ -0,0 +1,347 @@ + + + + + +SI.BaseDimensions + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class SI.BaseDimensions

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    SI
    +
    +
    +
    +
    public static final class SI.BaseDimensions
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/SI.BaseUnits.html b/doc/org/unitConverter/unit/SI.BaseUnits.html new file mode 100644 index 0000000..af96cd3 --- /dev/null +++ b/doc/org/unitConverter/unit/SI.BaseUnits.html @@ -0,0 +1,347 @@ + + + + + +SI.BaseUnits + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class SI.BaseUnits

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    SI
    +
    +
    +
    +
    public static final class SI.BaseUnits
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+
    +
  • + + +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/SI.Constants.html b/doc/org/unitConverter/unit/SI.Constants.html new file mode 100644 index 0000000..f846f4a --- /dev/null +++ b/doc/org/unitConverter/unit/SI.Constants.html @@ -0,0 +1,284 @@ + + + + + +SI.Constants + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class SI.Constants

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    SI
    +
    +
    +
    +
    public static final class SI.Constants
+extends java.lang.Object
    +
    Constants that relate to the SI or other systems.
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Constants() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        EARTH_GRAVITY

        +
        public static final LinearUnit EARTH_GRAVITY
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Constants

        +
        public Constants()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/SI.Dimensions.html b/doc/org/unitConverter/unit/SI.Dimensions.html new file mode 100644 index 0000000..f626044 --- /dev/null +++ b/doc/org/unitConverter/unit/SI.Dimensions.html @@ -0,0 +1,789 @@ + + + + + +SI.Dimensions + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class SI.Dimensions

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    SI
    +
    +
    +
    +
    public static final class SI.Dimensions
+extends java.lang.Object
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/SI.html b/doc/org/unitConverter/unit/SI.html new file mode 100644 index 0000000..7e50983 --- /dev/null +++ b/doc/org/unitConverter/unit/SI.html @@ -0,0 +1,1313 @@ + + + + + +SI + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class SI

+
+
+ +
+
    +
  • +
    +
    +
    public final class SI
+extends java.lang.Object
    +
    All of the units, prefixes and dimensions that are used by the SI, as well as some outside the SI. + +

    + This class does not include prefixed units. To obtain prefixed units, use LinearUnit.withPrefix(org.unitConverter.unit.UnitPrefix): + + 

    + LinearUnit KILOMETRE = SI.METRE.withPrefix(SI.KILO);
+
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/USCustomary.Area.html b/doc/org/unitConverter/unit/USCustomary.Area.html new file mode 100644 index 0000000..f811e72 --- /dev/null +++ b/doc/org/unitConverter/unit/USCustomary.Area.html @@ -0,0 +1,336 @@ + + + + + +USCustomary.Area + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class USCustomary.Area

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    USCustomary
    +
    +
    +
    +
    public static final class USCustomary.Area
+extends java.lang.Object
    +
    US Customary units that measure area
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        SQUARE_SURVEY_FOOT

        +
        public static final LinearUnit SQUARE_SURVEY_FOOT
        +
        • +
      + + + +
        +
      • +

        SQUARE_CHAIN

        +
        public static final LinearUnit SQUARE_CHAIN
        +
        • +
      + + + +
        +
      • +

        ACRE

        +
        public static final LinearUnit ACRE
        +
        • +
      + + + +
        +
      • +

        SECTION

        +
        public static final LinearUnit SECTION
        +
        • +
      + + + +
        +
      • +

        SURVEY_TOWNSHIP

        +
        public static final LinearUnit SURVEY_TOWNSHIP
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Area

        +
        public Area()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/USCustomary.Length.html b/doc/org/unitConverter/unit/USCustomary.Length.html new file mode 100644 index 0000000..19c9c9b --- /dev/null +++ b/doc/org/unitConverter/unit/USCustomary.Length.html @@ -0,0 +1,492 @@ + + + + + +USCustomary.Length + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class USCustomary.Length

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    USCustomary
    +
    +
    +
    +
    public static final class USCustomary.Length
+extends java.lang.Object
    +
    US Customary units that measure length
    +
    +
    Since:
    +
    2019-10-28
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/USCustomary.Mass.html b/doc/org/unitConverter/unit/USCustomary.Mass.html new file mode 100644 index 0000000..65c463b --- /dev/null +++ b/doc/org/unitConverter/unit/USCustomary.Mass.html @@ -0,0 +1,388 @@ + + + + + +USCustomary.Mass + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class USCustomary.Mass

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    USCustomary
    +
    +
    +
    +
    public static final class USCustomary.Mass
+extends java.lang.Object
    +
    mass units
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Mass

        +
        public Mass()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/USCustomary.Volume.html b/doc/org/unitConverter/unit/USCustomary.Volume.html new file mode 100644 index 0000000..0a1cbf9 --- /dev/null +++ b/doc/org/unitConverter/unit/USCustomary.Volume.html @@ -0,0 +1,583 @@ + + + + + +USCustomary.Volume + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class USCustomary.Volume

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    USCustomary
    +
    +
    +
    +
    public static final class USCustomary.Volume
+extends java.lang.Object
    +
    Volume units
    +
    +
    Since:
    +
    2019-11-08
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/USCustomary.html b/doc/org/unitConverter/unit/USCustomary.html new file mode 100644 index 0000000..38777d1 --- /dev/null +++ b/doc/org/unitConverter/unit/USCustomary.html @@ -0,0 +1,423 @@ + + + + + +USCustomary + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.unit
+

Class USCustomary

+
+
+ +
+
    +
  • +
    +
    +
    public final class USCustomary
+extends java.lang.Object
    +
    A static utility class that contains units in the US Customary system.
    +
    +
    Since:
    +
    2019-10-21
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        OUNCE_FORCE

        +
        public static final LinearUnit OUNCE_FORCE
        +
        • +
      + + + +
        +
      • +

        POUND_FORCE

        +
        public static final LinearUnit POUND_FORCE
        +
        • +
      + + + +
        +
      • +

        BRITISH_THERMAL_UNIT

        +
        public static final LinearUnit BRITISH_THERMAL_UNIT
        +
        • +
      + + + +
        +
      • +

        CALORIE

        +
        public static final LinearUnit CALORIE
        +
        • +
      + + + +
        +
      • +

        KILOCALORIE

        +
        public static final LinearUnit KILOCALORIE
        +
        • +
      + + + +
        +
      • +

        FOOT_POUND

        +
        public static final LinearUnit FOOT_POUND
        +
        • +
      + + + +
        +
      • +

        HORSEPOWER

        +
        public static final LinearUnit HORSEPOWER
        +
        • +
      + + + +
        +
      • +

        POUND_PER_SQUARE_INCH

        +
        public static final LinearUnit POUND_PER_SQUARE_INCH
        +
        • +
      + + + +
        +
      • +

        FAHRENHEIT

        +
        public static final Unit FAHRENHEIT
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        USCustomary

        +
        public USCustomary()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/Unit.html b/doc/org/unitConverter/unit/Unit.html new file mode 100644 index 0000000..2a84bfa --- /dev/null +++ b/doc/org/unitConverter/unit/Unit.html @@ -0,0 +1,632 @@ + + + + + +Unit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.unit
+

Class Unit

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    BaseUnit, LinearUnit
    +
    +
    +
    +
    public abstract class Unit
+extends java.lang.Object
    +
    A unit that is composed of base units.
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Unit

        +
        protected Unit(ObjectProduct<BaseUnit> unitBase,
+               NameSymbol ns)
        +
        Creates the AbstractUnit.
        +
        +
        Parameters:
        +
        unitBase - base of unit
        +
        ns - names and symbol of unit
        +
        Throws:
        +
        java.lang.NullPointerException - if unitBase or ns is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromConversionFunctions

        +
        public static final Unit fromConversionFunctions(ObjectProduct<BaseUnit> base,
+                                                 java.util.function.DoubleUnaryOperator converterFrom,
+                                                 java.util.function.DoubleUnaryOperator converterTo)
        +
        Returns a unit from its base and the functions it uses to convert to and from its base. + +

        + For example, to get a unit representing the degree Celsius, the following code can be used: + + Unit.fromConversionFunctions(SI.KELVIN, tempK -> tempK - 273.15, tempC -> tempC + 273.15); +

        +
        +
        Parameters:
        +
        base - unit's base
        +
        converterFrom - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.
        +
        converterTo - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.
        +
        Returns:
        +
        a unit that uses the provided functions to convert.
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-05-22
        +
        +
        • +
      + + + +
        +
      • +

        fromConversionFunctions

        +
        public static final Unit fromConversionFunctions(ObjectProduct<BaseUnit> base,
+                                                 java.util.function.DoubleUnaryOperator converterFrom,
+                                                 java.util.function.DoubleUnaryOperator converterTo,
+                                                 NameSymbol ns)
        +
        Returns a unit from its base and the functions it uses to convert to and from its base. + +

        + For example, to get a unit representing the degree Celsius, the following code can be used: + + Unit.fromConversionFunctions(SI.KELVIN, tempK -> tempK - 273.15, tempC -> tempC + 273.15); +

        +
        +
        Parameters:
        +
        base - unit's base
        +
        converterFrom - function that accepts a value expressed in the unit's base and returns that value expressed in this + unit.
        +
        converterTo - function that accepts a value expressed in the unit and returns that value expressed in the unit's + base.
        +
        ns - names and symbol of unit
        +
        Returns:
        +
        a unit that uses the provided functions to convert.
        +
        Throws:
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-05-22
        +
        +
        • +
      + + + +
        +
      • +

        canConvertTo

        +
        public final boolean canConvertTo(Unit other)
        +
        Checks if a value expressed in this unit can be converted to a value expressed in other
        +
        +
        Parameters:
        +
        other - unit to test with
        +
        Returns:
        +
        true if the units are compatible
        +
        Throws:
        +
        java.lang.NullPointerException - if other is null
        +
        Since:
        +
        2019-01-13, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        convertFromBase

        +
        protected abstract double convertFromBase(double value)
        +
        Converts from a value expressed in this unit's base unit to a value expressed in this unit. +

        + This must be the inverse of convertToBase, so convertFromBase(convertToBase(value)) must be equal + to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        +
        +
        Parameters:
        +
        value - value expressed in base unit
        +
        Returns:
        +
        value expressed in this unit
        +
        Since:
        +
        2018-12-22, v0.1.0
        +
        Implementation Requirements:
        +
        This method is used by convertTo(org.unitConverter.unit.Unit, double), and its behaviour affects the behaviour of + convertTo.
        +
        +
        • +
      + + + +
        +
      • +

        convertTo

        +
        public final double convertTo(Unit other,
+                              double value)
        +
        Converts a value expressed in this unit to a value expressed in other.
        +
        +
        Parameters:
        +
        other - unit to convert to
        +
        value - value to convert
        +
        Returns:
        +
        converted value
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if other is incompatible for conversion with this unit (as tested by + canConvertTo(org.unitConverter.unit.Unit)).
        +
        java.lang.NullPointerException - if other is null
        +
        Since:
        +
        2019-05-22
        +
        Implementation Requirements:
        +
        If unit conversion is possible, this implementation returns + other.convertFromBase(this.convertToBase(value)). Therefore, overriding either of those methods + will change the output of this method.
        +
        +
        • +
      + + + +
        +
      • +

        convertToBase

        +
        protected abstract double convertToBase(double value)
        +
        Converts from a value expressed in this unit to a value expressed in this unit's base unit. +

        + This must be the inverse of convertFromBase, so convertToBase(convertFromBase(value)) must be + equal to value for any value, ignoring precision loss by roundoff error. +

        +

        + If this unit is a base unit, this method should return value. +

        +
        +
        Parameters:
        +
        value - value expressed in this unit
        +
        Returns:
        +
        value expressed in base unit
        +
        Since:
        +
        2018-12-22, v0.1.0
        +
        Implementation Requirements:
        +
        This method is used by convertTo(org.unitConverter.unit.Unit, double), and its behaviour affects the behaviour of + convertTo.
        +
        +
        • +
      + + + +
        +
      • +

        getBase

        +
        public final ObjectProduct<BaseUnit> getBase()
        +
        +
        Returns:
        +
        combination of units that this unit is based on
        +
        Since:
        +
        2018-12-22, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getDimension

        +
        public final ObjectProduct<BaseDimension> getDimension()
        +
        +
        Returns:
        +
        dimension measured by this unit
        +
        Since:
        +
        2018-12-22, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getOtherNames

        +
        public final java.util.Set<java.lang.String> getOtherNames()
        +
        +
        Returns:
        +
        additionalNames
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryName

        +
        public final java.util.Optional<java.lang.String> getPrimaryName()
        +
        +
        Returns:
        +
        primaryName
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        getSymbol

        +
        public final java.util.Optional<java.lang.String> getSymbol()
        +
        +
        Returns:
        +
        symbol
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        withName

        +
        public Unit withName(NameSymbol ns)
        +
        +
        Parameters:
        +
        ns - name(s) and symbol to use
        +
        Returns:
        +
        a copy of this unit with provided name(s) and symbol
        +
        Throws:
        +
        java.lang.NullPointerException - if ns is null
        +
        Since:
        +
        2019-10-21
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html new file mode 100644 index 0000000..65b640c --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html @@ -0,0 +1,499 @@ + + + + + +UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Map.Entry<java.lang.String,​Unit>
    +
    +
    +
    Enclosing class:
    +
    UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet
    +
    +
    +
    private static final class UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry
+extends java.lang.Object
+implements java.util.Map.Entry<java.lang.String,​Unit>
    +
    The entry for this set.
    +
    +
    Since:
    +
    2019-04-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.lang.Stringkey 
      private Unitvalue 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PrefixedUnitEntry​(java.lang.String key, + Unit value) +
      Creates the PrefixedUnitEntry.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      java.lang.StringgetKey() 
      UnitgetValue() 
      inthashCode() 
      UnitsetValue​(Unit value) 
      java.lang.StringtoString() +
      Returns a string representation of the entry.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        key

        +
        private final java.lang.String key
        +
        • +
      + + + +
        +
      • +

        value

        +
        private final Unit value
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrefixedUnitEntry

        +
        public PrefixedUnitEntry​(java.lang.String key,
+                         Unit value)
        +
        Creates the PrefixedUnitEntry.
        +
        +
        Parameters:
        +
        key - key
        +
        value - value
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public boolean equals​(java.lang.Object o)
        +
        +
        Specified by:
        +
        equals in interface java.util.Map.Entry<java.lang.String,​Unit>
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      + + + +
        +
      • +

        getKey

        +
        public java.lang.String getKey()
        +
        +
        Specified by:
        +
        getKey in interface java.util.Map.Entry<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        getValue

        +
        public Unit getValue()
        +
        +
        Specified by:
        +
        getValue in interface java.util.Map.Entry<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Specified by:
        +
        hashCode in interface java.util.Map.Entry<java.lang.String,​Unit>
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      + + + +
        +
      • +

        setValue

        +
        public Unit setValue​(Unit value)
        +
        +
        Specified by:
        +
        setValue in interface java.util.Map.Entry<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a string representation of the entry. The format of the string is the string representation + of the key, then the equals (=) character, then the string representation of the value.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html new file mode 100644 index 0000000..465ee75 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html @@ -0,0 +1,542 @@ + + + + + +UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<java.util.Map.Entry<java.lang.String,​Unit>>
    +
    +
    +
    Enclosing class:
    +
    UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet
    +
    +
    +
    private static final class UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator
+extends java.lang.Object
+implements java.util.Iterator<java.util.Map.Entry<java.lang.String,​Unit>>
    +
    An iterator that iterates over the units of a PrefixedUnitNameSet.
    +
    +
    Since:
    +
    2019-04-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.Map<java.lang.String,​Unit>map 
      private java.util.List<java.lang.Integer>prefixCoordinates 
      private java.util.List<java.lang.String>prefixNames 
      private intunitNamePosition 
      private java.util.List<java.lang.String>unitNames 
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private java.lang.StringgetCurrentUnitName() 
      booleanhasNext() 
      private voidincrementPosition() +
      Changes this iterator's position to the next available one.
      +
      java.util.Map.Entry<java.lang.String,​Unit>next() 
      private java.util.Map.Entry<java.lang.String,​Unit>peek() 
      java.lang.StringtoString() +
      Returns a string representation of the object.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Iterator

        +forEachRemaining, remove
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        unitNamePosition

        +
        private int unitNamePosition
        +
        • +
      + + + +
        +
      • +

        prefixCoordinates

        +
        private final java.util.List<java.lang.Integer> prefixCoordinates
        +
        • +
      + + + +
        +
      • +

        map

        +
        private final java.util.Map<java.lang.String,​Unit> map
        +
        • +
      + + + +
        +
      • +

        unitNames

        +
        private final transient java.util.List<java.lang.String> unitNames
        +
        • +
      + + + +
        +
      • +

        prefixNames

        +
        private final transient java.util.List<java.lang.String> prefixNames
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrefixedUnitEntryIterator

        +
        public PrefixedUnitEntryIterator​(UnitDatabase.PrefixedUnitMap map)
        +
        Creates the UnitsDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCurrentUnitName

        +
        private java.lang.String getCurrentUnitName()
        +
        +
        Returns:
        +
        current unit name
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        incrementPosition

        +
        private void incrementPosition()
        +
        Changes this iterator's position to the next available one.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public java.util.Map.Entry<java.lang.String,​Unit> next()
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        peek

        +
        private java.util.Map.Entry<java.lang.String,​Unit> peek()
        +
        +
        Returns:
        +
        the next element in the iterator, without iterating over it
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a string representation of the object. The exact details of the representation are + unspecified and subject to change.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html new file mode 100644 index 0000000..66e7804 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html @@ -0,0 +1,761 @@ + + + + + +UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractCollection<E>
      • +
    • +
        +
      • java.util.AbstractSet<java.util.Map.Entry<java.lang.String,​Unit>>
        • +
      • +
          +
        • org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<java.util.Map.Entry<java.lang.String,​Unit>>, java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>, java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
    +
    +
    +
    Enclosing class:
    +
    UnitDatabase.PrefixedUnitMap
    +
    +
    +
    private static final class UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet
+extends java.util.AbstractSet<java.util.Map.Entry<java.lang.String,​Unit>>
    +
    The class used for entry sets. + +

    + If the map that created this set is infinite in size (has at least one unit and at least one prefix), this + set is infinite as well. If this set is infinite in size, toArray() will fail with a + IllegalStateException instead of creating an infinite-sized array. +

    +
    +
    Since:
    +
    2019-04-13, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanadd​(java.util.Map.Entry<java.lang.String,​Unit> e) 
      booleanaddAll​(java.util.Collection<? extends java.util.Map.Entry<java.lang.String,​Unit>> c) 
      voidclear() 
      booleancontains​(java.lang.Object o) 
      booleancontainsAll​(java.util.Collection<?> c) 
      booleanisEmpty() 
      java.util.Iterator<java.util.Map.Entry<java.lang.String,​Unit>>iterator() 
      booleanremove​(java.lang.Object o) 
      booleanremoveAll​(java.util.Collection<?> c) 
      booleanremoveIf​(java.util.function.Predicate<? super java.util.Map.Entry<java.lang.String,​Unit>> filter) 
      booleanretainAll​(java.util.Collection<?> c) 
      intsize() 
      java.lang.Object[]toArray() 
      <T> T[]toArray​(T[] a) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractSet

        +equals, hashCode
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +parallelStream, stream, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Set

        +spliterator
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrefixedUnitEntrySet

        +
        public PrefixedUnitEntrySet​(UnitDatabase.PrefixedUnitMap map)
        +
        Creates the PrefixedUnitNameSet.
        +
        +
        Parameters:
        +
        map - map that created this set
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        add

        +
        public boolean add​(java.util.Map.Entry<java.lang.String,​Unit> e)
        +
        +
        Specified by:
        +
        add in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        add in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll​(java.util.Collection<? extends java.util.Map.Entry<java.lang.String,​Unit>> c)
        +
        +
        Specified by:
        +
        addAll in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        addAll in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        addAll in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        clear in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        clear in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains​(java.lang.Object o)
        +
        +
        Specified by:
        +
        contains in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        contains in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        contains in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        containsAll

        +
        public boolean containsAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        containsAll in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        containsAll in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        containsAll in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        isEmpty in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        isEmpty in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<java.util.Map.Entry<java.lang.String,​Unit>> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        iterator in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        iterator in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove​(java.lang.Object o)
        +
        +
        Specified by:
        +
        remove in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        remove in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        remove in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public boolean removeAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        removeAll in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        removeAll in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        removeAll in class java.util.AbstractSet<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        removeIf

        +
        public boolean removeIf​(java.util.function.Predicate<? super java.util.Map.Entry<java.lang.String,​Unit>> filter)
        +
        • +
      + + + +
        +
      • +

        retainAll

        +
        public boolean retainAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        retainAll in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        retainAll in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        retainAll in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        size in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public java.lang.Object[] toArray()
        +
        +
        Specified by:
        +
        toArray in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        toArray in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        toArray in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Throws:
        +
        java.lang.IllegalStateException - if the set is infinite in size
        +
        +
        • +
      + + + + + +
        +
      • +

        toArray

        +
        public <T> T[] toArray​(T[] a)
        +
        +
        Specified by:
        +
        toArray in interface java.util.Collection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Specified by:
        +
        toArray in interface java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Overrides:
        +
        toArray in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        Throws:
        +
        java.lang.IllegalStateException - if the set is infinite in size
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.util.AbstractCollection<java.util.Map.Entry<java.lang.String,​Unit>>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html new file mode 100644 index 0000000..0e4a161 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html @@ -0,0 +1,542 @@ + + + + + +UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<java.lang.String>
    +
    +
    +
    Enclosing class:
    +
    UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet
    +
    +
    +
    private static final class UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator
+extends java.lang.Object
+implements java.util.Iterator<java.lang.String>
    +
    An iterator that iterates over the units of a PrefixedUnitNameSet.
    +
    +
    Since:
    +
    2019-04-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.Map<java.lang.String,​Unit>map 
      private java.util.List<java.lang.Integer>prefixCoordinates 
      private java.util.List<java.lang.String>prefixNames 
      private intunitNamePosition 
      private java.util.List<java.lang.String>unitNames 
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private java.lang.StringgetCurrentUnitName() 
      booleanhasNext() 
      private voidincrementPosition() +
      Changes this iterator's position to the next available one.
      +
      java.lang.Stringnext() 
      private java.lang.Stringpeek() 
      java.lang.StringtoString() +
      Returns a string representation of the object.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Iterator

        +forEachRemaining, remove
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        unitNamePosition

        +
        private int unitNamePosition
        +
        • +
      + + + +
        +
      • +

        prefixCoordinates

        +
        private final java.util.List<java.lang.Integer> prefixCoordinates
        +
        • +
      + + + +
        +
      • +

        map

        +
        private final java.util.Map<java.lang.String,​Unit> map
        +
        • +
      + + + +
        +
      • +

        unitNames

        +
        private final transient java.util.List<java.lang.String> unitNames
        +
        • +
      + + + +
        +
      • +

        prefixNames

        +
        private final transient java.util.List<java.lang.String> prefixNames
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrefixedUnitNameIterator

        +
        public PrefixedUnitNameIterator​(UnitDatabase.PrefixedUnitMap map)
        +
        Creates the UnitsDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCurrentUnitName

        +
        private java.lang.String getCurrentUnitName()
        +
        +
        Returns:
        +
        current unit name
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        public boolean hasNext()
        +
        +
        Specified by:
        +
        hasNext in interface java.util.Iterator<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        incrementPosition

        +
        private void incrementPosition()
        +
        Changes this iterator's position to the next available one.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        next

        +
        public java.lang.String next()
        +
        +
        Specified by:
        +
        next in interface java.util.Iterator<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        peek

        +
        private java.lang.String peek()
        +
        +
        Returns:
        +
        the next element in the iterator, without iterating over it
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Returns a string representation of the object. The exact details of the representation are + unspecified and subject to change.
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html new file mode 100644 index 0000000..8794e15 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html @@ -0,0 +1,754 @@ + + + + + +UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractCollection<E>
      • +
    • +
        +
      • java.util.AbstractSet<java.lang.String>
        • +
      • +
          +
        • org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<java.lang.String>, java.util.Collection<java.lang.String>, java.util.Set<java.lang.String>
    +
    +
    +
    Enclosing class:
    +
    UnitDatabase.PrefixedUnitMap
    +
    +
    +
    private static final class UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet
+extends java.util.AbstractSet<java.lang.String>
    +
    The class used for unit name sets. + +

    + If the map that created this set is infinite in size (has at least one unit and at least one prefix), this + set is infinite as well. If this set is infinite in size, toArray() will fail with a + IllegalStateException instead of creating an infinite-sized array. +

    +
    +
    Since:
    +
    2019-04-13, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanadd​(java.lang.String e) 
      booleanaddAll​(java.util.Collection<? extends java.lang.String> c) 
      voidclear() 
      booleancontains​(java.lang.Object o) 
      booleancontainsAll​(java.util.Collection<?> c) 
      booleanisEmpty() 
      java.util.Iterator<java.lang.String>iterator() 
      booleanremove​(java.lang.Object o) 
      booleanremoveAll​(java.util.Collection<?> c) 
      booleanremoveIf​(java.util.function.Predicate<? super java.lang.String> filter) 
      booleanretainAll​(java.util.Collection<?> c) 
      intsize() 
      java.lang.Object[]toArray() 
      <T> T[]toArray​(T[] a) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractSet

        +equals, hashCode
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Collection

        +parallelStream, stream, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Set

        +spliterator
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrefixedUnitNameSet

        +
        public PrefixedUnitNameSet​(UnitDatabase.PrefixedUnitMap map)
        +
        Creates the PrefixedUnitNameSet.
        +
        +
        Parameters:
        +
        map - map that created this set
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        add

        +
        public boolean add​(java.lang.String e)
        +
        +
        Specified by:
        +
        add in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        add in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll​(java.util.Collection<? extends java.lang.String> c)
        +
        +
        Specified by:
        +
        addAll in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        addAll in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        addAll in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        clear in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        clear in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains​(java.lang.Object o)
        +
        +
        Specified by:
        +
        contains in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        contains in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        contains in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        containsAll

        +
        public boolean containsAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        containsAll in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        containsAll in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        containsAll in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        isEmpty in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        isEmpty in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<java.lang.String> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<java.lang.String>
        +
        Specified by:
        +
        iterator in interface java.util.Set<java.lang.String>
        +
        Specified by:
        +
        iterator in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove​(java.lang.Object o)
        +
        +
        Specified by:
        +
        remove in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        remove in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        remove in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public boolean removeAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        removeAll in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        removeAll in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        removeAll in class java.util.AbstractSet<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        removeIf

        +
        public boolean removeIf​(java.util.function.Predicate<? super java.lang.String> filter)
        +
        • +
      + + + +
        +
      • +

        retainAll

        +
        public boolean retainAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        retainAll in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        retainAll in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        retainAll in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        size in interface java.util.Set<java.lang.String>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public java.lang.Object[] toArray()
        +
        +
        Specified by:
        +
        toArray in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        toArray in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        toArray in class java.util.AbstractCollection<java.lang.String>
        +
        Throws:
        +
        java.lang.IllegalStateException - if the set is infinite in size
        +
        +
        • +
      + + + + + +
        +
      • +

        toArray

        +
        public <T> T[] toArray​(T[] a)
        +
        +
        Specified by:
        +
        toArray in interface java.util.Collection<java.lang.String>
        +
        Specified by:
        +
        toArray in interface java.util.Set<java.lang.String>
        +
        Overrides:
        +
        toArray in class java.util.AbstractCollection<java.lang.String>
        +
        Throws:
        +
        java.lang.IllegalStateException - if the set is infinite in size
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.util.AbstractCollection<java.lang.String>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html new file mode 100644 index 0000000..5ed1f84 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.PrefixedUnitMap.html @@ -0,0 +1,930 @@ + + + + + +UnitDatabase.PrefixedUnitMap + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabase.PrefixedUnitMap

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.unit.UnitDatabase.PrefixedUnitMap
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Map<java.lang.String,​Unit>
    +
    +
    +
    Enclosing class:
    +
    UnitDatabase
    +
    +
    +
    private static final class UnitDatabase.PrefixedUnitMap
+extends java.lang.Object
+implements java.util.Map<java.lang.String,​Unit>
    +
    A map for units that allows the use of prefixes. +

    + As this map implementation is intended to be used as a sort of "augmented view" of a unit and prefix map, it is + unmodifiable but instead reflects the changes to the maps passed into it. Do not edit this map, instead edit the + maps that were passed in during construction. +

    +

    + The rules for applying prefixes onto units are the following: +

      +
    • Prefixes can only be applied to linear units.
      • +
    • Before attempting to search for prefixes in a unit name, this map will first search for a unit name. So, if + there are two units, "B" and "AB", and a prefix "A", this map will favour the unit "AB" over the unit "B" with + the prefix "A", even though they have the same string.
      • +
    • Longer prefixes are preferred to shorter prefixes. So, if you have units "BC" and "C", and prefixes "AB" and + "A", inputting "ABC" will return the unit "C" with the prefix "AB", not "BC" with the prefix "A".
      • +
    +

    +

    + This map is infinite in size if there is at least one unit and at least one prefix. If it is infinite, some + operations that only work with finite collections, like converting name/entry sets to arrays, will throw an + IllegalStateException. +

    +

    + Because of ambiguities between prefixes (i.e. kilokilo = mega), containsValue(java.lang.Object) and values() + currently ignore prefixes. +

    +
    +
    Since:
    +
    2019-04-13, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>entrySet 
      private java.util.Set<java.lang.String>keySet 
      private java.util.Map<java.lang.String,​UnitPrefix>prefixes +
      The available prefixes for use.
      +
      private java.util.Map<java.lang.String,​Unit>units +
      The units stored in this collection, without prefixes.
      +
      private java.util.Collection<Unit>values 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PrefixedUnitMap​(java.util.Map<java.lang.String,​Unit> units, + java.util.Map<java.lang.String,​UnitPrefix> prefixes) +
      Creates the PrefixedUnitMap.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidclear() 
      Unitcompute​(java.lang.String key, + java.util.function.BiFunction<? super java.lang.String,​? super Unit,​? extends Unit> remappingFunction) 
      UnitcomputeIfAbsent​(java.lang.String key, + java.util.function.Function<? super java.lang.String,​? extends Unit> mappingFunction) 
      UnitcomputeIfPresent​(java.lang.String key, + java.util.function.BiFunction<? super java.lang.String,​? super Unit,​? extends Unit> remappingFunction) 
      booleancontainsKey​(java.lang.Object key) 
      booleancontainsValue​(java.lang.Object value)
      java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>>entrySet() 
      Unitget​(java.lang.Object key) 
      booleanisEmpty() 
      java.util.Set<java.lang.String>keySet() 
      Unitmerge​(java.lang.String key, + Unit value, + java.util.function.BiFunction<? super Unit,​? super Unit,​? extends Unit> remappingFunction) 
      Unitput​(java.lang.String key, + Unit value) 
      voidputAll​(java.util.Map<? extends java.lang.String,​? extends Unit> m) 
      UnitputIfAbsent​(java.lang.String key, + Unit value) 
      Unitremove​(java.lang.Object key) 
      booleanremove​(java.lang.Object key, + java.lang.Object value) 
      Unitreplace​(java.lang.String key, + Unit value) 
      booleanreplace​(java.lang.String key, + Unit oldValue, + Unit newValue) 
      voidreplaceAll​(java.util.function.BiFunction<? super java.lang.String,​? super Unit,​? extends Unit> function) 
      intsize() 
      java.lang.StringtoString() 
      java.util.Collection<Unit>values()
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Map

        +equals, forEach, getOrDefault, hashCode
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        units

        +
        private final java.util.Map<java.lang.String,​Unit> units
        +
        The units stored in this collection, without prefixes.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        prefixes

        +
        private final java.util.Map<java.lang.String,​UnitPrefix> prefixes
        +
        The available prefixes for use.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        private transient java.util.Collection<Unit> values
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        private transient java.util.Set<java.lang.String> keySet
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        private transient java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>> entrySet
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PrefixedUnitMap

        +
        public PrefixedUnitMap​(java.util.Map<java.lang.String,​Unit> units,
+                       java.util.Map<java.lang.String,​UnitPrefix> prefixes)
        +
        Creates the PrefixedUnitMap.
        +
        +
        Parameters:
        +
        units - map mapping unit names to units
        +
        prefixes - map mapping prefix names to prefixes
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        compute

        +
        public Unit compute​(java.lang.String key,
+                    java.util.function.BiFunction<? super java.lang.String,​? super Unit,​? extends Unit> remappingFunction)
        +
        +
        Specified by:
        +
        compute in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        computeIfAbsent

        +
        public Unit computeIfAbsent​(java.lang.String key,
+                            java.util.function.Function<? super java.lang.String,​? extends Unit> mappingFunction)
        +
        +
        Specified by:
        +
        computeIfAbsent in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        computeIfPresent

        +
        public Unit computeIfPresent​(java.lang.String key,
+                             java.util.function.BiFunction<? super java.lang.String,​? super Unit,​? extends Unit> remappingFunction)
        +
        +
        Specified by:
        +
        computeIfPresent in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey​(java.lang.Object key)
        +
        +
        Specified by:
        +
        containsKey in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        containsValue

        +
        public boolean containsValue​(java.lang.Object value)
        +
        + +

        + Because of ambiguities between prefixes (i.e. kilokilo = mega), this method only tests for prefixless units. +

        +
        +
        Specified by:
        +
        containsValue in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set<java.util.Map.Entry<java.lang.String,​Unit>> entrySet()
        +
        +
        Specified by:
        +
        entrySet in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public Unit get​(java.lang.Object key)
        +
        +
        Specified by:
        +
        get in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<java.lang.String> keySet()
        +
        +
        Specified by:
        +
        keySet in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        merge

        +
        public Unit merge​(java.lang.String key,
+                  Unit value,
+                  java.util.function.BiFunction<? super Unit,​? super Unit,​? extends Unit> remappingFunction)
        +
        +
        Specified by:
        +
        merge in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        put

        +
        public Unit put​(java.lang.String key,
+                Unit value)
        +
        +
        Specified by:
        +
        put in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        putAll

        +
        public void putAll​(java.util.Map<? extends java.lang.String,​? extends Unit> m)
        +
        +
        Specified by:
        +
        putAll in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        putIfAbsent

        +
        public Unit putIfAbsent​(java.lang.String key,
+                        Unit value)
        +
        +
        Specified by:
        +
        putIfAbsent in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public Unit remove​(java.lang.Object key)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove​(java.lang.Object key,
+                      java.lang.Object value)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        replace

        +
        public Unit replace​(java.lang.String key,
+                    Unit value)
        +
        +
        Specified by:
        +
        replace in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        replace

        +
        public boolean replace​(java.lang.String key,
+                       Unit oldValue,
+                       Unit newValue)
        +
        +
        Specified by:
        +
        replace in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        replaceAll

        +
        public void replaceAll​(java.util.function.BiFunction<? super java.lang.String,​? super Unit,​? extends Unit> function)
        +
        +
        Specified by:
        +
        replaceAll in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<Unit> values()
        +
        + +

        + Because of ambiguities between prefixes (i.e. kilokilo = mega), this method ignores prefixes. +

        +
        +
        Specified by:
        +
        values in interface java.util.Map<java.lang.String,​Unit>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitDatabase.html b/doc/org/unitConverter/unit/UnitDatabase.html new file mode 100644 index 0000000..d62f73a --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabase.html @@ -0,0 +1,789 @@ + + + + + +UnitDatabase + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.unit
+

Class UnitDatabase

+
+
+ +
+
    +
  • +
    +
    +
    public final class UnitDatabase
+extends java.lang.Object
    +
    A database of units, prefixes and dimensions, and their names.
    +
    +
    Since:
    +
    2019-01-07, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      UnitDatabase() +
      Creates the UnitsDatabase.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      voidaddDimension(java.lang.String name, + ObjectProduct<BaseDimension> dimension) +
      Adds a unit dimension to the database.
      +
      voidaddPrefix(java.lang.String name, + UnitPrefix prefix) +
      Adds a unit prefix to the database.
      +
      voidaddUnit(java.lang.String name, + Unit unit) +
      Adds a unit to the database.
      +
      booleancontainsDimensionName(java.lang.String name) +
      Tests if the database has a unit dimension with this name.
      +
      booleancontainsPrefixName(java.lang.String name) +
      Tests if the database has a unit prefix with this name.
      +
      booleancontainsUnitName(java.lang.String name) +
      Tests if the database has a unit with this name, taking prefixes into consideration
      +
      java.util.Map<java.lang.String,ObjectProduct<BaseDimension>>dimensionMap() 
      ObjectProduct<BaseDimension>getDimension(java.lang.String name) +
      Gets a unit dimension from the database using its name.
      +
      ObjectProduct<BaseDimension>getDimensionFromExpression(java.lang.String expression) +
      Uses the database's data to parse an expression into a unit dimension
      +
      UnitPrefixgetPrefix(java.lang.String name) +
      Gets a unit prefix from the database from its name
      +
      UnitPrefixgetPrefixFromExpression(java.lang.String expression) +
      Gets a unit prefix from a prefix expression
      +
      UnitgetUnit(java.lang.String name) +
      Gets a unit from the database from its name, looking for prefixes.
      +
      UnitgetUnitFromExpression(java.lang.String expression) +
      Uses the database's unit data to parse an expression into a unit
      +
      voidloadDimensionFile(java.io.File file) +
      Adds all dimensions from a file, using data from the database to parse them.
      +
      voidloadUnitsFile(java.io.File file) +
      Adds all units from a file, using data from the database to parse them.
      +
      java.util.Map<java.lang.String,UnitPrefix>prefixMap() 
      java.lang.StringtoString() 
      java.util.Map<java.lang.String,Unit>unitMap() +
      Returns a map mapping unit names to units, including units with prefixes.
      +
      java.util.Map<java.lang.String,Unit>unitMapPrefixless() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnitDatabase

        +
        public UnitDatabase()
        +
        Creates the UnitsDatabase.
        +
        +
        Since:
        +
        2019-01-10, v0.1.0
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addDimension

        +
        public void addDimension(java.lang.String name,
+                         ObjectProduct<BaseDimension> dimension)
        +
        Adds a unit dimension to the database.
        +
        +
        Parameters:
        +
        name - dimension's name
        +
        dimension - dimension to add
        +
        Throws:
        +
        java.lang.NullPointerException - if name or dimension is null
        +
        Since:
        +
        2019-03-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        addPrefix

        +
        public void addPrefix(java.lang.String name,
+                      UnitPrefix prefix)
        +
        Adds a unit prefix to the database.
        +
        +
        Parameters:
        +
        name - prefix's name
        +
        prefix - prefix to add
        +
        Throws:
        +
        java.lang.NullPointerException - if name or prefix is null
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        addUnit

        +
        public void addUnit(java.lang.String name,
+                    Unit unit)
        +
        Adds a unit to the database.
        +
        +
        Parameters:
        +
        name - unit's name
        +
        unit - unit to add
        +
        Throws:
        +
        java.lang.NullPointerException - if unit is null
        +
        Since:
        +
        2019-01-10, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        containsDimensionName

        +
        public boolean containsDimensionName(java.lang.String name)
        +
        Tests if the database has a unit dimension with this name.
        +
        +
        Parameters:
        +
        name - name to test
        +
        Returns:
        +
        if database contains name
        +
        Since:
        +
        2019-03-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        containsPrefixName

        +
        public boolean containsPrefixName(java.lang.String name)
        +
        Tests if the database has a unit prefix with this name.
        +
        +
        Parameters:
        +
        name - name to test
        +
        Returns:
        +
        if database contains name
        +
        Since:
        +
        2019-01-13, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        containsUnitName

        +
        public boolean containsUnitName(java.lang.String name)
        +
        Tests if the database has a unit with this name, taking prefixes into consideration
        +
        +
        Parameters:
        +
        name - name to test
        +
        Returns:
        +
        if database contains name
        +
        Since:
        +
        2019-01-13, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        dimensionMap

        +
        public java.util.Map<java.lang.String,ObjectProduct<BaseDimension>> dimensionMap()
        +
        +
        Returns:
        +
        a map mapping dimension names to dimensions
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getDimension

        +
        public ObjectProduct<BaseDimension> getDimension(java.lang.String name)
        +
        Gets a unit dimension from the database using its name. + +

        + This method accepts exponents, like "L^3" +

        +
        +
        Parameters:
        +
        name - dimension's name
        +
        Returns:
        +
        dimension
        +
        Since:
        +
        2019-03-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getDimensionFromExpression

        +
        public ObjectProduct<BaseDimension> getDimensionFromExpression(java.lang.String expression)
        +
        Uses the database's data to parse an expression into a unit dimension +

        + The expression is a series of any of the following: +

          +
        • The name of a unit dimension, which multiplies or divides the result based on preceding operators
          • +
        • The operators '*' and '/', which multiply and divide (note that just putting two unit dimensions next to each + other is equivalent to multiplication)
          • +
        • The operator '^' which exponentiates. Exponents must be integers.
          • +
        +
        +
        Parameters:
        +
        expression - expression to parse
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the expression cannot be parsed
        +
        java.lang.NullPointerException - if expression is null
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPrefix

        +
        public UnitPrefix getPrefix(java.lang.String name)
        +
        Gets a unit prefix from the database from its name
        +
        +
        Parameters:
        +
        name - prefix's name
        +
        Returns:
        +
        prefix
        +
        Since:
        +
        2019-01-10, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixFromExpression

        +
        public UnitPrefix getPrefixFromExpression(java.lang.String expression)
        +
        Gets a unit prefix from a prefix expression +

        + Currently, prefix expressions are much simpler than unit expressions: They are either a number or the name of + another prefix +

        +
        +
        Parameters:
        +
        expression - expression to input
        +
        Returns:
        +
        prefix
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if expression cannot be parsed
        +
        java.lang.NullPointerException - if any argument is null
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getUnit

        +
        public Unit getUnit(java.lang.String name)
        +
        Gets a unit from the database from its name, looking for prefixes.
        +
        +
        Parameters:
        +
        name - unit's name
        +
        Returns:
        +
        unit
        +
        Since:
        +
        2019-01-10, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getUnitFromExpression

        +
        public Unit getUnitFromExpression(java.lang.String expression)
        +
        Uses the database's unit data to parse an expression into a unit +

        + The expression is a series of any of the following: +

          +
        • The name of a unit, which multiplies or divides the result based on preceding operators
          • +
        • The operators '*' and '/', which multiply and divide (note that just putting two units or values next to each + other is equivalent to multiplication)
          • +
        • The operator '^' which exponentiates. Exponents must be integers.
          • +
        • A number which is multiplied or divided
          • +
        + This method only works with linear units.
        +
        +
        Parameters:
        +
        expression - expression to parse
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the expression cannot be parsed
        +
        java.lang.NullPointerException - if expression is null
        +
        Since:
        +
        2019-01-07, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        loadDimensionFile

        +
        public void loadDimensionFile(java.io.File file)
        +
        Adds all dimensions from a file, using data from the database to parse them. +

        + Each line in the file should consist of a name and an expression (parsed by getDimensionFromExpression) separated + by any number of tab characters. +

        +

        + Allowed exceptions: +

          +
        • Anything after a '#' character is considered a comment and ignored.
          • +
        • Blank lines are also ignored
          • +
        • If an expression consists of a single exclamation point, instead of parsing it, this method will search the + database for an existing unit. If no unit is found, an IllegalArgumentException is thrown. This is used to define + initial units and ensure that the database contains them.
          • +
        +
        +
        Parameters:
        +
        file - file to read
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the file cannot be parsed, found or read
        +
        java.lang.NullPointerException - if file is null
        +
        Since:
        +
        2019-01-13, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        loadUnitsFile

        +
        public void loadUnitsFile(java.io.File file)
        +
        Adds all units from a file, using data from the database to parse them. +

        + Each line in the file should consist of a name and an expression (parsed by getUnitFromExpression) separated by + any number of tab characters. +

        +

        + Allowed exceptions: +

          +
        • Anything after a '#' character is considered a comment and ignored.
          • +
        • Blank lines are also ignored
          • +
        • If an expression consists of a single exclamation point, instead of parsing it, this method will search the + database for an existing unit. If no unit is found, an IllegalArgumentException is thrown. This is used to define + initial units and ensure that the database contains them.
          • +
        +
        +
        Parameters:
        +
        file - file to read
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the file cannot be parsed, found or read
        +
        java.lang.NullPointerException - if file is null
        +
        Since:
        +
        2019-01-13, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        prefixMap

        +
        public java.util.Map<java.lang.String,UnitPrefix> prefixMap()
        +
        +
        Returns:
        +
        a map mapping prefix names to prefixes
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        a string stating the number of units, prefixes and dimensions in the database
        +
        +
        • +
      + + + +
        +
      • +

        unitMap

        +
        public java.util.Map<java.lang.String,Unit> unitMap()
        +
        Returns a map mapping unit names to units, including units with prefixes. +

        + The returned map is infinite in size if there is at least one unit and at least one prefix. If it is infinite, + some operations that only work with finite collections, like converting name/entry sets to arrays, will throw an + IllegalStateException. +

        +

        + Specifically, the operations that will throw an IllegalStateException if the map is infinite in size are: +

          +
        • unitMap.entrySet().toArray() (either overloading)
          • +
        • unitMap.keySet().toArray() (either overloading)
          • +
        +

        +

        + Because of ambiguities between prefixes (i.e. kilokilo = mega), the map's containsValue and values() methods currently ignore prefixes. +

        +
        +
        Returns:
        +
        a map mapping unit names to units, including prefixed names
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        unitMapPrefixless

        +
        public java.util.Map<java.lang.String,Unit> unitMapPrefixless()
        +
        +
        Returns:
        +
        a map mapping unit names to units, ignoring prefixes
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/UnitDatabaseTest.html b/doc/org/unitConverter/unit/UnitDatabaseTest.html new file mode 100644 index 0000000..1b88314 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitDatabaseTest.html @@ -0,0 +1,643 @@ + + + + + +UnitDatabaseTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitDatabaseTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.unit.UnitDatabaseTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class UnitDatabaseTest
+extends java.lang.Object
    +
    A test for the UnitDatabase class. This is NOT part of this program's public API.
    +
    +
    Since:
    +
    2019-04-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      UnitDatabaseTest() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidtestInfiniteSetExceptions() +
      Confirms that operations that shouldn't function for infinite databases throw an IllegalStateException.
      +
      voidtestPrefixes() +
      Test that prefixes correctly apply to units.
      +
      voidtestPrefixlessUnitMap() +
      Tests the functionnalites of the prefixless unit map.
      +
      voidtestPrefixlessUnits() +
      Tests that the database correctly stores and retrieves units, ignoring prefixes.
      +
      voidtestUnitExpressions() +
      Test that unit expressions return the correct value.
      +
      voidtestUnitIterator() +
      Tests both the unit name iterator and the name-unit entry iterator
      +
      voidtestUnitPrefixCombinations() +
      Determine, given a unit name that could mean multiple things, which meaning is chosen.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnitDatabaseTest

        +
        UnitDatabaseTest()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        testInfiniteSetExceptions

        +
        @Test
+public void testInfiniteSetExceptions()
        +
        Confirms that operations that shouldn't function for infinite databases throw an IllegalStateException.
        +
        +
        Since:
        +
        2019-05-03
        +
        +
        • +
      + + + +
        +
      • +

        testPrefixes

        +
        @Test
+public void testPrefixes()
        +
        Test that prefixes correctly apply to units.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        testPrefixlessUnitMap

        +
        @Test
+public void testPrefixlessUnitMap()
        +
        Tests the functionnalites of the prefixless unit map. + +

        + The map should be an auto-updating view of the units in the database. +

        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        testPrefixlessUnits

        +
        @Test
+public void testPrefixlessUnits()
        +
        Tests that the database correctly stores and retrieves units, ignoring prefixes.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        testUnitExpressions

        +
        @Test
+public void testUnitExpressions()
        +
        Test that unit expressions return the correct value.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        testUnitIterator

        +
        @Test
+public void testUnitIterator()
        +
        Tests both the unit name iterator and the name-unit entry iterator
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        testUnitPrefixCombinations

        +
        @Test
+public void testUnitPrefixCombinations()
        +
        Determine, given a unit name that could mean multiple things, which meaning is chosen. +

        + For example, "ABCU" could mean "A-B-C-U", "AB-C-U", or "A-BC-U". In this case, "AB-C-U" is the correct choice. +

        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/UnitPrefix.html b/doc/org/unitConverter/unit/UnitPrefix.html new file mode 100644 index 0000000..04e6256 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitPrefix.html @@ -0,0 +1,570 @@ + + + + + +UnitPrefix + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.unit
+

Class UnitPrefix

+
+
+ +
+
    +
  • +
    +
    +
    public final class UnitPrefix
+extends java.lang.Object
    +
    A prefix that can be applied to a LinearUnit to multiply it by some value
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        valueOf

        +
        public static UnitPrefix valueOf(double multiplier)
        +
        Gets a UnitPrefix from a multiplier
        +
        +
        Parameters:
        +
        multiplier - multiplier of prefix
        +
        Returns:
        +
        prefix
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static UnitPrefix valueOf(double multiplier,
+                                 NameSymbol ns)
        +
        Gets a UnitPrefix from a multiplier and a name
        +
        +
        Parameters:
        +
        multiplier - multiplier of prefix
        +
        ns - name(s) and symbol of prefix
        +
        Returns:
        +
        prefix
        +
        Throws:
        +
        java.lang.NullPointerException - if ns is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        dividedBy

        +
        public UnitPrefix dividedBy(double divisor)
        +
        Divides this prefix by a scalar
        +
        +
        Parameters:
        +
        divisor - number to divide by
        +
        Returns:
        +
        quotient of prefix and scalar
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        dividedBy

        +
        public UnitPrefix dividedBy(UnitPrefix other)
        +
        Divides this prefix by other.
        +
        +
        Parameters:
        +
        other - prefix to divide by
        +
        Returns:
        +
        quotient of prefixes
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        + + Uses the prefix's multiplier to determine equality.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        getMultiplier

        +
        public double getMultiplier()
        +
        +
        Returns:
        +
        prefix's multiplier
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      + + + +
        +
      • +

        getOtherNames

        +
        public final java.util.Set<java.lang.String> getOtherNames()
        +
        +
        Returns:
        +
        other names
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      + + + +
        +
      • +

        getPrimaryName

        +
        public final java.util.Optional<java.lang.String> getPrimaryName()
        +
        +
        Returns:
        +
        primary name
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      + + + +
        +
      • +

        getSymbol

        +
        public final java.util.Optional<java.lang.String> getSymbol()
        +
        +
        Returns:
        +
        symbol
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        + + Uses the prefix's multiplier to determine a hash code.
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        times

        +
        public UnitPrefix times(double multiplicand)
        +
        Multiplies this prefix by a scalar
        +
        +
        Parameters:
        +
        multiplicand - number to multiply by
        +
        Returns:
        +
        product of prefix and scalar
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        times

        +
        public UnitPrefix times(UnitPrefix other)
        +
        Multiplies this prefix by other.
        +
        +
        Parameters:
        +
        other - prefix to multiply by
        +
        Returns:
        +
        product of prefixes
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        toExponent

        +
        public UnitPrefix toExponent(double exponent)
        +
        Raises this prefix to an exponent.
        +
        +
        Parameters:
        +
        exponent - exponent to raise to
        +
        Returns:
        +
        result of exponentiation.
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        Returns:
        +
        a string describing the prefix and its multiplier
        +
        +
        • +
      + + + +
        +
      • +

        withName

        +
        public UnitPrefix withName(NameSymbol ns)
        +
        +
        Parameters:
        +
        ns - name(s) and symbol to use
        +
        Returns:
        +
        copy of this prefix with provided name(s) and symbol
        +
        Throws:
        +
        java.lang.NullPointerException - if ns is null
        +
        Since:
        +
        2019-11-26
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/UnitTest.html b/doc/org/unitConverter/unit/UnitTest.html new file mode 100644 index 0000000..ea13777 --- /dev/null +++ b/doc/org/unitConverter/unit/UnitTest.html @@ -0,0 +1,420 @@ + + + + + +UnitTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.unit
+

Class UnitTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.unit.UnitTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class UnitTest
+extends java.lang.Object
    +
    Testing the various Unit classes. This is NOT part of this program's public API.
    +
    +
    Since:
    +
    2018-12-22, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        rng

        +
        private static final java.util.Random rng
        +
        A random number generator
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnitTest

        +
        UnitTest()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        testAdditionAndSubtraction

        +
        @Test
+public void testAdditionAndSubtraction()
        +
        • +
      + + + +
        +
      • +

        testConversion

        +
        @Test
+public void testConversion()
        +
        • +
      + + + +
        +
      • +

        testEquals

        +
        @Test
+public void testEquals()
        +
        • +
      + + + +
        +
      • +

        testMultiplicationAndDivision

        +
        @Test
+public void testMultiplicationAndDivision()
        +
        • +
      + + + +
        +
      • +

        testPrefixes

        +
        @Test
+public void testPrefixes()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/unit/class-use/BaseDimension.html b/doc/org/unitConverter/unit/class-use/BaseDimension.html new file mode 100644 index 0000000..7ff411e --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BaseDimension.html @@ -0,0 +1,470 @@ + + + + + +Uses of Class org.unitConverter.unit.BaseDimension + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BaseDimension

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/BaseUnit.html b/doc/org/unitConverter/unit/class-use/BaseUnit.html new file mode 100644 index 0000000..48598fc --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BaseUnit.html @@ -0,0 +1,296 @@ + + + + + +Uses of Class org.unitConverter.unit.BaseUnit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BaseUnit

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/BritishImperial.Area.html b/doc/org/unitConverter/unit/class-use/BritishImperial.Area.html new file mode 100644 index 0000000..5e10bda --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BritishImperial.Area.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.BritishImperial.Area + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BritishImperial.Area

+
+
No usage of org.unitConverter.unit.BritishImperial.Area
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/BritishImperial.Length.html b/doc/org/unitConverter/unit/class-use/BritishImperial.Length.html new file mode 100644 index 0000000..5b5e9dc --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BritishImperial.Length.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.BritishImperial.Length + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BritishImperial.Length

+
+
No usage of org.unitConverter.unit.BritishImperial.Length
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/BritishImperial.Mass.html b/doc/org/unitConverter/unit/class-use/BritishImperial.Mass.html new file mode 100644 index 0000000..4af05d9 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BritishImperial.Mass.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.BritishImperial.Mass + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BritishImperial.Mass

+
+
No usage of org.unitConverter.unit.BritishImperial.Mass
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/BritishImperial.Volume.html b/doc/org/unitConverter/unit/class-use/BritishImperial.Volume.html new file mode 100644 index 0000000..715c7ce --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BritishImperial.Volume.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.BritishImperial.Volume + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BritishImperial.Volume

+
+
No usage of org.unitConverter.unit.BritishImperial.Volume
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/BritishImperial.html b/doc/org/unitConverter/unit/class-use/BritishImperial.html new file mode 100644 index 0000000..c2a34ed --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/BritishImperial.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.BritishImperial + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.BritishImperial

+
+
No usage of org.unitConverter.unit.BritishImperial
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/FunctionalUnit.html b/doc/org/unitConverter/unit/class-use/FunctionalUnit.html new file mode 100644 index 0000000..e63c6ab --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/FunctionalUnit.html @@ -0,0 +1,199 @@ + + + + + +Uses of Class org.unitConverter.unit.FunctionalUnit + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.FunctionalUnit

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/LinearUnit.html b/doc/org/unitConverter/unit/class-use/LinearUnit.html new file mode 100644 index 0000000..353978e --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/LinearUnit.html @@ -0,0 +1,926 @@ + + + + + +Uses of Class org.unitConverter.unit.LinearUnit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.LinearUnit

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/NameSymbol.html b/doc/org/unitConverter/unit/class-use/NameSymbol.html new file mode 100644 index 0000000..eece8b2 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/NameSymbol.html @@ -0,0 +1,324 @@ + + + + + +Uses of Class org.unitConverter.unit.NameSymbol + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.NameSymbol

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/SI.BaseDimensions.html b/doc/org/unitConverter/unit/class-use/SI.BaseDimensions.html new file mode 100644 index 0000000..4d79069 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/SI.BaseDimensions.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.SI.BaseDimensions + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.SI.BaseDimensions

+
+
No usage of org.unitConverter.unit.SI.BaseDimensions
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/SI.BaseUnits.html b/doc/org/unitConverter/unit/class-use/SI.BaseUnits.html new file mode 100644 index 0000000..ff04c69 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/SI.BaseUnits.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.SI.BaseUnits + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.SI.BaseUnits

+
+
No usage of org.unitConverter.unit.SI.BaseUnits
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/SI.Constants.html b/doc/org/unitConverter/unit/class-use/SI.Constants.html new file mode 100644 index 0000000..cc27e64 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/SI.Constants.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.SI.Constants + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.SI.Constants

+
+
No usage of org.unitConverter.unit.SI.Constants
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/SI.Dimensions.html b/doc/org/unitConverter/unit/class-use/SI.Dimensions.html new file mode 100644 index 0000000..8dd5ed0 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/SI.Dimensions.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.SI.Dimensions + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.SI.Dimensions

+
+
No usage of org.unitConverter.unit.SI.Dimensions
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/SI.html b/doc/org/unitConverter/unit/class-use/SI.html new file mode 100644 index 0000000..ed8577b --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/SI.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.SI + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.SI

+
+
No usage of org.unitConverter.unit.SI
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/USCustomary.Area.html b/doc/org/unitConverter/unit/class-use/USCustomary.Area.html new file mode 100644 index 0000000..b29fcd1 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/USCustomary.Area.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.USCustomary.Area + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.USCustomary.Area

+
+
No usage of org.unitConverter.unit.USCustomary.Area
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/USCustomary.Length.html b/doc/org/unitConverter/unit/class-use/USCustomary.Length.html new file mode 100644 index 0000000..b7e0c10 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/USCustomary.Length.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.USCustomary.Length + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.USCustomary.Length

+
+
No usage of org.unitConverter.unit.USCustomary.Length
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/USCustomary.Mass.html b/doc/org/unitConverter/unit/class-use/USCustomary.Mass.html new file mode 100644 index 0000000..310581a --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/USCustomary.Mass.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.USCustomary.Mass + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.USCustomary.Mass

+
+
No usage of org.unitConverter.unit.USCustomary.Mass
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/USCustomary.Volume.html b/doc/org/unitConverter/unit/class-use/USCustomary.Volume.html new file mode 100644 index 0000000..a21595b --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/USCustomary.Volume.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.USCustomary.Volume + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.USCustomary.Volume

+
+
No usage of org.unitConverter.unit.USCustomary.Volume
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/USCustomary.html b/doc/org/unitConverter/unit/class-use/USCustomary.html new file mode 100644 index 0000000..8625d92 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/USCustomary.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.USCustomary + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.USCustomary

+
+
No usage of org.unitConverter.unit.USCustomary
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/Unit.html b/doc/org/unitConverter/unit/class-use/Unit.html new file mode 100644 index 0000000..33cd17f --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/Unit.html @@ -0,0 +1,312 @@ + + + + + +Uses of Class org.unitConverter.unit.Unit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.Unit

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html new file mode 100644 index 0000000..46984bb --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry

+
+
No usage of org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntry
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html new file mode 100644 index 0000000..2e397dc --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator

+
+
No usage of org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.PrefixedUnitEntryIterator
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html new file mode 100644 index 0000000..7ede112 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet

+
+
No usage of org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitEntrySet
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html new file mode 100644 index 0000000..bc25e67 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator

+
+
No usage of org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.PrefixedUnitNameIterator
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html new file mode 100644 index 0000000..71e73db --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet

+
+
No usage of org.unitConverter.unit.UnitDatabase.PrefixedUnitMap.PrefixedUnitNameSet
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.html new file mode 100644 index 0000000..4565b71 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.PrefixedUnitMap.html @@ -0,0 +1,233 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase.PrefixedUnitMap + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabase.PrefixedUnitMap

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabase.html b/doc/org/unitConverter/unit/class-use/UnitDatabase.html new file mode 100644 index 0000000..498974d --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabase.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabase + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.UnitDatabase

+
+
No usage of org.unitConverter.unit.UnitDatabase
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitDatabaseTest.html b/doc/org/unitConverter/unit/class-use/UnitDatabaseTest.html new file mode 100644 index 0000000..2dc04eb --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitDatabaseTest.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitDatabaseTest + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitDatabaseTest

+
+
No usage of org.unitConverter.unit.UnitDatabaseTest
+
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitPrefix.html b/doc/org/unitConverter/unit/class-use/UnitPrefix.html new file mode 100644 index 0000000..a4beeb6 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitPrefix.html @@ -0,0 +1,381 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitPrefix + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.unit.UnitPrefix

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/class-use/UnitTest.html b/doc/org/unitConverter/unit/class-use/UnitTest.html new file mode 100644 index 0000000..4039629 --- /dev/null +++ b/doc/org/unitConverter/unit/class-use/UnitTest.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.unit.UnitTest + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.unit.UnitTest

+
+
No usage of org.unitConverter.unit.UnitTest
+
+ + + diff --git a/doc/org/unitConverter/unit/package-frame.html b/doc/org/unitConverter/unit/package-frame.html new file mode 100644 index 0000000..6b5cb13 --- /dev/null +++ b/doc/org/unitConverter/unit/package-frame.html @@ -0,0 +1,41 @@ + + + + + +org.unitConverter.unit + + + + + +

org.unitConverter.unit

+
+

Classes

+ +
+ + diff --git a/doc/org/unitConverter/unit/package-summary.html b/doc/org/unitConverter/unit/package-summary.html new file mode 100644 index 0000000..82e16b6 --- /dev/null +++ b/doc/org/unitConverter/unit/package-summary.html @@ -0,0 +1,279 @@ + + + + + +org.unitConverter.unit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package org.unitConverter.unit

+
+
Everything to do with the units that make up Unit Converter.
+
+

See: Description

+
+
+ + + + +

Package org.unitConverter.unit Description

+
Everything to do with the units that make up Unit Converter.
+
+
Since:
+
2019-10-16, v0.1.0
+
Author:
+
Adrien Hopkins
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/package-tree.html b/doc/org/unitConverter/unit/package-tree.html new file mode 100644 index 0000000..9ebd21b --- /dev/null +++ b/doc/org/unitConverter/unit/package-tree.html @@ -0,0 +1,161 @@ + + + + + +org.unitConverter.unit Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package org.unitConverter.unit

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/unit/package-use.html b/doc/org/unitConverter/unit/package-use.html new file mode 100644 index 0000000..e4719cc --- /dev/null +++ b/doc/org/unitConverter/unit/package-use.html @@ -0,0 +1,186 @@ + + + + + +Uses of Package org.unitConverter.unit + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
org.unitConverter.unit

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3