fr.cnes.genius.unit

Class GByteUnit

java.lang.Object

fr.cnes.genius.unit.GByteUnit

All Implemented Interfaces:

GUnit

public class GByteUnit
extends Object
implements GUnit

Class in charge of managing the conversions between the kilobyte, megabyte and gigabyte units. The valid unit names are "K", "M" and "G". The memory unit is the kilobyte value.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GIGABYTE_STRING Gigabyte string.
static String	KILOBYTE_STRING Kilobyte string.
static String	MEGABYTE_STRING Megabyte string.

Constructor Summary

Constructors

Constructor and Description
GByteUnit(String unitName) Constructor.

Method Summary

Modifier and Type	Method and Description
BigDecimal	convertFromMemory(BigDecimal value) Converts the value from the memory unit.
double	convertFromMemory(double value) Converts the value from the memory unit.
BigDecimal	convertToMemory(BigDecimal value) Converts the value to the memory unit.
double	convertToMemory(double value) Converts the value to the memory unit.
BigDecimal	convertToUnit(BigDecimal value, GUnit destUnit) Converts the units of value to unit.
double	convertToUnit(double value, GUnit destUnit) Converts the units of value to unit.
String	getCompactedName() Returns the name of the unit decomposed in basicUnits, without multipliers and sorted.
String	getName() Get the unit name.
boolean	isCompatible(GUnit unit) Check if unit value is compatible
boolean	isValidUnitName(String unitName) Check the unit name validity

Methods inherited from class java.lang.Object

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

Field Detail

KILOBYTE_STRING

public static final String KILOBYTE_STRING

Kilobyte string.

See Also:

Constant Field Values

MEGABYTE_STRING

public static final String MEGABYTE_STRING

Megabyte string.

See Also:

Constant Field Values

GIGABYTE_STRING

public static final String GIGABYTE_STRING

Gigabyte string.

See Also:

Constant Field Values

Constructor Detail

GByteUnit

public GByteUnit(String unitName)

Constructor.

Parameters:

unitName - name of the unit. It must be a valid unit name.

Method Detail

isValidUnitName

public boolean isValidUnitName(String unitName)

Check the unit name validity

Specified by:

isValidUnitName in interface GUnit

Parameters:

unitName - unit name string to test.

Returns:

true if the unit name represents a valid unit, false otherwise.

isCompatible

public boolean isCompatible(GUnit unit)

Check if unit value is compatible

Specified by:

isCompatible in interface GUnit

Parameters:

unit - to check if it is compatible.

Returns:

true if the unit is compatible, false otherwise.

getName

public String getName()

Get the unit name.

Specified by:

getName in interface GUnit

Returns:

the string representing the unit name.

convertToUnit

public BigDecimal convertToUnit(BigDecimal value,
                                GUnit destUnit)
                         throws GException

Description copied from interface: GUnit

Converts the units of value to unit. The conversion is done passing converting to and from the memory unit.

Specified by:

convertToUnit in interface GUnit

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToUnit

public double convertToUnit(double value,
                            GUnit destUnit)
                     throws GException

Description copied from interface: GUnit

Converts the units of value to unit. The conversion is done passing converting to and from the memory unit.

Specified by:

convertToUnit in interface GUnit

Parameters:

value - to convert.

destUnit - the destination unit.

Returns:

the converted value.

Throws:

GException - in case of an error performing the conversion.

convertToMemory

public BigDecimal convertToMemory(BigDecimal value)

Description copied from interface: GUnit

Converts the value to the memory unit. Convert the present value of unit to unit used in the configuration file.

Specified by:

convertToMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertToMemory

public double convertToMemory(double value)

Description copied from interface: GUnit

Converts the value to the memory unit. Convert the present value of unit to unit used in the configuration file.

Specified by:

convertToMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

public BigDecimal convertFromMemory(BigDecimal value)

Description copied from interface: GUnit

Converts the value from the memory unit. Convert the value of unit used in the configuration file to unit selected at present.

Specified by:

convertFromMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

convertFromMemory

public double convertFromMemory(double value)

Description copied from interface: GUnit

Converts the value from the memory unit. Convert the value of unit used in the configuration file to unit selected at present.

Specified by:

convertFromMemory in interface GUnit

Parameters:

value - to convert.

Returns:

the converted value.

getCompactedName

public String getCompactedName()

Description copied from interface: GUnit

Returns the name of the unit decomposed in basicUnits, without multipliers and sorted. Used to verify the compatibility between units.

Specified by:

getCompactedName in interface GUnit

Returns:

the name of the unit decomposed in basicUnits, without multipliers and sorted.