Package com.irurueta.units

Class MagneticFluxDensityFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

com.irurueta.units.MagneticFluxDensityFormatter

All Implemented Interfaces:

Cloneable

public class MagneticFluxDensityFormatter
extends MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Formats and parses magnetic flux density value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GIGATESLA	Gigatesla symbol.
static final String	KILOTESLA	Kilotesla symbol.
static final String	MEGATESLA	Megatesla symbol.
static final String	MICROTESLA	Microtesla symbol.
static final String	MILLITESLA	Millitesla symbol.
static final String	NANOTESLA	Nanotesla symbol.
static final String	TESLA	Tesla symbol.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

Constructor	Description
MagneticFluxDensityFormatter()	Constructor.
MagneticFluxDensityFormatter(MagneticFluxDensityFormatter formatter)	Copy constructor.
MagneticFluxDensityFormatter(Locale locale)	Constructor with locale.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Determines if two magnetic flux density formatters are equal by comparing all of their internal parameters.
MagneticFluxDensityUnit	findUnit(String source)	Attempts to determine a magnetic flux density unit within a string representation.
String	formatAndConvert(Number value, MagneticFluxDensityUnit unit, UnitSystem system)	Formats and converts provided magnetic flux density value and unit using provided unit system.
String	formatAndConvertMetric(Number value, MagneticFluxDensityUnit unit)	Formats and converts provided magnetic flux density value and unit using metric unit system.
String	getUnitSymbol(MagneticFluxDensityUnit unit)	Returns unit string representation.
UnitSystem	getUnitSystem()	Returns unit system this instance will use based on its assigned locale.
UnitSystem	getUnitSystem(String source)	Gets unit system for detected unit into provided string representation of a measurement.
int	hashCode()	Hash code generated for this instance.
MagneticFluxDensity	parse(String source)	Parses provided string and tries to determine a magnetic flux density value and unit.

Methods inherited from class com.irurueta.units.MeasureFormatter

clone, format, format, format, format, format, format, formatAndConvert, formatAndConvert, formatAndConvert, formatAndConvert, formatAndConvert, getAvailableLocales, getLocale, getMaximumFractionDigits, getMaximumIntegerDigits, getMinimumFractionDigits, getMinimumIntegerDigits, getRoundingMode, getValueAndUnitFormatPattern, internalClone, internalParse, isGroupingUsed, isImperialUnit, isMetricUnit, isParseIntegerOnly, isValidMeasurement, isValidUnit, setGroupingUsed, setMaximumFractionDigits, setMaximumIntegerDigits, setMinimumFractionDigits, setMinimumIntegerDigits, setParseIntegerOnly, setRoundingMode, setValueAndUnitFormatPattern

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

NANOTESLA

public static final String NANOTESLA

Nanotesla symbol.

See Also:

• Constant Field Values

MICROTESLA

public static final String MICROTESLA

Microtesla symbol.

See Also:

• Constant Field Values

MILLITESLA

public static final String MILLITESLA

Millitesla symbol.

See Also:

• Constant Field Values

TESLA

public static final String TESLA

Tesla symbol.

See Also:

• Constant Field Values

KILOTESLA

public static final String KILOTESLA

Kilotesla symbol.

See Also:

• Constant Field Values

MEGATESLA

public static final String MEGATESLA

Megatesla symbol.

See Also:

• Constant Field Values

GIGATESLA

public static final String GIGATESLA

Gigatesla symbol.

See Also:

• Constant Field Values

Constructor Details

MagneticFluxDensityFormatter

public MagneticFluxDensityFormatter()

Constructor.

MagneticFluxDensityFormatter

public MagneticFluxDensityFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

MagneticFluxDensityFormatter

public MagneticFluxDensityFormatter(MagneticFluxDensityFormatter formatter)

Copy constructor.

Parameters:

formatter - input instance to copy from.

Throws:

NullPointerException - if provided formatter is null.

Method Details

equals

public boolean equals(Object obj)

Determines if two magnetic flux density formatters are equal by comparing all of their internal parameters.

Overrides:

equals in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Parameters:

obj - another object to compare.

Returns:

true if provided object is assumed to be equal to this instance.

hashCode

public int hashCode()

Hash code generated for this instance. Hash codes can be internally used by some collections to coarsely compare objects. This implementation only calls parent implementation to avoid static analyzer warning.

Overrides:

hashCode in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Returns:

hash code.

getUnitSystem

public UnitSystem getUnitSystem(String source)

Gets unit system for detected unit into provided string representation of a measurement.

Specified by:

getUnitSystem in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Parameters:

source - a measurement string representation to be checked.

Returns:

a unit system (either metric or imperial) or null if unit cannot be determined.

parse

public MagneticFluxDensity parse(String source)
                          throws ParseException,
UnknownUnitException

Parses provided string and tries to determine a magnetic flux density value and unit.

Specified by:

parse in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Parameters:

source - a string to be parsed.

Returns:

a magnetic flux density containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public MagneticFluxDensityUnit findUnit(String source)

Attempts to determine a magnetic flux density unit within a string representation.

Specified by:

findUnit in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Parameters:

source - a magnetic flux density string representation.

Returns:

a magnetic flux density unit, or null if nonce can be determined.

formatAndConvert

public String formatAndConvert(Number value,
 MagneticFluxDensityUnit unit,
 UnitSystem system)

Formats and converts provided magnetic flux density value and unit using provided unit system. If provided value is too large for provided unit, this method will convert it to a more appropriate unit. This implementation ignores unit system.

Specified by:

formatAndConvert in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Parameters:

value - a measurement value.

unit - a measurement unit.

system - system unit to convert measurement to (it is ignored).

Returns:

a string representation of magnetic flux density value and unit.

formatAndConvertMetric

public String formatAndConvertMetric(Number value,
 MagneticFluxDensityUnit unit)

Formats and converts provided magnetic flux density value and unit using metric unit system. If provided magnetic flux density value is too large for provided magnetic flux density unit, this method will convert it to a more appropriate unit.

Parameters:

value - a magnetic flux density value.

unit - a magnetic flux density unit.

Returns:

a string representation of magnetic flux density value and unit using metric unit system.

getUnitSymbol

public String getUnitSymbol(MagneticFluxDensityUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Parameters:

unit - a frequency unit.

Returns:

its string representation

getUnitSystem

public UnitSystem getUnitSystem()

Returns unit system this instance will use based on its assigned locale. Notice that if no locale was assigned, then the default system locale will be used.

Overrides:

getUnitSystem in class MeasureFormatter<MagneticFluxDensity,MagneticFluxDensityUnit>

Returns:

unit system this instance will use.