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. --- .../converterGUI/DelegateListModel.html | 959 ++++++++++++++ .../converterGUI/FilterComparator.html | 489 ++++++++ .../unitConverter/converterGUI/GridBagBuilder.html | 1140 +++++++++++++++++ .../converterGUI/MutablePredicate.html | 428 +++++++ .../unitConverter/converterGUI/SearchBoxList.html | 902 ++++++++++++++ .../converterGUI/UnitConverterGUI.Presenter.html | 717 +++++++++++ .../converterGUI/UnitConverterGUI.View.html | 853 +++++++++++++ .../converterGUI/UnitConverterGUI.html | 341 +++++ .../converterGUI/class-use/DelegateListModel.html | 195 +++ .../converterGUI/class-use/FilterComparator.html | 149 +++ .../converterGUI/class-use/GridBagBuilder.html | 225 ++++ .../converterGUI/class-use/MutablePredicate.html | 149 +++ .../converterGUI/class-use/SearchBoxList.html | 218 ++++ .../class-use/UnitConverterGUI.Presenter.html | 197 +++ .../class-use/UnitConverterGUI.View.html | 212 ++++ .../converterGUI/class-use/UnitConverterGUI.html | 149 +++ .../unitConverter/converterGUI/package-frame.html | 14 + .../converterGUI/package-summary.html | 139 +++ .../unitConverter/converterGUI/package-tree.html | 127 ++ .../unitConverter/converterGUI/package-use.html | 124 ++ ...Collections.ConditionalExistenceCollection.html | 532 ++++++++ ...ceCollections.ConditionalExistenceIterator.html | 493 ++++++++ ...istenceCollections.ConditionalExistenceMap.html | 570 +++++++++ ...istenceCollections.ConditionalExistenceSet.html | 565 +++++++++ .../math/ConditionalExistenceCollections.html | 397 ++++++ .../math/ConditionalExistenceCollectionsTest.html | 469 +++++++ doc/org/unitConverter/math/DecimalComparison.html | 492 ++++++++ .../math/ExpressionParser.Builder.html | 391 ++++++ .../ExpressionParser.PriorityBinaryOperator.html | 425 +++++++ .../ExpressionParser.PriorityUnaryOperator.html | 425 +++++++ .../math/ExpressionParser.TokenType.html | 445 +++++++ doc/org/unitConverter/math/ExpressionParser.html | 349 ++++++ .../unitConverter/math/ExpressionParserTest.html | 360 ++++++ doc/org/unitConverter/math/ObjectProduct.html | 553 +++++++++ doc/org/unitConverter/math/ObjectProductTest.html | 366 ++++++ ...Collections.ConditionalExistenceCollection.html | 149 +++ ...ceCollections.ConditionalExistenceIterator.html | 197 +++ ...istenceCollections.ConditionalExistenceMap.html | 149 +++ ...istenceCollections.ConditionalExistenceSet.html | 149 +++ .../class-use/ConditionalExistenceCollections.html | 124 ++ .../ConditionalExistenceCollectionsTest.html | 149 +++ .../math/class-use/DecimalComparison.html | 124 ++ .../math/class-use/ExpressionParser.Builder.html | 184 +++ .../ExpressionParser.PriorityBinaryOperator.html | 221 ++++ .../ExpressionParser.PriorityUnaryOperator.html | 239 ++++ .../math/class-use/ExpressionParser.TokenType.html | 212 ++++ .../math/class-use/ExpressionParser.html | 166 +++ .../math/class-use/ExpressionParserTest.html | 149 +++ .../math/class-use/ObjectProduct.html | 515 ++++++++ .../math/class-use/ObjectProductTest.html | 149 +++ doc/org/unitConverter/math/package-frame.html | 24 + doc/org/unitConverter/math/package-summary.html | 183 +++ doc/org/unitConverter/math/package-tree.html | 141 +++ doc/org/unitConverter/math/package-use.html | 194 +++ doc/org/unitConverter/package-frame.html | 14 + doc/org/unitConverter/package-summary.html | 141 +++ doc/org/unitConverter/package-tree.html | 127 ++ doc/org/unitConverter/package-use.html | 124 ++ 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 +++ 124 files changed, 42290 insertions(+) create mode 100644 doc/org/unitConverter/converterGUI/DelegateListModel.html create mode 100644 doc/org/unitConverter/converterGUI/FilterComparator.html create mode 100644 doc/org/unitConverter/converterGUI/GridBagBuilder.html create mode 100644 doc/org/unitConverter/converterGUI/MutablePredicate.html create mode 100644 doc/org/unitConverter/converterGUI/SearchBoxList.html create mode 100644 doc/org/unitConverter/converterGUI/UnitConverterGUI.Presenter.html create mode 100644 doc/org/unitConverter/converterGUI/UnitConverterGUI.View.html create mode 100644 doc/org/unitConverter/converterGUI/UnitConverterGUI.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/DelegateListModel.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/FilterComparator.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/GridBagBuilder.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/MutablePredicate.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/SearchBoxList.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.Presenter.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.View.html create mode 100644 doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.html create mode 100644 doc/org/unitConverter/converterGUI/package-frame.html create mode 100644 doc/org/unitConverter/converterGUI/package-summary.html create mode 100644 doc/org/unitConverter/converterGUI/package-tree.html create mode 100644 doc/org/unitConverter/converterGUI/package-use.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollections.html create mode 100644 doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html create mode 100644 doc/org/unitConverter/math/DecimalComparison.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.Builder.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.TokenType.html create mode 100644 doc/org/unitConverter/math/ExpressionParser.html create mode 100644 doc/org/unitConverter/math/ExpressionParserTest.html create mode 100644 doc/org/unitConverter/math/ObjectProduct.html create mode 100644 doc/org/unitConverter/math/ObjectProductTest.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.html create mode 100644 doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html create mode 100644 doc/org/unitConverter/math/class-use/DecimalComparison.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParser.html create mode 100644 doc/org/unitConverter/math/class-use/ExpressionParserTest.html create mode 100644 doc/org/unitConverter/math/class-use/ObjectProduct.html create mode 100644 doc/org/unitConverter/math/class-use/ObjectProductTest.html create mode 100644 doc/org/unitConverter/math/package-frame.html create mode 100644 doc/org/unitConverter/math/package-summary.html create mode 100644 doc/org/unitConverter/math/package-tree.html create mode 100644 doc/org/unitConverter/math/package-use.html create mode 100644 doc/org/unitConverter/package-frame.html create mode 100644 doc/org/unitConverter/package-summary.html create mode 100644 doc/org/unitConverter/package-tree.html create mode 100644 doc/org/unitConverter/package-use.html 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') diff --git a/doc/org/unitConverter/converterGUI/DelegateListModel.html b/doc/org/unitConverter/converterGUI/DelegateListModel.html new file mode 100644 index 0000000..916d94b --- /dev/null +++ b/doc/org/unitConverter/converterGUI/DelegateListModel.html @@ -0,0 +1,959 @@ + + + + + +DelegateListModel + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class DelegateListModel<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • javax.swing.AbstractListModel<E>
      • +
    • +
        +
      • org.unitConverter.converterGUI.DelegateListModel<E>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, javax.swing.ListModel<E>
    +
    +
    +
    final class DelegateListModel<E>
+extends javax.swing.AbstractListModel<E>
+implements java.util.List<E>
    +
    A list model that delegates to a list. +

    + It is recommended to use the delegate methods in DelegateListModel instead of the delegated list's methods because + the delegate methods handle updating the list. +

    +
    +
    Since:
    +
    2019-01-14, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.List<E>delegate +
      The list that this model is a delegate to.
      +
      private static longserialVersionUID 
      +
        +
      • + + +

        Fields inherited from class javax.swing.AbstractListModel

        +listenerList
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      DelegateListModel() +
      Creates an empty DelegateListModel.
      +
      DelegateListModel​(java.util.List<E> delegate) +
      Creates the DelegateListModel.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidadd​(int index, + E element) 
      booleanadd​(E element) 
      booleanaddAll​(int index, + java.util.Collection<? extends E> c) 
      booleanaddAll​(java.util.Collection<? extends E> c) 
      voidclear() 
      booleancontains​(java.lang.Object elem) 
      booleancontainsAll​(java.util.Collection<?> c) 
      Eget​(int index) 
      EgetElementAt​(int index) 
      intgetSize() 
      intindexOf​(java.lang.Object elem) 
      booleanisEmpty() 
      java.util.Iterator<E>iterator() 
      intlastIndexOf​(java.lang.Object elem) 
      java.util.ListIterator<E>listIterator() 
      java.util.ListIterator<E>listIterator​(int index) 
      Eremove​(int index) 
      booleanremove​(java.lang.Object o) 
      booleanremoveAll​(java.util.Collection<?> c) 
      booleanretainAll​(java.util.Collection<?> c) 
      Eset​(int index, + E element) 
      intsize() 
      java.util.List<E>subList​(int fromIndex, + int toIndex) 
      java.lang.Object[]toArray() 
      <T> T[]toArray​(T[] a) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class javax.swing.AbstractListModel

        +addListDataListener, fireContentsChanged, fireIntervalAdded, fireIntervalRemoved, getListDataListeners, getListeners, removeListDataListener
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Collection

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

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.List

        +equals, hashCode, replaceAll, sort, spliterator
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        serialVersionUID

        +
        private static final long serialVersionUID
        +
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        delegate

        +
        private final java.util.List<E> delegate
        +
        The list that this model is a delegate to.
        +
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DelegateListModel

        +
        public DelegateListModel()
        +
        Creates an empty DelegateListModel.
        +
        +
        Since:
        +
        2019-04-13
        +
        +
        • +
      + + + +
        +
      • +

        DelegateListModel

        +
        public DelegateListModel​(java.util.List<E> delegate)
        +
        Creates the DelegateListModel.
        +
        +
        Parameters:
        +
        delegate - list to delegate
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

        +
        public boolean add​(E element)
        +
        +
        Specified by:
        +
        add in interface java.util.Collection<E>
        +
        Specified by:
        +
        add in interface java.util.List<E>
        +
        +
        • +
      + + + + + +
        +
      • +

        add

        +
        public void add​(int index,
+                E element)
        +
        +
        Specified by:
        +
        add in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll​(java.util.Collection<? extends E> c)
        +
        +
        Specified by:
        +
        addAll in interface java.util.Collection<E>
        +
        Specified by:
        +
        addAll in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        addAll

        +
        public boolean addAll​(int index,
+                      java.util.Collection<? extends E> c)
        +
        +
        Specified by:
        +
        addAll in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        +
        Specified by:
        +
        clear in interface java.util.Collection<E>
        +
        Specified by:
        +
        clear in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        contains

        +
        public boolean contains​(java.lang.Object elem)
        +
        +
        Specified by:
        +
        contains in interface java.util.Collection<E>
        +
        Specified by:
        +
        contains in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        containsAll

        +
        public boolean containsAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        containsAll in interface java.util.Collection<E>
        +
        Specified by:
        +
        containsAll in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public E get​(int index)
        +
        +
        Specified by:
        +
        get in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        getElementAt

        +
        public E getElementAt​(int index)
        +
        +
        Specified by:
        +
        getElementAt in interface javax.swing.ListModel<E>
        +
        +
        • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        +
        Specified by:
        +
        getSize in interface javax.swing.ListModel<E>
        +
        +
        • +
      + + + +
        +
      • +

        indexOf

        +
        public int indexOf​(java.lang.Object elem)
        +
        +
        Specified by:
        +
        indexOf in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        +
        Specified by:
        +
        isEmpty in interface java.util.Collection<E>
        +
        Specified by:
        +
        isEmpty in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        iterator

        +
        public java.util.Iterator<E> iterator()
        +
        +
        Specified by:
        +
        iterator in interface java.util.Collection<E>
        +
        Specified by:
        +
        iterator in interface java.lang.Iterable<E>
        +
        Specified by:
        +
        iterator in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        lastIndexOf

        +
        public int lastIndexOf​(java.lang.Object elem)
        +
        +
        Specified by:
        +
        lastIndexOf in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        listIterator

        +
        public java.util.ListIterator<E> listIterator()
        +
        +
        Specified by:
        +
        listIterator in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        listIterator

        +
        public java.util.ListIterator<E> listIterator​(int index)
        +
        +
        Specified by:
        +
        listIterator in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public E remove​(int index)
        +
        +
        Specified by:
        +
        remove in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public boolean remove​(java.lang.Object o)
        +
        +
        Specified by:
        +
        remove in interface java.util.Collection<E>
        +
        Specified by:
        +
        remove in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        removeAll

        +
        public boolean removeAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        removeAll in interface java.util.Collection<E>
        +
        Specified by:
        +
        removeAll in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        retainAll

        +
        public boolean retainAll​(java.util.Collection<?> c)
        +
        +
        Specified by:
        +
        retainAll in interface java.util.Collection<E>
        +
        Specified by:
        +
        retainAll in interface java.util.List<E>
        +
        +
        • +
      + + + + + +
        +
      • +

        set

        +
        public E set​(int index,
+             E element)
        +
        +
        Specified by:
        +
        set in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<E>
        +
        Specified by:
        +
        size in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        subList

        +
        public java.util.List<E> subList​(int fromIndex,
+                                 int toIndex)
        +
        +
        Specified by:
        +
        subList in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public java.lang.Object[] toArray()
        +
        +
        Specified by:
        +
        toArray in interface java.util.Collection<E>
        +
        Specified by:
        +
        toArray in interface java.util.List<E>
        +
        +
        • +
      + + + + + +
        +
      • +

        toArray

        +
        public <T> T[] toArray​(T[] a)
        +
        +
        Specified by:
        +
        toArray in interface java.util.Collection<E>
        +
        Specified by:
        +
        toArray in interface java.util.List<E>
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/FilterComparator.html b/doc/org/unitConverter/converterGUI/FilterComparator.html new file mode 100644 index 0000000..af91555 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/FilterComparator.html @@ -0,0 +1,489 @@ + + + + + +FilterComparator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class FilterComparator

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.converterGUI.FilterComparator
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Comparator<java.lang.String>
    +
    +
    +
    final class FilterComparator
+extends java.lang.Object
+implements java.util.Comparator<java.lang.String>
    +
    A comparator that compares strings using a filter.
    +
    +
    Since:
    +
    2019-01-15, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private booleancaseSensitive +
      Whether or not the comparison is case-sensitive.
      +
      private java.util.Comparator<java.lang.String>comparator +
      The comparator to use if the arguments are otherwise equal.
      +
      private java.lang.Stringfilter +
      The filter that the comparator is filtered by.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      FilterComparator​(java.lang.String filter) +
      Creates the FilterComparator.
      +
      FilterComparator​(java.lang.String filter, + java.util.Comparator<java.lang.String> comparator) +
      Creates the FilterComparator.
      +
      FilterComparator​(java.lang.String filter, + java.util.Comparator<java.lang.String> comparator, + boolean caseSensitive) +
      Creates the FilterComparator.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intcompare​(java.lang.String arg0, + java.lang.String arg1) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Comparator

        +equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        filter

        +
        private final java.lang.String filter
        +
        The filter that the comparator is filtered by.
        +
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        comparator

        +
        private final java.util.Comparator<java.lang.String> comparator
        +
        The comparator to use if the arguments are otherwise equal.
        +
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        caseSensitive

        +
        private final boolean caseSensitive
        +
        Whether or not the comparison is case-sensitive.
        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FilterComparator

        +
        public FilterComparator​(java.lang.String filter)
        +
        Creates the FilterComparator.
        +
        +
        Parameters:
        +
        filter -
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        FilterComparator

        +
        public FilterComparator​(java.lang.String filter,
+                        java.util.Comparator<java.lang.String> comparator)
        +
        Creates the FilterComparator.
        +
        +
        Parameters:
        +
        filter - string to filter by
        +
        comparator - comparator to fall back to if all else fails, null is compareTo.
        +
        Throws:
        +
        java.lang.NullPointerException - if filter is null
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        FilterComparator

        +
        public FilterComparator​(java.lang.String filter,
+                        java.util.Comparator<java.lang.String> comparator,
+                        boolean caseSensitive)
        +
        Creates the FilterComparator.
        +
        +
        Parameters:
        +
        filter - string to filter by
        +
        comparator - comparator to fall back to if all else fails, null is compareTo.
        +
        caseSensitive - whether or not the comparator is case-sensitive
        +
        Throws:
        +
        java.lang.NullPointerException - if filter is null
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public int compare​(java.lang.String arg0,
+                   java.lang.String arg1)
        +
        +
        Specified by:
        +
        compare in interface java.util.Comparator<java.lang.String>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/GridBagBuilder.html b/doc/org/unitConverter/converterGUI/GridBagBuilder.html new file mode 100644 index 0000000..c8e80d2 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/GridBagBuilder.html @@ -0,0 +1,1140 @@ + + + + + +GridBagBuilder + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class GridBagBuilder

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.converterGUI.GridBagBuilder
      • +
    +
    • +
+
+
    +
  • +
    +
    final class GridBagBuilder
+extends java.lang.Object
    +
    A builder for Java's GridBagConstraints class.
    +
    +
    Since:
    +
    2018-11-30, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intanchor +
      The built GridBagConstraints's anchor property.
      +
      private intfill +
      The built GridBagConstraints's fill property.
      +
      private intgridheight +
      The built GridBagConstraints's gridheight property.
      +
      private intgridwidth +
      The built GridBagConstraints's gridwidth property.
      +
      private intgridx +
      The built GridBagConstraints's gridx property.
      +
      private intgridy +
      The built GridBagConstraints's gridy property.
      +
      private java.awt.Insetsinsets +
      The built GridBagConstraints's insets property.
      +
      private intipadx +
      The built GridBagConstraints's ipadx property.
      +
      private intipady +
      The built GridBagConstraints's ipady property.
      +
      private doubleweightx +
      The built GridBagConstraints's weightx property.
      +
      private doubleweighty +
      The built GridBagConstraints's weighty property.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
       GridBagBuilder​(int gridx, + int gridy) 
       GridBagBuilder​(int gridx, + int gridy, + int gridwidth, + int gridheight) 
      private GridBagBuilder​(int gridx, + int gridy, + int gridwidth, + int gridheight, + double weightx, + double weighty, + int anchor, + int fill, + java.awt.Insets insets, + int ipadx, + int ipady) 
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        gridx

        +
        private final int gridx
        +
        The built GridBagConstraints's gridx property. +

        + Specifies the cell containing the leading edge of the component's display area, where the first cell in a row has + gridx=0. The leading edge of a component's display area is its left edge for a horizontal, + left-to-right container and its right edge for a horizontal, right-to-left container. The value + RELATIVE specifies that the component be placed immediately following the component that was added + to the container just before this component was added. +

        + The default value is RELATIVE. gridx should be a non-negative value.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.gridy, +ComponentOrientation
        +
        +
        • +
      + + + +
        +
      • +

        gridy

        +
        private final int gridy
        +
        The built GridBagConstraints's gridy property. +

        + Specifies the cell at the top of the component's display area, where the topmost cell has gridy=0. + The value RELATIVE specifies that the component be placed just below the component that was added to + the container just before this component was added. +

        + The default value is RELATIVE. gridy should be a non-negative value.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.gridx
        +
        +
        • +
      + + + +
        +
      • +

        gridwidth

        +
        private final int gridwidth
        +
        The built GridBagConstraints's gridwidth property. +

        + Specifies the number of cells in a row for the component's display area. +

        + Use REMAINDER to specify that the component's display area will be from gridx to the + last cell in the row. Use RELATIVE to specify that the component's display area will be from + gridx to the next to the last one in its row. +

        + gridwidth should be non-negative and the default value is 1.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.gridheight
        +
        +
        • +
      + + + +
        +
      • +

        gridheight

        +
        private final int gridheight
        +
        The built GridBagConstraints's gridheight property. +

        + Specifies the number of cells in a column for the component's display area. +

        + Use REMAINDER to specify that the component's display area will be from gridy to the + last cell in the column. Use RELATIVE to specify that the component's display area will be from + gridy to the next to the last one in its column. +

        + gridheight should be a non-negative value and the default value is 1.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.gridwidth
        +
        +
        • +
      + + + +
        +
      • +

        weightx

        +
        private double weightx
        +
        The built GridBagConstraints's weightx property. +

        + Specifies how to distribute extra horizontal space. +

        + The grid bag layout manager calculates the weight of a column to be the maximum weightx of all the + components in a column. If the resulting layout is smaller horizontally than the area it needs to fill, the extra + space is distributed to each column in proportion to its weight. A column that has a weight of zero receives no + extra space. +

        + If all the weights are zero, all the extra space appears between the grids of the cell and the left and right + edges. +

        + The default value of this field is 0. weightx should be a non-negative value.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.weighty
        +
        +
        • +
      + + + +
        +
      • +

        weighty

        +
        private double weighty
        +
        The built GridBagConstraints's weighty property. +

        + Specifies how to distribute extra vertical space. +

        + The grid bag layout manager calculates the weight of a row to be the maximum weighty of all the + components in a row. If the resulting layout is smaller vertically than the area it needs to fill, the extra + space is distributed to each row in proportion to its weight. A row that has a weight of zero receives no extra + space. +

        + If all the weights are zero, all the extra space appears between the grids of the cell and the top and bottom + edges. +

        + The default value of this field is 0. weighty should be a non-negative value.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.weightx
        +
        +
        • +
      + + + +
        +
      • +

        anchor

        +
        private int anchor
        +
        The built GridBagConstraints's anchor property. +

        + This field is used when the component is smaller than its display area. It determines where, within the display + area, to place the component. +

        + There are three kinds of possible values: orientation relative, baseline relative and absolute. Orientation + relative values are interpreted relative to the container's component orientation property, baseline relative + values are interpreted relative to the baseline and absolute values are not. The absolute values are: + CENTER, NORTH, NORTHEAST, EAST, SOUTHEAST, + SOUTH, SOUTHWEST, WEST, and NORTHWEST. The orientation + relative values are: PAGE_START, PAGE_END, LINE_START, + LINE_END, FIRST_LINE_START, FIRST_LINE_END, LAST_LINE_START + and LAST_LINE_END. The baseline relative values are: BASELINE, + BASELINE_LEADING, BASELINE_TRAILING, ABOVE_BASELINE, + ABOVE_BASELINE_LEADING, ABOVE_BASELINE_TRAILING, BELOW_BASELINE, + BELOW_BASELINE_LEADING, and BELOW_BASELINE_TRAILING. The default value is + CENTER.

        +
        +
        See Also:
        +
        Object.clone(), +ComponentOrientation
        +
        +
        • +
      + + + +
        +
      • +

        fill

        +
        private int fill
        +
        The built GridBagConstraints's fill property. +

        + This field is used when the component's display area is larger than the component's requested size. It determines + whether to resize the component, and if so, how. +

        + The following values are valid for fill: + +

          +
        • NONE: Do not resize the component. +
        • HORIZONTAL: Make the component wide enough to fill its display area horizontally, but do not + change its height. +
        • VERTICAL: Make the component tall enough to fill its display area vertically, but do not change + its width. +
        • BOTH: Make the component fill its display area entirely. +
        +

        + The default value is NONE.

        +
        +
        See Also:
        +
        Object.clone()
        +
        +
        • +
      + + + +
        +
      • +

        insets

        +
        private java.awt.Insets insets
        +
        The built GridBagConstraints's insets property. +

        + This field specifies the external padding of the component, the minimum amount of space between the component and + the edges of its display area. +

        + The default value is new Insets(0, 0, 0, 0).

        +
        +
        See Also:
        +
        Object.clone()
        +
        +
        • +
      + + + +
        +
      • +

        ipadx

        +
        private int ipadx
        +
        The built GridBagConstraints's ipadx property. +

        + This field specifies the internal padding of the component, how much space to add to the minimum width of the + component. The width of the component is at least its minimum width plus ipadx pixels. +

        + The default value is 0.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.ipady
        +
        +
        • +
      + + + +
        +
      • +

        ipady

        +
        private int ipady
        +
        The built GridBagConstraints's ipady property. +

        + This field specifies the internal padding, that is, how much space to add to the minimum height of the component. + The height of the component is at least its minimum height plus ipady pixels. +

        + The default value is 0.

        +
        +
        See Also:
        +
        Object.clone(), +GridBagConstraints.ipadx
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GridBagBuilder

        +
        public GridBagBuilder​(int gridx,
+                      int gridy)
        +
        +
        Parameters:
        +
        gridx - x position
        +
        gridy - y position
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        GridBagBuilder

        +
        public GridBagBuilder​(int gridx,
+                      int gridy,
+                      int gridwidth,
+                      int gridheight)
        +
        +
        Parameters:
        +
        gridx - x position
        +
        gridy - y position
        +
        gridwidth - number of cells occupied horizontally
        +
        gridheight - number of cells occupied vertically
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        GridBagBuilder

        +
        private GridBagBuilder​(int gridx,
+                       int gridy,
+                       int gridwidth,
+                       int gridheight,
+                       double weightx,
+                       double weighty,
+                       int anchor,
+                       int fill,
+                       java.awt.Insets insets,
+                       int ipadx,
+                       int ipady)
        +
        +
        Parameters:
        +
        gridx - x position
        +
        gridy - y position
        +
        gridwidth - number of cells occupied horizontally
        +
        gridheight - number of cells occupied vertically
        +
        weightx -
        +
        weighty -
        +
        anchor -
        +
        fill -
        +
        insets -
        +
        ipadx -
        +
        ipady -
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        build

        +
        public java.awt.GridBagConstraints build()
        +
        +
        Returns:
        +
        GridBagConstraints created by this builder
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getAnchor

        +
        public int getAnchor()
        +
        +
        Returns:
        +
        anchor
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getFill

        +
        public int getFill()
        +
        +
        Returns:
        +
        fill
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getGridheight

        +
        public int getGridheight()
        +
        +
        Returns:
        +
        gridheight
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getGridwidth

        +
        public int getGridwidth()
        +
        +
        Returns:
        +
        gridwidth
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getGridx

        +
        public int getGridx()
        +
        +
        Returns:
        +
        gridx
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getGridy

        +
        public int getGridy()
        +
        +
        Returns:
        +
        gridy
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getInsets

        +
        public java.awt.Insets getInsets()
        +
        +
        Returns:
        +
        insets
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getIpadx

        +
        public int getIpadx()
        +
        +
        Returns:
        +
        ipadx
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getIpady

        +
        public int getIpady()
        +
        +
        Returns:
        +
        ipady
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getWeightx

        +
        public double getWeightx()
        +
        +
        Returns:
        +
        weightx
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getWeighty

        +
        public double getWeighty()
        +
        +
        Returns:
        +
        weighty
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setAnchor

        +
        public GridBagBuilder setAnchor​(int anchor)
        +
        +
        Parameters:
        +
        anchor - anchor to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setFill

        +
        public GridBagBuilder setFill​(int fill)
        +
        +
        Parameters:
        +
        fill - fill to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setInsets

        +
        public GridBagBuilder setInsets​(java.awt.Insets insets)
        +
        +
        Parameters:
        +
        insets - insets to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setIpadx

        +
        public GridBagBuilder setIpadx​(int ipadx)
        +
        +
        Parameters:
        +
        ipadx - ipadx to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setIpady

        +
        public GridBagBuilder setIpady​(int ipady)
        +
        +
        Parameters:
        +
        ipady - ipady to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setWeightx

        +
        public GridBagBuilder setWeightx​(double weightx)
        +
        +
        Parameters:
        +
        weightx - weightx to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setWeighty

        +
        public GridBagBuilder setWeighty​(double weighty)
        +
        +
        Parameters:
        +
        weighty - weighty to set
        +
        Since:
        +
        2018-11-30, v0.1.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/MutablePredicate.html b/doc/org/unitConverter/converterGUI/MutablePredicate.html new file mode 100644 index 0000000..d7af17c --- /dev/null +++ b/doc/org/unitConverter/converterGUI/MutablePredicate.html @@ -0,0 +1,428 @@ + + + + + +MutablePredicate + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class MutablePredicate<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.converterGUI.MutablePredicate<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.function.Predicate<T>
    +
    +
    +
    final class MutablePredicate<T>
+extends java.lang.Object
+implements java.util.function.Predicate<T>
    +
    A container for a predicate, which can be changed later.
    +
    +
    Since:
    +
    2019-04-13, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.function.Predicate<T>predicate +
      The predicate stored in this MutablePredicate
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      MutablePredicate​(java.util.function.Predicate<T> predicate) +
      Creates the MutablePredicate.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.util.function.Predicate<T>getPredicate() 
      voidsetPredicate​(java.util.function.Predicate<T> predicate) 
      booleantest​(T t) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.function.Predicate

        +and, negate, or
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        predicate

        +
        private java.util.function.Predicate<T> predicate
        +
        The predicate stored in this MutablePredicate
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MutablePredicate

        +
        public MutablePredicate​(java.util.function.Predicate<T> predicate)
        +
        Creates the MutablePredicate.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPredicate

        +
        public final java.util.function.Predicate<T> getPredicate()
        +
        +
        Returns:
        +
        predicate
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        setPredicate

        +
        public final void setPredicate​(java.util.function.Predicate<T> predicate)
        +
        +
        Parameters:
        +
        predicate - new value of predicate
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + + + +
        +
      • +

        test

        +
        public boolean test​(T t)
        +
        +
        Specified by:
        +
        test in interface java.util.function.Predicate<T>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/SearchBoxList.html b/doc/org/unitConverter/converterGUI/SearchBoxList.html new file mode 100644 index 0000000..1831fbd --- /dev/null +++ b/doc/org/unitConverter/converterGUI/SearchBoxList.html @@ -0,0 +1,902 @@ + + + + + +SearchBoxList + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class SearchBoxList

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.awt.Component
      • +
    • +
        +
      • java.awt.Container
        • +
      • +
          +
        • javax.swing.JComponent
          • +
        • +
            +
          • javax.swing.JPanel
            • +
          • +
              +
            • org.unitConverter.converterGUI.SearchBoxList
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible
    +
    +
    +
    final class SearchBoxList
+extends javax.swing.JPanel
    +
    +
    Since:
    +
    2019-04-13, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class javax.swing.JPanel

        +javax.swing.JPanel.AccessibleJPanel
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class javax.swing.JComponent

        +javax.swing.JComponent.AccessibleJComponent
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.awt.Container

        +java.awt.Container.AccessibleAWTContainer
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.awt.Component

        +java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private booleancaseSensitive 
      private java.util.function.Predicate<java.lang.String>customSearchFilter 
      private java.util.Comparator<java.lang.String>defaultOrdering 
      private static java.awt.ColorEMPTY_FOREGROUND +
      The color to use for an empty foreground.
      +
      private static java.lang.StringEMPTY_TEXT +
      The text to place in an empty search box.
      +
      private java.util.Collection<java.lang.String>itemsToFilter 
      private DelegateListModel<java.lang.String>listModel 
      private javax.swing.JTextFieldsearchBox 
      private booleansearchBoxEmpty 
      private booleansearchBoxFocused 
      private javax.swing.JList<java.lang.String>searchItems 
      private static longserialVersionUID 
      +
        +
      • + + +

        Fields inherited from class javax.swing.JComponent

        +listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
        • +
      +
        +
      • + + +

        Fields inherited from class java.awt.Component

        +accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
        • +
      +
        +
      • + + +

        Fields inherited from interface java.awt.image.ImageObserver

        +ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SearchBoxList​(java.util.Collection<java.lang.String> itemsToFilter) +
      Creates the SearchBoxList.
      +
      SearchBoxList​(java.util.Collection<java.lang.String> itemsToFilter, + java.util.Comparator<java.lang.String> defaultOrdering, + boolean caseSensitive) +
      Creates the SearchBoxList.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidaddSearchFilter​(java.util.function.Predicate<java.lang.String> filter) +
      Adds an additional filter for searching.
      +
      voidclearSearchFilters() +
      Resets the search filter.
      +
      javax.swing.JTextFieldgetSearchBox() 
      private java.util.function.Predicate<java.lang.String>getSearchFilter​(java.lang.String searchText) 
      javax.swing.JList<java.lang.String>getSearchList() 
      intgetSelectedIndex() 
      java.lang.StringgetSelectedValue() 
      voidreapplyFilter() +
      Re-applies the filters.
      +
      private voidsearchBoxFocusGained​(java.awt.event.FocusEvent e) +
      Runs whenever the search box gains focus.
      +
      private voidsearchBoxFocusLost​(java.awt.event.FocusEvent e) +
      Runs whenever the search box loses focus.
      +
      private voidsearchBoxTextChanged() +
      Runs whenever the text in the search box is changed.
      +
      +
        +
      • + + +

        Methods inherited from class javax.swing.JPanel

        +getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
        • +
      +
        +
      • + + +

        Methods inherited from class javax.swing.JComponent

        +addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
        • +
      +
        +
      • + + +

        Methods inherited from class java.awt.Container

        +add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
        • +
      +
        +
      • + + +

        Methods inherited from class java.awt.Component

        +action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        serialVersionUID

        +
        private static final long serialVersionUID
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EMPTY_TEXT

        +
        private static final java.lang.String EMPTY_TEXT
        +
        The text to place in an empty search box.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        EMPTY_FOREGROUND

        +
        private static final java.awt.Color EMPTY_FOREGROUND
        +
        The color to use for an empty foreground.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        itemsToFilter

        +
        private final java.util.Collection<java.lang.String> itemsToFilter
        +
        • +
      + + + + + + + +
        +
      • +

        searchBox

        +
        private final javax.swing.JTextField searchBox
        +
        • +
      + + + +
        +
      • +

        searchItems

        +
        private final javax.swing.JList<java.lang.String> searchItems
        +
        • +
      + + + +
        +
      • +

        searchBoxEmpty

        +
        private boolean searchBoxEmpty
        +
        • +
      + + + +
        +
      • +

        searchBoxFocused

        +
        private boolean searchBoxFocused
        +
        • +
      + + + +
        +
      • +

        customSearchFilter

        +
        private java.util.function.Predicate<java.lang.String> customSearchFilter
        +
        • +
      + + + +
        +
      • +

        defaultOrdering

        +
        private final java.util.Comparator<java.lang.String> defaultOrdering
        +
        • +
      + + + +
        +
      • +

        caseSensitive

        +
        private final boolean caseSensitive
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SearchBoxList

        +
        public SearchBoxList​(java.util.Collection<java.lang.String> itemsToFilter)
        +
        Creates the SearchBoxList.
        +
        +
        Parameters:
        +
        itemsToFilter - items to put in the list
        +
        Since:
        +
        2019-04-14
        +
        +
        • +
      + + + +
        +
      • +

        SearchBoxList

        +
        public SearchBoxList​(java.util.Collection<java.lang.String> itemsToFilter,
+                     java.util.Comparator<java.lang.String> defaultOrdering,
+                     boolean caseSensitive)
        +
        Creates the SearchBoxList.
        +
        +
        Parameters:
        +
        itemsToFilter - items to put in the list
        +
        defaultOrdering - default ordering of items after filtration (null=Comparable)
        +
        caseSensitive - whether or not the filtration is case-sensitive
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addSearchFilter

        +
        public void addSearchFilter​(java.util.function.Predicate<java.lang.String> filter)
        +
        Adds an additional filter for searching.
        +
        +
        Parameters:
        +
        filter - filter to add.
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        clearSearchFilters

        +
        public void clearSearchFilters()
        +
        Resets the search filter.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getSearchBox

        +
        public final javax.swing.JTextField getSearchBox()
        +
        +
        Returns:
        +
        this component's search box component
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getSearchFilter

        +
        private java.util.function.Predicate<java.lang.String> getSearchFilter​(java.lang.String searchText)
        +
        +
        Parameters:
        +
        searchText - text to search for
        +
        Returns:
        +
        a filter that filters out that text, based on this list's case sensitive setting
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getSearchList

        +
        public final javax.swing.JList<java.lang.String> getSearchList()
        +
        +
        Returns:
        +
        this component's list component
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getSelectedIndex

        +
        public int getSelectedIndex()
        +
        +
        Returns:
        +
        index selected in item list
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getSelectedValue

        +
        public java.lang.String getSelectedValue()
        +
        +
        Returns:
        +
        value selected in item list
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        reapplyFilter

        +
        public void reapplyFilter()
        +
        Re-applies the filters.
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        searchBoxFocusGained

        +
        private void searchBoxFocusGained​(java.awt.event.FocusEvent e)
        +
        Runs whenever the search box gains focus.
        +
        +
        Parameters:
        +
        e - focus event
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        searchBoxFocusLost

        +
        private void searchBoxFocusLost​(java.awt.event.FocusEvent e)
        +
        Runs whenever the search box loses focus.
        +
        +
        Parameters:
        +
        e - focus event
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        searchBoxTextChanged

        +
        private void searchBoxTextChanged()
        +
        Runs whenever the text in the search box is changed. +

        + Reapplies the search filter, and custom filters. +

        +
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/UnitConverterGUI.Presenter.html b/doc/org/unitConverter/converterGUI/UnitConverterGUI.Presenter.html new file mode 100644 index 0000000..a33e4d8 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/UnitConverterGUI.Presenter.html @@ -0,0 +1,717 @@ + + + + + +UnitConverterGUI.Presenter + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class UnitConverterGUI.Presenter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.converterGUI.UnitConverterGUI.Presenter
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    UnitConverterGUI
    +
    +
    +
    private static class UnitConverterGUI.Presenter
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private UnitDatabasedatabase +
      The units known by the program.
      +
      private java.util.List<java.lang.String>dimensionNames +
      The names of all of the dimensions
      +
      private java.util.Comparator<java.lang.String>prefixNameComparator 
      private java.util.List<java.lang.String>prefixNames +
      The names of all of the prefixes
      +
      private intsignificantFigures 
      private java.util.List<java.lang.String>unitNames +
      The names of all of the units
      +
      private UnitConverterGUI.Viewview +
      The presenter's associated view.
      +
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private static voidaddDefaults​(UnitDatabase database) +
      Adds default units and dimensions to a database.
      +
      voidconvertDimensionBased() +
      Converts in the dimension-based converter
      +
      voidconvertExpressions() +
      Runs whenever the convert button is pressed.
      +
      java.util.List<java.lang.String>dimensionNameList() 
      java.util.Comparator<java.lang.String>getPrefixNameComparator() 
      private java.lang.StringgetRoundedString​(double value) 
      java.util.Set<java.lang.String>prefixNameSet() 
      voidprefixSelected() +
      Runs whenever a prefix is selected in the viewer.
      +
      voidsetSignificantFigures​(int significantFigures) 
      booleanunitMatchesDimension​(java.lang.String unitName, + java.lang.String dimensionName) +
      Returns true if and only if the unit represented by unitName has the dimension represented by + dimensionName.
      +
      voidunitNameSelected() +
      Runs whenever a unit is selected in the viewer.
      +
      java.util.Set<java.lang.String>unitNameSet() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        database

        +
        private final UnitDatabase database
        +
        The units known by the program.
        +
        • +
      + + + +
        +
      • +

        unitNames

        +
        private final java.util.List<java.lang.String> unitNames
        +
        The names of all of the units
        +
        • +
      + + + +
        +
      • +

        prefixNames

        +
        private final java.util.List<java.lang.String> prefixNames
        +
        The names of all of the prefixes
        +
        • +
      + + + +
        +
      • +

        dimensionNames

        +
        private final java.util.List<java.lang.String> dimensionNames
        +
        The names of all of the dimensions
        +
        • +
      + + + +
        +
      • +

        prefixNameComparator

        +
        private final java.util.Comparator<java.lang.String> prefixNameComparator
        +
        • +
      + + + +
        +
      • +

        significantFigures

        +
        private int significantFigures
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Presenter

        +
        Presenter​(UnitConverterGUI.View view)
        +
        Creates the presenter.
        +
        +
        Parameters:
        +
        view - presenter's associated view
        +
        Since:
        +
        2018-12-27, v0.1.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addDefaults

        +
        private static void addDefaults​(UnitDatabase database)
        +
        Adds default units and dimensions to a database.
        +
        +
        Parameters:
        +
        database - database to add to
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        convertDimensionBased

        +
        public final void convertDimensionBased()
        +
        Converts in the dimension-based converter
        +
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        convertExpressions

        +
        public final void convertExpressions()
        +
        Runs whenever the convert button is pressed. + +

        + Reads and parses a unit expression from the from and to boxes, then converts from to to. Any + errors are shown in JOptionPanes. +

        +
        +
        Since:
        +
        2019-01-26, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        dimensionNameList

        +
        public final java.util.List<java.lang.String> dimensionNameList()
        +
        +
        Returns:
        +
        a list of all of the unit dimensions
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixNameComparator

        +
        public final java.util.Comparator<java.lang.String> getPrefixNameComparator()
        +
        +
        Returns:
        +
        a comparator to compare prefix names
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getRoundedString

        +
        private final java.lang.String getRoundedString​(double value)
        +
        +
        Parameters:
        +
        value - value to round
        +
        Returns:
        +
        string of that value rounded to significantDigits significant digits.
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        prefixNameSet

        +
        public final java.util.Set<java.lang.String> prefixNameSet()
        +
        +
        Returns:
        +
        a set of all prefix names in the database
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        prefixSelected

        +
        public final void prefixSelected()
        +
        Runs whenever a prefix is selected in the viewer. +

        + Shows its information in the text box to the right. +

        +
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setSignificantFigures

        +
        public final void setSignificantFigures​(int significantFigures)
        +
        +
        Parameters:
        +
        significantFigures - new value of significantFigures
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        unitMatchesDimension

        +
        public final boolean unitMatchesDimension​(java.lang.String unitName,
+                                          java.lang.String dimensionName)
        +
        Returns true if and only if the unit represented by unitName has the dimension represented by + dimensionName.
        +
        +
        Parameters:
        +
        unitName - name of unit to test
        +
        dimensionName - name of dimension to test
        +
        Returns:
        +
        whether unit has dimenision
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        unitNameSelected

        +
        public final void unitNameSelected()
        +
        Runs whenever a unit is selected in the viewer. +

        + Shows its information in the text box to the right. +

        +
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        unitNameSet

        +
        public final java.util.Set<java.lang.String> unitNameSet()
        +
        +
        Returns:
        +
        a set of all of the unit names
        +
        Since:
        +
        2019-04-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/UnitConverterGUI.View.html b/doc/org/unitConverter/converterGUI/UnitConverterGUI.View.html new file mode 100644 index 0000000..708050f --- /dev/null +++ b/doc/org/unitConverter/converterGUI/UnitConverterGUI.View.html @@ -0,0 +1,853 @@ + + + + + +UnitConverterGUI.View + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class UnitConverterGUI.View

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.converterGUI.UnitConverterGUI.View
      • +
    +
    • +
+
+
    +
  • +
    +
    Enclosing class:
    +
    UnitConverterGUI
    +
    +
    +
    private static class UnitConverterGUI.View
+extends java.lang.Object
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private javax.swing.JTextAreadimensionBasedOutput +
      The output area in the dimension-based converter
      +
      private javax.swing.JFrameframe +
      The view's frame.
      +
      private javax.swing.JTextFieldfromEntry +
      The "From" entry in the conversion panel
      +
      private SearchBoxListfromSearch +
      The panel for "From" in the dimension-based converter
      +
      private javax.swing.JTextAreaoutput +
      The output area in the conversion panel
      +
      private SearchBoxListprefixNameList +
      The searchable list of prefix names in the prefix viewer
      +
      private javax.swing.JTextAreaprefixTextBox +
      The text box for prefix data in the prefix viewer
      +
      private UnitConverterGUI.Presenterpresenter +
      The view's associated presenter.
      +
      private javax.swing.JTextFieldtoEntry +
      The "To" entry in the conversion panel
      +
      private SearchBoxListtoSearch +
      The panel for "To" in the dimension-based converter
      +
      private SearchBoxListunitNameList +
      The searchable list of unit names in the unit viewer
      +
      private javax.swing.JTextAreaunitTextBox +
      The text box for unit data in the unit viewer
      +
      private javax.swing.JTextFieldvalueInput +
      The panel for inputting values in the dimension-based converter
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      View() +
      Creates the View.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        frame

        +
        private final javax.swing.JFrame frame
        +
        The view's frame.
        +
        • +
      + + + + + + + +
        +
      • +

        valueInput

        +
        private final javax.swing.JTextField valueInput
        +
        The panel for inputting values in the dimension-based converter
        +
        • +
      + + + +
        +
      • +

        fromSearch

        +
        private final SearchBoxList fromSearch
        +
        The panel for "From" in the dimension-based converter
        +
        • +
      + + + +
        +
      • +

        toSearch

        +
        private final SearchBoxList toSearch
        +
        The panel for "To" in the dimension-based converter
        +
        • +
      + + + +
        +
      • +

        dimensionBasedOutput

        +
        private final javax.swing.JTextArea dimensionBasedOutput
        +
        The output area in the dimension-based converter
        +
        • +
      + + + +
        +
      • +

        fromEntry

        +
        private final javax.swing.JTextField fromEntry
        +
        The "From" entry in the conversion panel
        +
        • +
      + + + +
        +
      • +

        toEntry

        +
        private final javax.swing.JTextField toEntry
        +
        The "To" entry in the conversion panel
        +
        • +
      + + + +
        +
      • +

        output

        +
        private final javax.swing.JTextArea output
        +
        The output area in the conversion panel
        +
        • +
      + + + +
        +
      • +

        unitNameList

        +
        private final SearchBoxList unitNameList
        +
        The searchable list of unit names in the unit viewer
        +
        • +
      + + + +
        +
      • +

        prefixNameList

        +
        private final SearchBoxList prefixNameList
        +
        The searchable list of prefix names in the prefix viewer
        +
        • +
      + + + +
        +
      • +

        unitTextBox

        +
        private final javax.swing.JTextArea unitTextBox
        +
        The text box for unit data in the unit viewer
        +
        • +
      + + + +
        +
      • +

        prefixTextBox

        +
        private final javax.swing.JTextArea prefixTextBox
        +
        The text box for prefix data in the prefix viewer
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        View

        +
        public View()
        +
        Creates the View.
        +
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getDimensionConverterInput

        +
        public java.lang.String getDimensionConverterInput()
        +
        +
        Returns:
        +
        value in dimension-based converter
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getFromSelection

        +
        public java.lang.String getFromSelection()
        +
        +
        Returns:
        +
        selection in "From" selector in dimension-based converter
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getFromText

        +
        public java.lang.String getFromText()
        +
        +
        Returns:
        +
        text in "From" box in converter panel
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getPrefixViewerSelection

        +
        public java.lang.String getPrefixViewerSelection()
        +
        +
        Returns:
        +
        index of selected prefix in prefix viewer
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getToSelection

        +
        public java.lang.String getToSelection()
        +
        +
        Returns:
        +
        selection in "To" selector in dimension-based converter
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getToText

        +
        public java.lang.String getToText()
        +
        +
        Returns:
        +
        text in "To" box in converter panel
        +
        Since:
        +
        2019-01-26, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        getUnitViewerSelection

        +
        public java.lang.String getUnitViewerSelection()
        +
        +
        Returns:
        +
        index of selected unit in unit viewer
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        init

        +
        public final void init()
        +
        Starts up the application.
        +
        +
        Since:
        +
        2018-12-27, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        initComponents

        +
        private final void initComponents()
        +
        Initializes the view's components.
        +
        +
        Since:
        +
        2018-12-27, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setDimensionConverterOutputText

        +
        public void setDimensionConverterOutputText​(java.lang.String text)
        +
        Sets the text in the output of the dimension-based converter.
        +
        +
        Parameters:
        +
        text - text to set
        +
        Since:
        +
        2019-04-13, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        setExpressionConverterOutputText

        +
        public void setExpressionConverterOutputText​(java.lang.String text)
        +
        Sets the text in the output of the conversion panel.
        +
        +
        Parameters:
        +
        text - text to set
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setPrefixTextBoxText

        +
        public void setPrefixTextBoxText​(java.lang.String text)
        +
        Sets the text of the prefix text box in the prefix viewer.
        +
        +
        Parameters:
        +
        text - text to set
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        setUnitTextBoxText

        +
        public void setUnitTextBoxText​(java.lang.String text)
        +
        Sets the text of the unit text box in the unit viewer.
        +
        +
        Parameters:
        +
        text - text to set
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        showErrorDialog

        +
        public void showErrorDialog​(java.lang.String title,
+                            java.lang.String message)
        +
        Shows an error dialog.
        +
        +
        Parameters:
        +
        title - title of dialog
        +
        message - message in dialog
        +
        Since:
        +
        2019-01-14, v0.1.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/UnitConverterGUI.html b/doc/org/unitConverter/converterGUI/UnitConverterGUI.html new file mode 100644 index 0000000..a61d917 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/UnitConverterGUI.html @@ -0,0 +1,341 @@ + + + + + +UnitConverterGUI + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.converterGUI
+

Class UnitConverterGUI

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.converterGUI.UnitConverterGUI
      • +
    +
    • +
+
+
    +
  • +
    +
    final class UnitConverterGUI
+extends java.lang.Object
    +
    +
    Since:
    +
    2018-12-27, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      UnitConverterGUI() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static voidmain​(java.lang.String[] args) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        UnitConverterGUI

        +
        UnitConverterGUI()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main​(java.lang.String[] args)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/converterGUI/class-use/DelegateListModel.html b/doc/org/unitConverter/converterGUI/class-use/DelegateListModel.html new file mode 100644 index 0000000..11be7c6 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/DelegateListModel.html @@ -0,0 +1,195 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.DelegateListModel + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.DelegateListModel

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/FilterComparator.html b/doc/org/unitConverter/converterGUI/class-use/FilterComparator.html new file mode 100644 index 0000000..45696dc --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/FilterComparator.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.FilterComparator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.FilterComparator

+
+
No usage of org.unitConverter.converterGUI.FilterComparator
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/GridBagBuilder.html b/doc/org/unitConverter/converterGUI/class-use/GridBagBuilder.html new file mode 100644 index 0000000..6dbde14 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/GridBagBuilder.html @@ -0,0 +1,225 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.GridBagBuilder + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.GridBagBuilder

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/MutablePredicate.html b/doc/org/unitConverter/converterGUI/class-use/MutablePredicate.html new file mode 100644 index 0000000..91113cd --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/MutablePredicate.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.MutablePredicate + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.MutablePredicate

+
+
No usage of org.unitConverter.converterGUI.MutablePredicate
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/SearchBoxList.html b/doc/org/unitConverter/converterGUI/class-use/SearchBoxList.html new file mode 100644 index 0000000..ef2d34c --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/SearchBoxList.html @@ -0,0 +1,218 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.SearchBoxList + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.SearchBoxList

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.Presenter.html b/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.Presenter.html new file mode 100644 index 0000000..e2116c8 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.Presenter.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.UnitConverterGUI.Presenter + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.UnitConverterGUI.Presenter

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.View.html b/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.View.html new file mode 100644 index 0000000..0660499 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.View.html @@ -0,0 +1,212 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.UnitConverterGUI.View + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.UnitConverterGUI.View

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.html b/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.html new file mode 100644 index 0000000..4cfc3f6 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/class-use/UnitConverterGUI.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.converterGUI.UnitConverterGUI + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.converterGUI.UnitConverterGUI

+
+
No usage of org.unitConverter.converterGUI.UnitConverterGUI
+
+ + + diff --git a/doc/org/unitConverter/converterGUI/package-frame.html b/doc/org/unitConverter/converterGUI/package-frame.html new file mode 100644 index 0000000..33d1aeb --- /dev/null +++ b/doc/org/unitConverter/converterGUI/package-frame.html @@ -0,0 +1,14 @@ + + + + + +org.unitConverter.converterGUI + + + + + +

org.unitConverter.converterGUI

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

Package org.unitConverter.converterGUI

+
+
The GUI interface of the Unit Converter.
+
+

See: Description

+
+
+ + +

Package org.unitConverter.converterGUI Description

+
The GUI interface of the Unit Converter.
+
+
Since:
+
2019-01-25, v0.2.0
+
Author:
+
Adrien Hopkins
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/converterGUI/package-tree.html b/doc/org/unitConverter/converterGUI/package-tree.html new file mode 100644 index 0000000..007991a --- /dev/null +++ b/doc/org/unitConverter/converterGUI/package-tree.html @@ -0,0 +1,127 @@ + + + + + +org.unitConverter.converterGUI Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package org.unitConverter.converterGUI

+Package Hierarchies: + +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/converterGUI/package-use.html b/doc/org/unitConverter/converterGUI/package-use.html new file mode 100644 index 0000000..83a9bc5 --- /dev/null +++ b/doc/org/unitConverter/converterGUI/package-use.html @@ -0,0 +1,124 @@ + + + + + +Uses of Package org.unitConverter.converterGUI + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
org.unitConverter.converterGUI

+
+
No usage of org.unitConverter.converterGUI
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html new file mode 100644 index 0000000..3607ffa --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceCollection.html @@ -0,0 +1,532 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceCollection + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceCollection<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractCollection<E>
      • +
    • +
        +
      • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection<E>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - type of element in collection
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>, java.util.Collection<E>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceCollection<E>
+extends java.util.AbstractCollection<E>
    +
    Elements in this collection only exist if they meet a condition.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      (package private) java.util.Collection<E>collection 
      (package private) java.util.function.Predicate<E>existenceCondition 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceCollection​(java.util.Collection<E> collection, + java.util.function.Predicate<E> existenceCondition) +
      Creates the ConditionalExistenceCollection.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanadd​(E e) 
      voidclear() 
      booleancontains​(java.lang.Object o) 
      java.util.Iterator<E>iterator() 
      booleanremove​(java.lang.Object o) 
      intsize() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractCollection

        +addAll, containsAll, isEmpty, removeAll, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Collection

        +equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray
        • +
      +
        +
      • + + +

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        collection

        +
        final java.util.Collection<E> collection
        +
        • +
      + + + +
        +
      • +

        existenceCondition

        +
        final java.util.function.Predicate<E> existenceCondition
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceCollection

        +
        private ConditionalExistenceCollection​(java.util.Collection<E> collection,
+                                       java.util.function.Predicate<E> existenceCondition)
        +
        Creates the ConditionalExistenceCollection.
        +
        +
        Parameters:
        +
        collection -
        +
        existenceCondition -
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

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

        clear

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

        contains

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

        iterator

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

        remove

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

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<E>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<E>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html new file mode 100644 index 0000000..0a3a963 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceIterator.html @@ -0,0 +1,493 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceIterator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceIterator<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceIterator<E>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - type of elements in iterator
    +
    +
    +
    All Implemented Interfaces:
    +
    java.util.Iterator<E>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceIterator<E>
+extends java.lang.Object
+implements java.util.Iterator<E>
    +
    Elements in this wrapper iterator only exist if they pass a condition.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      (package private) java.util.function.Predicate<E>existenceCondition 
      (package private) booleanhasNext 
      (package private) java.util.Iterator<E>iterator 
      (package private) EnextElement 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceIterator​(java.util.Iterator<E> iterator, + java.util.function.Predicate<E> condition) +
      Creates the ConditionalExistenceIterator.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private voidgetAndSetNextElement() +
      Gets the next element, and sets nextElement and hasNext accordingly.
      +
      booleanhasNext() 
      Enext() 
      voidremove() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Iterator

        +forEachRemaining
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        iterator

        +
        final java.util.Iterator<E> iterator
        +
        • +
      + + + +
        +
      • +

        existenceCondition

        +
        final java.util.function.Predicate<E> existenceCondition
        +
        • +
      + + + +
        +
      • +

        nextElement

        +
        E nextElement
        +
        • +
      + + + +
        +
      • +

        hasNext

        +
        boolean hasNext
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceIterator

        +
        private ConditionalExistenceIterator​(java.util.Iterator<E> iterator,
+                                     java.util.function.Predicate<E> condition)
        +
        Creates the ConditionalExistenceIterator.
        +
        +
        Parameters:
        +
        iterator -
        +
        condition -
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAndSetNextElement

        +
        private void getAndSetNextElement()
        +
        Gets the next element, and sets nextElement and hasNext accordingly.
        +
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        hasNext

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

        next

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

        remove

        +
        public void remove()
        +
        +
        Specified by:
        +
        remove in interface java.util.Iterator<E>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html new file mode 100644 index 0000000..1b7b1a7 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceMap.html @@ -0,0 +1,570 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceMap + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceMap<K,​V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractMap<K,​V>
      • +
    • +
        +
      • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap<K,​V>
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - key type
    +
    V - value type
    +
    +
    +
    All Implemented Interfaces:
    +
    java.util.Map<K,​V>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceMap<K,​V>
+extends java.util.AbstractMap<K,​V>
    +
    Mappings in this map only exist if the entry passes some condition.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from class java.util.AbstractMap

        +java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
        • +
      +
        +
      • + + +

        Nested classes/interfaces inherited from interface java.util.Map

        +java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      (package private) java.util.function.Predicate<java.util.Map.Entry<K,​V>>entryExistenceCondition 
      (package private) java.util.Map<K,​V>map 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceMap​(java.util.Map<K,​V> map, + java.util.function.Predicate<java.util.Map.Entry<K,​V>> entryExistenceCondition) +
      Creates the ConditionalExistenceMap.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleancontainsKey​(java.lang.Object key) 
      java.util.Set<java.util.Map.Entry<K,​V>>entrySet() 
      Vget​(java.lang.Object key) 
      java.util.Set<K>keySet() 
      Vput​(K key, + V value) 
      Vremove​(java.lang.Object key) 
      java.util.Collection<V>values() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractMap

        +clear, clone, containsValue, equals, hashCode, isEmpty, putAll, size, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Map

        +compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        map

        +
        java.util.Map<K,​V> map
        +
        • +
      + + + +
        +
      • +

        entryExistenceCondition

        +
        java.util.function.Predicate<java.util.Map.Entry<K,​V>> entryExistenceCondition
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceMap

        +
        private ConditionalExistenceMap​(java.util.Map<K,​V> map,
+                                java.util.function.Predicate<java.util.Map.Entry<K,​V>> entryExistenceCondition)
        +
        Creates the ConditionalExistenceMap.
        +
        +
        Parameters:
        +
        map -
        +
        entryExistenceCondition -
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        containsKey

        +
        public boolean containsKey​(java.lang.Object key)
        +
        +
        Specified by:
        +
        containsKey in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        containsKey in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        entrySet

        +
        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        +
        +
        Specified by:
        +
        entrySet in interface java.util.Map<K,​V>
        +
        Specified by:
        +
        entrySet in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        get

        +
        public V get​(java.lang.Object key)
        +
        +
        Specified by:
        +
        get in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        get in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        keySet

        +
        public java.util.Set<K> keySet()
        +
        +
        Specified by:
        +
        keySet in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        keySet in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + + + +
        +
      • +

        put

        +
        public V put​(K key,
+             V value)
        +
        +
        Specified by:
        +
        put in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        put in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        remove

        +
        public V remove​(java.lang.Object key)
        +
        +
        Specified by:
        +
        remove in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        remove in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      + + + +
        +
      • +

        values

        +
        public java.util.Collection<V> values()
        +
        +
        Specified by:
        +
        values in interface java.util.Map<K,​V>
        +
        Overrides:
        +
        values in class java.util.AbstractMap<K,​V>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html new file mode 100644 index 0000000..060e2a3 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.ConditionalExistenceSet.html @@ -0,0 +1,565 @@ + + + + + +ConditionalExistenceCollections.ConditionalExistenceSet + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollections.ConditionalExistenceSet<E>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.util.AbstractCollection<E>
      • +
    • +
        +
      • java.util.AbstractSet<E>
        • +
      • +
          +
        • org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet<E>
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - type of element in set
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>
    +
    +
    +
    Enclosing class:
    +
    ConditionalExistenceCollections
    +
    +
    +
    static final class ConditionalExistenceCollections.ConditionalExistenceSet<E>
+extends java.util.AbstractSet<E>
    +
    Elements in this set only exist if a certain condition is true.
    +
    +
    Since:
    +
    2019-10-17
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.function.Predicate<E>existenceCondition 
      private java.util.Set<E>set 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private ConditionalExistenceSet​(java.util.Set<E> set, + java.util.function.Predicate<E> existenceCondition) +
      Creates the ConditionalNonexistenceSet.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanadd​(E e)
      voidclear() 
      booleancontains​(java.lang.Object o) 
      java.util.Iterator<E>iterator() 
      booleanremove​(java.lang.Object o) 
      intsize() 
      +
        +
      • + + +

        Methods inherited from class java.util.AbstractSet

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

        Methods inherited from class java.util.AbstractCollection

        +addAll, containsAll, isEmpty, retainAll, toArray, toArray, toString
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.Collection

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

        Methods inherited from interface java.lang.Iterable

        +forEach
        • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Set

        +addAll, containsAll, isEmpty, retainAll, spliterator, toArray, toArray
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        set

        +
        private final java.util.Set<E> set
        +
        • +
      + + + +
        +
      • +

        existenceCondition

        +
        private final java.util.function.Predicate<E> existenceCondition
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceSet

        +
        private ConditionalExistenceSet​(java.util.Set<E> set,
+                                java.util.function.Predicate<E> existenceCondition)
        +
        Creates the ConditionalNonexistenceSet.
        +
        +
        Parameters:
        +
        set - set to use
        +
        existenceCondition - condition where element exists
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        add

        +
        public boolean add​(E e)
        +
        +

        + Note that this method returns false if e does not pass the existence condition.

        +
        +
        Specified by:
        +
        add in interface java.util.Collection<E>
        +
        Specified by:
        +
        add in interface java.util.Set<E>
        +
        Overrides:
        +
        add in class java.util.AbstractCollection<E>
        +
        +
        • +
      + + + +
        +
      • +

        clear

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

        contains

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

        iterator

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

        remove

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

        size

        +
        public int size()
        +
        +
        Specified by:
        +
        size in interface java.util.Collection<E>
        +
        Specified by:
        +
        size in interface java.util.Set<E>
        +
        Specified by:
        +
        size in class java.util.AbstractCollection<E>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollections.html b/doc/org/unitConverter/math/ConditionalExistenceCollections.html new file mode 100644 index 0000000..2764146 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollections.html @@ -0,0 +1,397 @@ + + + + + +ConditionalExistenceCollections + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.math
+

Class ConditionalExistenceCollections

+
+
+ +
+
    +
  • +
    +
    +
    public final class ConditionalExistenceCollections
+extends java.lang.Object
    +
    Elements in these wrapper collections only exist if they pass a condition. +

    + All of the collections in this class are "views" of the provided collections. They are mutable if the provided + collections are mutable, they allow null if the provided collections allow null, they will reflect changes in the + provided collection, etc. +

    + The modification operations will always run the corresponding operations, even if the conditional existence + collection doesn't change. For example, if you have a set that ignores even numbers, add(2) will still add a 2 to the + backing set (but the conditional existence set will say it doesn't exist). +

    + The returned collections do not pass the hashCode and equals operations through to the backing collections, + but rely on Object's equals and hashCode methods. This is necessary to preserve the contracts + of these operations in the case that the backing collections are sets or lists. +

    + Other than that, the only difference between the provided collections and the returned collections are that + elements don't exist if they don't pass the provided condition.

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static <E> java.util.Collection<E>conditionalExistenceCollection(java.util.Collection<E> collection, + java.util.function.Predicate<E> existenceCondition) +
      Elements in the returned wrapper collection are ignored if they don't pass a condition.
      +
      static <E> java.util.Iterator<E>conditionalExistenceIterator(java.util.Iterator<E> iterator, + java.util.function.Predicate<E> existenceCondition) +
      Elements in the returned wrapper iterator are ignored if they don't pass a condition.
      +
      static <K,V> java.util.Map<K,V>conditionalExistenceMap(java.util.Map<K,V> map, + java.util.function.Predicate<java.util.Map.Entry<K,V>> entryExistenceCondition) +
      Mappings in the returned wrapper map are ignored if the corresponding entry doesn't pass a condition
      +
      static <E> java.util.Set<E>conditionalExistenceSet(java.util.Set<E> set, + java.util.function.Predicate<E> existenceCondition) +
      Elements in the returned wrapper set are ignored if they don't pass a condition.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceCollections

        +
        public ConditionalExistenceCollections()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        conditionalExistenceCollection

        +
        public static final <E> java.util.Collection<E> conditionalExistenceCollection(java.util.Collection<E> collection,
+                                                                               java.util.function.Predicate<E> existenceCondition)
        +
        Elements in the returned wrapper collection are ignored if they don't pass a condition.
        +
        +
        Type Parameters:
        +
        E - type of elements in collection
        +
        Parameters:
        +
        collection - collection to wrap
        +
        existenceCondition - elements only exist if this returns true
        +
        Returns:
        +
        wrapper collection
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        conditionalExistenceIterator

        +
        public static final <E> java.util.Iterator<E> conditionalExistenceIterator(java.util.Iterator<E> iterator,
+                                                                           java.util.function.Predicate<E> existenceCondition)
        +
        Elements in the returned wrapper iterator are ignored if they don't pass a condition.
        +
        +
        Type Parameters:
        +
        E - type of elements in iterator
        +
        Parameters:
        +
        iterator - iterator to wrap
        +
        existenceCondition - elements only exist if this returns true
        +
        Returns:
        +
        wrapper iterator
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        conditionalExistenceMap

        +
        public static final <K,V> java.util.Map<K,V> conditionalExistenceMap(java.util.Map<K,V> map,
+                                                                     java.util.function.Predicate<java.util.Map.Entry<K,V>> entryExistenceCondition)
        +
        Mappings in the returned wrapper map are ignored if the corresponding entry doesn't pass a condition
        +
        +
        Type Parameters:
        +
        K - type of key in map
        +
        V - type of value in map
        +
        Parameters:
        +
        map - map to wrap
        +
        entryExistenceCondition - mappings only exist if this returns true
        +
        Returns:
        +
        wrapper map
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      + + + +
        +
      • +

        conditionalExistenceSet

        +
        public static final <E> java.util.Set<E> conditionalExistenceSet(java.util.Set<E> set,
+                                                                 java.util.function.Predicate<E> existenceCondition)
        +
        Elements in the returned wrapper set are ignored if they don't pass a condition.
        +
        +
        Type Parameters:
        +
        E - type of elements in set
        +
        Parameters:
        +
        set - set to wrap
        +
        existenceCondition - elements only exist if this returns true
        +
        Returns:
        +
        wrapper set
        +
        Since:
        +
        2019-10-17
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html b/doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html new file mode 100644 index 0000000..e08b3f5 --- /dev/null +++ b/doc/org/unitConverter/math/ConditionalExistenceCollectionsTest.html @@ -0,0 +1,469 @@ + + + + + +ConditionalExistenceCollectionsTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ConditionalExistenceCollectionsTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ConditionalExistenceCollectionsTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class ConditionalExistenceCollectionsTest
+extends java.lang.Object
    +
    Tests the #ConditionalExistenceCollections.
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      (package private) ConditionalExistenceCollections.ConditionalExistenceIterator<java.lang.String>getTestIterator() +
      The returned iterator ignores elements that don't start with "a".
      +
      (package private) java.util.Map<java.lang.String,​java.lang.Integer>getTestMap() +
      The returned map ignores mappings where the value is zero.
      +
      (package private) voidtestContainsKeyObject() +
      Test method for org.unitConverter.math.ZeroIsNullMap#containsKey(java.lang.Object).
      +
      (package private) voidtestContainsValueObject() +
      Test method for org.unitConverter.math.ZeroIsNullMap#containsValue(java.lang.Object).
      +
      (package private) voidtestEntrySet() +
      Test method for org.unitConverter.math.ZeroIsNullMap#entrySet().
      +
      (package private) voidtestGetObject() +
      Test method for org.unitConverter.math.ZeroIsNullMap#get(java.lang.Object).
      +
      (package private) voidtestIterator() 
      (package private) voidtestKeySet() +
      Test method for org.unitConverter.math.ZeroIsNullMap#keySet().
      +
      (package private) voidtestValues() +
      Test method for org.unitConverter.math.ZeroIsNullMap#values().
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ConditionalExistenceCollectionsTest

        +
        ConditionalExistenceCollectionsTest()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getTestMap

        +
        java.util.Map<java.lang.String,​java.lang.Integer> getTestMap()
        +
        The returned map ignores mappings where the value is zero.
        +
        +
        Returns:
        +
        map to be used for test data
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        testContainsKeyObject

        +
        @Test
+void testContainsKeyObject()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#containsKey(java.lang.Object).
        +
        • +
      + + + +
        +
      • +

        testContainsValueObject

        +
        @Test
+void testContainsValueObject()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#containsValue(java.lang.Object).
        +
        • +
      + + + +
        +
      • +

        testEntrySet

        +
        @Test
+void testEntrySet()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#entrySet().
        +
        • +
      + + + +
        +
      • +

        testGetObject

        +
        @Test
+void testGetObject()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#get(java.lang.Object).
        +
        • +
      + + + +
        +
      • +

        testIterator

        +
        @Test
+void testIterator()
        +
        • +
      + + + +
        +
      • +

        testKeySet

        +
        @Test
+void testKeySet()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#keySet().
        +
        • +
      + + + +
        +
      • +

        testValues

        +
        @Test
+void testValues()
        +
        Test method for org.unitConverter.math.ZeroIsNullMap#values().
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/DecimalComparison.html b/doc/org/unitConverter/math/DecimalComparison.html new file mode 100644 index 0000000..6b013fc --- /dev/null +++ b/doc/org/unitConverter/math/DecimalComparison.html @@ -0,0 +1,492 @@ + + + + + +DecimalComparison + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.math
+

Class DecimalComparison

+
+
+ +
+
    +
  • +
    +
    +
    public final class DecimalComparison
+extends java.lang.Object
    +
    A class that contains methods to compare float and double values.
    +
    +
    Since:
    +
    2019-03-18, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static doubleDOUBLE_EPSILON +
      The value used for double comparison.
      +
      static floatFLOAT_EPSILON +
      The value used for float comparison.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethod and Description
      static booleanequals(double a, + double b) +
      Tests for equality of double values using DOUBLE_EPSILON.
      +
      static booleanequals(double a, + double b, + double epsilon) +
      Tests for double equality using a custom epsilon value.
      +
      static booleanequals(float a, + float b) +
      Tests for equality of float values using FLOAT_EPSILON.
      +
      static booleanequals(float a, + float b, + float epsilon) +
      Tests for float equality using a custom epsilon value.
      +
      static inthash(double d) +
      Takes the hash code of doubles.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        DOUBLE_EPSILON

        +
        public static final double DOUBLE_EPSILON
        +
        The value used for double comparison. If two double values are within this value multiplied by the larger value, + they are considered equal.
        +
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        FLOAT_EPSILON

        +
        public static final float FLOAT_EPSILON
        +
        The value used for float comparison. If two float values are within this value multiplied by the larger value, + they are considered equal.
        +
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(double a,
+                                   double b)
        +
        Tests for equality of double values using DOUBLE_EPSILON. +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon using equals(double, double, double) (this does not make a violation of + transitivity impossible, it just significantly reduces the chances of it happening) +
        2. Use BigDecimal instead of double (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        See Also:
        +
        #hashCode(double)
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(double a,
+                                   double b,
+                                   double epsilon)
        +
        Tests for double equality using a custom epsilon value. + +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon (this does not make a violation of transitivity impossible, it just significantly + reduces the chances of it happening) +
        2. Use BigDecimal instead of double (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        epsilon - allowed difference
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(float a,
+                                   float b)
        +
        Tests for equality of float values using FLOAT_EPSILON. + +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon using equals(float, float, float) (this does not make a violation of + transitivity impossible, it just significantly reduces the chances of it happening) +
        2. Use BigDecimal instead of float (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public static final boolean equals(float a,
+                                   float b,
+                                   float epsilon)
        +
        Tests for float equality using a custom epsilon value. + +

        + WARNING: this method is not technically transitive. If a and b are off by slightly less than + epsilon * max(abs(a), abs(b)), and b and c are off by slightly less than + epsilon * max(abs(b), abs(c)), then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. +

        + If this does become a concern, some ways to solve this problem: +

          +
        1. Raise the value of epsilon (this does not make a violation of transitivity impossible, it just significantly + reduces the chances of it happening) +
        2. Use BigDecimal instead of float (this will make a violation of transitivity 100% impossible) +
        +
        +
        Parameters:
        +
        a - first value to test
        +
        b - second value to test
        +
        epsilon - allowed difference
        +
        Returns:
        +
        whether they are equal
        +
        Since:
        +
        2019-03-18, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        hash

        +
        public static final int hash(double d)
        +
        Takes the hash code of doubles. Values that are equal according to equals(double, double) will have the + same hash code.
        +
        +
        Parameters:
        +
        d - double to hash
        +
        Returns:
        +
        hash code of double
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ExpressionParser.Builder.html b/doc/org/unitConverter/math/ExpressionParser.Builder.html new file mode 100644 index 0000000..563f6eb --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.Builder.html @@ -0,0 +1,391 @@ + + + + + +ExpressionParser.Builder + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
org.unitConverter.math
+

Class ExpressionParser.Builder<T>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of object that exists in parsed expressions
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    +
    public static final class ExpressionParser.Builder<T>
+extends java.lang.Object
    +
    A builder that can create ExpressionParser<T> instances.
    +
    +
    Since:
    +
    2019-03-17, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      Builder(java.util.function.Function<java.lang.String,? extends T> objectObtainer) +
      Creates the Builder.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Builder

        +
        public Builder(java.util.function.Function<java.lang.String,? extends T> objectObtainer)
        +
        Creates the Builder.
        +
        +
        Parameters:
        +
        objectObtainer - a function that can turn strings into objects of the type handled by the parser.
        +
        Throws:
        +
        java.lang.NullPointerException - if objectObtainer is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        addBinaryOperator

        +
        public ExpressionParser.Builder<T> addBinaryOperator(java.lang.String text,
+                                                     java.util.function.BinaryOperator<T> operator,
+                                                     int priority)
        +
        Adds a binary operator to the builder.
        +
        +
        Parameters:
        +
        text - text used to reference the operator, like '+'
        +
        operator - operator to add
        +
        priority - operator's priority, which determines which operators are applied first
        +
        Returns:
        +
        this builder
        +
        Throws:
        +
        java.lang.NullPointerException - if text or operator is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        addSpaceFunction

        +
        public ExpressionParser.Builder<T> addSpaceFunction(java.lang.String operator)
        +
        Adds a function for spaces. You must use the text of an existing binary operator.
        +
        +
        Parameters:
        +
        operator - text of operator to use
        +
        Returns:
        +
        this builder
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        addUnaryOperator

        +
        public ExpressionParser.Builder<T> addUnaryOperator(java.lang.String text,
+                                                    java.util.function.UnaryOperator<T> operator,
+                                                    int priority)
        +
        Adds a unary operator to the builder.
        +
        +
        Parameters:
        +
        text - text used to reference the operator, like '-'
        +
        operator - operator to add
        +
        priority - operator's priority, which determines which operators are applied first
        +
        Returns:
        +
        this builder
        +
        Throws:
        +
        java.lang.NullPointerException - if text or operator is null
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        build

        +
        public ExpressionParser<T> build()
        +
        +
        Returns:
        +
        an ExpressionParser<T> instance with the properties given to this builder
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html b/doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html new file mode 100644 index 0000000..ad8f42a --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.PriorityBinaryOperator.html @@ -0,0 +1,425 @@ + + + + + +ExpressionParser.PriorityBinaryOperator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ExpressionParser.PriorityBinaryOperator<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ExpressionParser.PriorityBinaryOperator<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of operand and result
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<ExpressionParser.PriorityBinaryOperator<T>>, java.util.function.BiFunction<T,​T,​T>, java.util.function.BinaryOperator<T>
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    private abstract static class ExpressionParser.PriorityBinaryOperator<T>
+extends java.lang.Object
+implements java.util.function.BinaryOperator<T>, java.lang.Comparable<ExpressionParser.PriorityBinaryOperator<T>>
    +
    A binary operator with a priority field that determines which operators apply first.
    +
    +
    Since:
    +
    2019-03-17, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intpriority +
      The operator's priority.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PriorityBinaryOperator​(int priority) +
      Creates the PriorityBinaryOperator.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        priority

        +
        private final int priority
        +
        The operator's priority. Higher-priority operators are applied before lower-priority operators
        +
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PriorityBinaryOperator

        +
        public PriorityBinaryOperator​(int priority)
        +
        Creates the PriorityBinaryOperator.
        +
        +
        Parameters:
        +
        priority - operator's priority
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(ExpressionParser.PriorityBinaryOperator<T> o)
        +
        Compares this object to another by priority. + +

        + +

        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<T>
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPriority

        +
        public final int getPriority()
        +
        +
        Returns:
        +
        priority
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html b/doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html new file mode 100644 index 0000000..cddfb62 --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.PriorityUnaryOperator.html @@ -0,0 +1,425 @@ + + + + + +ExpressionParser.PriorityUnaryOperator + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ExpressionParser.PriorityUnaryOperator<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ExpressionParser.PriorityUnaryOperator<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of operand and result
    +
    +
    +
    All Implemented Interfaces:
    +
    java.lang.Comparable<ExpressionParser.PriorityUnaryOperator<T>>, java.util.function.Function<T,​T>, java.util.function.UnaryOperator<T>
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    private abstract static class ExpressionParser.PriorityUnaryOperator<T>
+extends java.lang.Object
+implements java.util.function.UnaryOperator<T>, java.lang.Comparable<ExpressionParser.PriorityUnaryOperator<T>>
    +
    A unary operator with a priority field that determines which operators apply first.
    +
    +
    Since:
    +
    2019-03-17, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intpriority +
      The operator's priority.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PriorityUnaryOperator​(int priority) +
      Creates the PriorityUnaryOperator.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      intcompareTo​(ExpressionParser.PriorityUnaryOperator<T> o) +
      Compares this object to another by priority.
      +
      intgetPriority() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface java.util.function.Function

        +andThen, apply, compose
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        priority

        +
        private final int priority
        +
        The operator's priority. Higher-priority operators are applied before lower-priority operators
        +
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PriorityUnaryOperator

        +
        public PriorityUnaryOperator​(int priority)
        +
        Creates the PriorityUnaryOperator.
        +
        +
        Parameters:
        +
        priority - operator's priority
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo​(ExpressionParser.PriorityUnaryOperator<T> o)
        +
        Compares this object to another by priority. + +

        + +

        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<T>
        +
        Since:
        +
        2019-03-17, v0.2.0
        +
        +
        • +
      + + + +
        +
      • +

        getPriority

        +
        public final int getPriority()
        +
        +
        Returns:
        +
        priority
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ExpressionParser.TokenType.html b/doc/org/unitConverter/math/ExpressionParser.TokenType.html new file mode 100644 index 0000000..40c9d05 --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.TokenType.html @@ -0,0 +1,445 @@ + + + + + +ExpressionParser.TokenType + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Enum ExpressionParser.TokenType

+
+
+
    +
  • java.lang.Object
    • +
  • + +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ExpressionParser.TokenType>
    +
    +
    +
    Enclosing class:
    +
    ExpressionParser<T>
    +
    +
    +
    private static enum ExpressionParser.TokenType
+extends java.lang.Enum<ExpressionParser.TokenType>
    +
    The types of tokens that are available.
    +
    +
    Since:
    +
    2019-03-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private TokenType() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static ExpressionParser.TokenTypevalueOf​(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ExpressionParser.TokenType[]values() +
      Returns an array containing the constants of this enum type, in +the order they are declared.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Enum

        +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +getClass, notify, notifyAll, wait, wait, wait
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TokenType

        +
        private TokenType()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ExpressionParser.TokenType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ExpressionParser.TokenType c : ExpressionParser.TokenType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ExpressionParser.TokenType valueOf​(java.lang.String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        +
        java.lang.NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ExpressionParser.html b/doc/org/unitConverter/math/ExpressionParser.html new file mode 100644 index 0000000..601bf35 --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParser.html @@ -0,0 +1,349 @@ + + + + + +ExpressionParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
org.unitConverter.math
+

Class ExpressionParser<T>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    T - type of object that exists in parsed expressions
    +
    +
    +
    +
    public final class ExpressionParser<T>
+extends java.lang.Object
    +
    An object that can parse expressions with unary or binary operators.
    +
    +
    Since:
    +
    2019-03-14, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeClass and Description
      static class ExpressionParser.Builder<T> +
      A builder that can create ExpressionParser<T> instances.
      +
      +
      • +
    + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static charCLOSING_BRACKET +
      The closing bracket.
      +
      static charOPENING_BRACKET +
      The opening bracket.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      TparseExpression(java.lang.String expression) +
      Parses an expression.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        OPENING_BRACKET

        +
        public static final char OPENING_BRACKET
        +
        The opening bracket.
        +
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        CLOSING_BRACKET

        +
        public static final char CLOSING_BRACKET
        +
        The closing bracket.
        +
        +
        Since:
        +
        2019-03-22, v0.2.0
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseExpression

        +
        public T parseExpression(java.lang.String expression)
        +
        Parses an expression.
        +
        +
        Parameters:
        +
        expression - expression to parse
        +
        Returns:
        +
        result
        +
        Throws:
        +
        java.lang.NullPointerException - if expression is null
        +
        Since:
        +
        2019-03-14, v0.2.0
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ExpressionParserTest.html b/doc/org/unitConverter/math/ExpressionParserTest.html new file mode 100644 index 0000000..e39075d --- /dev/null +++ b/doc/org/unitConverter/math/ExpressionParserTest.html @@ -0,0 +1,360 @@ + + + + + +ExpressionParserTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ExpressionParserTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ExpressionParserTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class ExpressionParserTest
+extends java.lang.Object
    +
    A test for the ExpressionParser class. This is NOT part of this program's public API.
    +
    +
    Since:
    +
    2019-03-22, v0.2.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/doc/org/unitConverter/math/ObjectProduct.html b/doc/org/unitConverter/math/ObjectProduct.html new file mode 100644 index 0000000..08f8e8f --- /dev/null +++ b/doc/org/unitConverter/math/ObjectProduct.html @@ -0,0 +1,553 @@ + + + + + +ObjectProduct + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
org.unitConverter.math
+

Class ObjectProduct<T>

+
+
+ +
+
    +
  • +
    +
    +
    public final class ObjectProduct<T>
+extends java.lang.Object
    +
    An immutable product of multiple objects of a type, such as base units. The objects can be multiplied and + exponentiated.
    +
    +
    Since:
    +
    2019-10-16
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        empty

        +
        public static final <T> ObjectProduct<T> empty()
        +
        Returns an empty ObjectProduct of a certain type
        +
        +
        Type Parameters:
        +
        T - type of objects that can be multiplied
        +
        Returns:
        +
        empty product
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        fromExponentMapping

        +
        public static final <T> ObjectProduct<T> fromExponentMapping(java.util.Map<T,java.lang.Integer> map)
        +
        Gets an ObjectProduct from an object-to-integer mapping
        +
        +
        Type Parameters:
        +
        T - type of object in product
        +
        Parameters:
        +
        map - map mapping objects to exponents
        +
        Returns:
        +
        object product
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + + + +
        +
      • +

        oneOf

        +
        public static final <T> ObjectProduct<T> oneOf(T object)
        +
        Gets an ObjectProduct that has one of the inputted argument, and nothing else.
        +
        +
        Parameters:
        +
        object - object that will be in the product
        +
        Returns:
        +
        product
        +
        Throws:
        +
        java.lang.NullPointerException - if object is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        dividedBy

        +
        public ObjectProduct<T> dividedBy(ObjectProduct<T> other)
        +
        Calculates the quotient of two products
        +
        +
        Parameters:
        +
        other - other product
        +
        Returns:
        +
        quotient of two products
        +
        Throws:
        +
        java.lang.NullPointerException - if other is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        exponentMap

        +
        public java.util.Map<T,java.lang.Integer> exponentMap()
        +
        +
        Returns:
        +
        immutable map mapping objects to exponents
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        getBaseSet

        +
        public final java.util.Set<T> getBaseSet()
        +
        +
        Returns:
        +
        a set of all of the base objects with non-zero exponents that make up this dimension.
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      + + + + + +
        +
      • +

        getExponent

        +
        public int getExponent(T dimension)
        +
        Gets the exponent for a specific dimension.
        +
        +
        Parameters:
        +
        dimension - dimension to check
        +
        Returns:
        +
        exponent for that dimension
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        isSingleObject

        +
        public boolean isSingleObject()
        +
        +
        Returns:
        +
        true if this product is a single object, i.e. it has one exponent of one and no other nonzero exponents
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        times

        +
        public ObjectProduct<T> times(ObjectProduct<T> other)
        +
        Multiplies this product by another
        +
        +
        Parameters:
        +
        other - other product
        +
        Returns:
        +
        product of two products
        +
        Throws:
        +
        java.lang.NullPointerException - if other is null
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        toExponent

        +
        public ObjectProduct<T> toExponent(int exponent)
        +
        Returns this product, but to an exponent
        +
        +
        Parameters:
        +
        exponent - exponent
        +
        Returns:
        +
        result of exponentiation
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString()
        +
        Converts this product to a string using the objects' Object.toString() method. If objects have a long + toString representation, it is recommended to use toString(Function) instead to shorten the returned + string. + +

        +

        +
        +
        Overrides:
        +
        toString in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public java.lang.String toString(java.util.function.Function<T,java.lang.String> objectToString)
        +
        Converts this product to a string. The objects that make up this product are represented by + objectToString
        +
        +
        Parameters:
        +
        objectToString - function to convert objects to strings
        +
        Returns:
        +
        string representation of product
        +
        Since:
        +
        2019-10-16
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/doc/org/unitConverter/math/ObjectProductTest.html b/doc/org/unitConverter/math/ObjectProductTest.html new file mode 100644 index 0000000..2fb1aa4 --- /dev/null +++ b/doc/org/unitConverter/math/ObjectProductTest.html @@ -0,0 +1,366 @@ + + + + + +ObjectProductTest + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.unitConverter.math
+

Class ObjectProductTest

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.unitConverter.math.ObjectProductTest
      • +
    +
    • +
+
+
    +
  • +
    +
    class ObjectProductTest
+extends java.lang.Object
    +
    Tests for ObjectProduct using BaseDimension as a test object. This is NOT part of this program's public API.
    +
    +
    Since:
    +
    2018-12-12, v0.1.0
    +
    Author:
    +
    Adrien Hopkins
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      ObjectProductTest() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidtestEquals() +
      Tests UnitDimension#equals
      +
      voidtestExponents() +
      Tests UnitDimension's exponentiation
      +
      voidtestMultiplicationAndDivision() +
      Tests UnitDimension's multiplication and division.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ObjectProductTest

        +
        ObjectProductTest()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        testEquals

        +
        @Test
+public void testEquals()
        +
        Tests UnitDimension#equals
        +
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        testExponents

        +
        @Test
+public void testExponents()
        +
        Tests UnitDimension's exponentiation
        +
        +
        Since:
        +
        2019-01-15, v0.1.0
        +
        +
        • +
      + + + +
        +
      • +

        testMultiplicationAndDivision

        +
        @Test
+public void testMultiplicationAndDivision()
        +
        Tests UnitDimension's multiplication and division.
        +
        +
        Since:
        +
        2018-12-12, v0.1.0
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html new file mode 100644 index 0000000..b8b2122 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceCollection.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceCollection
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html new file mode 100644 index 0000000..c521457 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceIterator.html @@ -0,0 +1,197 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceIterator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceIterator

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html new file mode 100644 index 0000000..fe3a0ec --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceMap.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceMap
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html new file mode 100644 index 0000000..e35104b --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollections.ConditionalExistenceSet.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections.ConditionalExistenceSet

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

Uses of Class
org.unitConverter.math.ConditionalExistenceCollections

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollections
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html new file mode 100644 index 0000000..4fa2386 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ConditionalExistenceCollectionsTest.html @@ -0,0 +1,149 @@ + + + + + +Uses of Class org.unitConverter.math.ConditionalExistenceCollectionsTest + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ConditionalExistenceCollectionsTest

+
+
No usage of org.unitConverter.math.ConditionalExistenceCollectionsTest
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/DecimalComparison.html b/doc/org/unitConverter/math/class-use/DecimalComparison.html new file mode 100644 index 0000000..0090edb --- /dev/null +++ b/doc/org/unitConverter/math/class-use/DecimalComparison.html @@ -0,0 +1,124 @@ + + + + + +Uses of Class org.unitConverter.math.DecimalComparison + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.DecimalComparison

+
+
No usage of org.unitConverter.math.DecimalComparison
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html b/doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html new file mode 100644 index 0000000..fdedeca --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.Builder.html @@ -0,0 +1,184 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.Builder + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ExpressionParser.Builder

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html new file mode 100644 index 0000000..86c2daf --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityBinaryOperator.html @@ -0,0 +1,221 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.PriorityBinaryOperator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParser.PriorityBinaryOperator

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html new file mode 100644 index 0000000..1d8f896 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.PriorityUnaryOperator.html @@ -0,0 +1,239 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.PriorityUnaryOperator + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParser.PriorityUnaryOperator

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html b/doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html new file mode 100644 index 0000000..7932193 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.TokenType.html @@ -0,0 +1,212 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser.TokenType + + + + + + + + + + + + + + + +
+ +
+
+
+

Uses of Class
org.unitConverter.math.ExpressionParser.TokenType

+
+
+ +
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ExpressionParser.html b/doc/org/unitConverter/math/class-use/ExpressionParser.html new file mode 100644 index 0000000..2e75c83 --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ExpressionParser.html @@ -0,0 +1,166 @@ + + + + + +Uses of Class org.unitConverter.math.ExpressionParser + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ExpressionParser

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

Uses of Class
org.unitConverter.math.ExpressionParserTest

+
+
No usage of org.unitConverter.math.ExpressionParserTest
+
+ + + diff --git a/doc/org/unitConverter/math/class-use/ObjectProduct.html b/doc/org/unitConverter/math/class-use/ObjectProduct.html new file mode 100644 index 0000000..1f326fa --- /dev/null +++ b/doc/org/unitConverter/math/class-use/ObjectProduct.html @@ -0,0 +1,515 @@ + + + + + +Uses of Class org.unitConverter.math.ObjectProduct + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
org.unitConverter.math.ObjectProduct

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

Uses of Class
org.unitConverter.math.ObjectProductTest

+
+
No usage of org.unitConverter.math.ObjectProductTest
+
+ + + diff --git a/doc/org/unitConverter/math/package-frame.html b/doc/org/unitConverter/math/package-frame.html new file mode 100644 index 0000000..46d3edd --- /dev/null +++ b/doc/org/unitConverter/math/package-frame.html @@ -0,0 +1,24 @@ + + + + + +org.unitConverter.math + + + + + +

org.unitConverter.math

+
+

Classes

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

Package org.unitConverter.math

+
+
Supplementary classes that are not related to units, but are necessary for their function.
+
+

See: Description

+
+
+ + + + +

Package org.unitConverter.math Description

+
Supplementary classes that are not related to units, but are necessary for their function.
+
+
Since:
+
2019-03-14, v0.2.0
+
Author:
+
Adrien Hopkins
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/math/package-tree.html b/doc/org/unitConverter/math/package-tree.html new file mode 100644 index 0000000..116fe4e --- /dev/null +++ b/doc/org/unitConverter/math/package-tree.html @@ -0,0 +1,141 @@ + + + + + +org.unitConverter.math Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package org.unitConverter.math

+Package Hierarchies: + +
+
+

Class Hierarchy

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

Uses of Package
org.unitConverter.math

+
+
+ +
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/package-frame.html b/doc/org/unitConverter/package-frame.html new file mode 100644 index 0000000..845bd90 --- /dev/null +++ b/doc/org/unitConverter/package-frame.html @@ -0,0 +1,14 @@ + + + + + +org.unitConverter + + + + + +

org.unitConverter

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

Package org.unitConverter

+
+
A program that converts units.
+
+

See: Description

+
+
+ + +

Package org.unitConverter Description

+
A program that converts units.
+
+
Since:
+
2019-01-25
+
Version:
+
v0.2.0
+
Author:
+
Adrien Hopkins
+
+
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/org/unitConverter/package-tree.html b/doc/org/unitConverter/package-tree.html new file mode 100644 index 0000000..1f5a0a0 --- /dev/null +++ b/doc/org/unitConverter/package-tree.html @@ -0,0 +1,127 @@ + + + + + +org.unitConverter Class Hierarchy + + + + + + + + +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package org.unitConverter

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

Uses of Package
org.unitConverter

+
+
No usage of org.unitConverter
+ +
+ + +
Skip navigation links
+ + + + +
+
+ + + +
+ +
+ + +
+ + + 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