org.unitConverter.unit

Class NameSymbol

java.lang.Object

org.unitConverter.unit.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 Type	Field and Description
static NameSymbol	EMPTY

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getOtherNames()
java.util.Optional<java.lang.String>	getPrimaryName()
java.util.Optional<java.lang.String>	getSymbol()
static NameSymbol	of(java.lang.String name, java.lang.String symbol) Gets a NameSymbol with a primary name, a symbol and no other names.
static 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.
static 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.
static 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.
static 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.
static 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.
static NameSymbol	ofName(java.lang.String name) Gets a NameSymbol with a primary name, no symbol, and no other names.
static 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.
static 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.
static NameSymbol	ofSymbol(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

Field Detail

EMPTY

public static final NameSymbol EMPTY

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