Package com.irurueta.units

Class SurfaceFormatter

java.lang.Object

com.irurueta.units.MeasureFormatter<Surface,SurfaceUnit>

com.irurueta.units.SurfaceFormatter

All Implemented Interfaces:

Cloneable

public class SurfaceFormatter
extends MeasureFormatter<Surface,SurfaceUnit>

Formats and parses surface value and unit.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACRE	Acre symbol.
static final String	ARE	Are symbol.
static final String	CENTIARE	Centiare symbol.
static final String	DECARE	Decare symbol.
static final String	HECTARE	Hectare symbol.
static final String	SQUARE_CENTIMETER	Square centimeter symbol.
static final String	SQUARE_FOOT	Square foot symbol.
static final String	SQUARE_INCH	Square inch symbol.
static final String	SQUARE_KILOMETER	Square kilometer symbol.
static final String	SQUARE_METER	Square meter symbol.
static final String	SQUARE_MILE	Square mile symbol.
static final String	SQUARE_MILLIMETER	Square millimeter symbol.
static final String	SQUARE_YARD	Square yard symbol.

Fields inherited from class com.irurueta.units.MeasureFormatter

DEFAULT_VALUE_AND_UNIT_FORMAT_PATTERN, numberFormat

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Determines if two distance formatters are equal by comparing all of its internal parameters.
SurfaceUnit	findUnit(String source)	Attempts to determine a surface unit within a measurement string representation.
String	formatAndConvert(Number value, SurfaceUnit unit, UnitSystem system)	Formats and converts provided surface value and unit using provided unit system.
String	formatAndConvertImperial(Number value, SurfaceUnit unit)	Formats and converts provided surface value and unit using imperial unit system.
String	formatAndConvertMetric(Number value, SurfaceUnit unit)	Formats and converts provided surface value and unit using metric unit system.
String	getUnitSymbol(SurfaceUnit unit)	Returns unit string representation.
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.
Surface	parse(String source)	Parses provided string and tries to determine a surface 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, getUnitSystem, 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

SQUARE_MILLIMETER

public static final String SQUARE_MILLIMETER

Square millimeter symbol.

See Also:

• Constant Field Values

SQUARE_CENTIMETER

public static final String SQUARE_CENTIMETER

Square centimeter symbol.

See Also:

• Constant Field Values

SQUARE_METER

public static final String SQUARE_METER

Square meter symbol.

See Also:

• Constant Field Values

SQUARE_KILOMETER

public static final String SQUARE_KILOMETER

Square kilometer symbol.

See Also:

• Constant Field Values

SQUARE_INCH

public static final String SQUARE_INCH

Square inch symbol.

See Also:

• Constant Field Values

SQUARE_FOOT

public static final String SQUARE_FOOT

Square foot symbol.

See Also:

• Constant Field Values

SQUARE_YARD

public static final String SQUARE_YARD

Square yard symbol.

See Also:

• Constant Field Values

SQUARE_MILE

public static final String SQUARE_MILE

Square mile symbol.

See Also:

• Constant Field Values

CENTIARE

public static final String CENTIARE

Centiare symbol.

See Also:

• Constant Field Values

ARE

public static final String ARE

Are symbol.

See Also:

• Constant Field Values

DECARE

public static final String DECARE

Decare symbol.

See Also:

• Constant Field Values

HECTARE

public static final String HECTARE

Hectare symbol.

See Also:

• Constant Field Values

ACRE

public static final String ACRE

Acre symbol.

See Also:

• Constant Field Values

Constructor Details

SurfaceFormatter

public SurfaceFormatter()

Constructor.

SurfaceFormatter

public SurfaceFormatter(Locale locale)

Constructor with locale.

Parameters:

locale - locale.

Throws:

IllegalArgumentException - if locale is null.

SurfaceFormatter

public SurfaceFormatter(SurfaceFormatter 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 distance formatters are equal by comparing all of its internal parameters.

Overrides:

equals in class MeasureFormatter<Surface,SurfaceUnit>

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<Surface,SurfaceUnit>

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<Surface,SurfaceUnit>

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 Surface parse(String source)
              throws ParseException,
UnknownUnitException

Parses provided string and tries to determine a surface value and unit.

Specified by:

parse in class MeasureFormatter<Surface,SurfaceUnit>

Parameters:

source - text to be parsed.

Returns:

a surface containing a value and unit.

Throws:

ParseException - if provided string cannot be parsed.

UnknownUnitException - if unit cannot be determined.

findUnit

public SurfaceUnit findUnit(String source)

Attempts to determine a surface unit within a measurement string representation.

Specified by:

findUnit in class MeasureFormatter<Surface,SurfaceUnit>

Parameters:

source - a surface measurement string representation.

Returns:

a surface unit, or null if none can be determined.

formatAndConvert

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

Formats and converts provided surface 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 using provided unit system (either metric or imperial).

Specified by:

formatAndConvert in class MeasureFormatter<Surface,SurfaceUnit>

Parameters:

value - a surface value.

unit - a surface unit.

system - system unit to convert surface to.

Returns:

a string representation of surface value and unit.

formatAndConvertMetric

public String formatAndConvertMetric(Number value,
 SurfaceUnit unit)

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

Parameters:

value - a surface value.

unit - a surface unit.

Returns:

a string representation of surface value and unit using metric unit system.

formatAndConvertImperial

public String formatAndConvertImperial(Number value,
 SurfaceUnit unit)

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

Parameters:

value - a surface value.

unit - a surface unit.

Returns:

a string representation of surface value and unit using imperial unit system.

getUnitSymbol

public String getUnitSymbol(SurfaceUnit unit)

Returns unit string representation.

Specified by:

getUnitSymbol in class MeasureFormatter<Surface,SurfaceUnit>

Parameters:

unit - a measure unit.

Returns:

its string representation.