com.rubecula.jquantity
Class SystemFlag

java.lang.Object
  |
  +--com.rubecula.jquantity.SystemFlag

public class SystemFlag

extends java.lang.Object

The immutable class SystemFlag represents a system of units.

Note that there are no non-private constructors. The values provided are fixed and immutable.

Version:

$Revision: 1.1 $

Author:

Robin Hillyard

Field Summary

(package private) static SystemFlag	$Any
static int	$IndexAny
static int	$IndexCGS
static int	$IndexCustom
static int	$IndexImp
static int	$IndexNone
static int	$IndexSI
static int	$IndexUS
(package private) static SystemFlag	$None
(package private) static SystemFlag	FlagCGS
(package private) static SystemFlag	FlagImp
(package private) static SystemFlag	FlagSI
static int	MaxIndex
(package private) static java.lang.String	SystemCGS
(package private) static java.lang.String	SystemEnglish
(package private) static java.lang.String	SystemImperial
(package private) static java.lang.String	SystemSI
(package private) static java.lang.String	SystemUD
(package private) static SystemFlag	UnitsSystem

Method Summary

(package private) SystemFlag	getCommon(SystemFlag other)
protected int	getFlag() Method to get the integer value of this flag.
(package private) int	getIndex()
static int	GetSysIndex()
static java.lang.String[]	GetSystemNames()
static java.lang.String	GetUnitSystemName()
(package private) boolean	isInSystem(int sysIndex)
(package private) boolean	match(SystemFlag other)
static void	setSysIndex(int system)
java.lang.String	toString()
static SystemFlag	valueOf(int sysIndex) Factory method to create a SystemFlag for system index defined by sysIndex

Methods inherited from class java.lang.Object

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

Field Detail

$IndexNone

public static final int $IndexNone

See Also:

Constant Field Values

$IndexAny

public static final int $IndexAny

See Also:

Constant Field Values

$IndexSI

public static final int $IndexSI

See Also:

Constant Field Values

$IndexImp

public static final int $IndexImp

See Also:

Constant Field Values

$IndexCGS

public static final int $IndexCGS

See Also:

Constant Field Values

$IndexUS

public static final int $IndexUS

See Also:

Constant Field Values

$IndexCustom

public static final int $IndexCustom

See Also:

Constant Field Values

MaxIndex

public static final int MaxIndex

See Also:

Constant Field Values

SystemSI

static final java.lang.String SystemSI

See Also:

Constant Field Values

SystemCGS

static final java.lang.String SystemCGS

See Also:

Constant Field Values

SystemImperial

static final java.lang.String SystemImperial

See Also:

Constant Field Values

SystemEnglish

static final java.lang.String SystemEnglish

See Also:

Constant Field Values

SystemUD

static final java.lang.String SystemUD

See Also:

Constant Field Values

FlagSI

static final SystemFlag FlagSI

FlagCGS

static final SystemFlag FlagCGS

FlagImp

static final SystemFlag FlagImp

$Any

static final SystemFlag $Any

$None

static final SystemFlag $None

UnitsSystem

static SystemFlag UnitsSystem

Method Detail

GetSystemNames

public static java.lang.String[] GetSystemNames()

GetUnitSystemName

public static java.lang.String GetUnitSystemName()

valueOf

public static SystemFlag valueOf(int sysIndex)

Factory method to create a SystemFlag for system index defined by sysIndex

Parameters:

sysIndex - a non-negative integer

Returns:

the new SystemFlag

setSysIndex

public static void setSysIndex(int system)

GetSysIndex

public static int GetSysIndex()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

match

final boolean match(SystemFlag other)

isInSystem

final boolean isInSystem(int sysIndex)

getCommon

final SystemFlag getCommon(SystemFlag other)

getIndex

final int getIndex()

getFlag

protected final int getFlag()

Method to get the integer value of this flag.

Returns:

the integer value of the system flag.