From 2c146c894972e2c6ab701b3c66dcf242d7be656f Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Tue, 24 Dec 2019 16:16:13 -0500 Subject: Added Javadoc to the project. --- doc/org/unitConverter/unit/NameSymbol.html | 641 +++++++++++++++++++++++++++++ 1 file changed, 641 insertions(+) create mode 100644 doc/org/unitConverter/unit/NameSymbol.html (limited to 'doc/org/unitConverter/unit/NameSymbol.html') 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
    • +
+ +
+ + +
+ + + -- cgit v1.2.3