javax.measure.unit

Class Dimension

java.lang.Object

javax.measure.unit.Dimension

All Implemented Interfaces:

java.io.Serializable

public final class Dimension
extends java.lang.Object
implements java.io.Serializable

This class represents the dimension of an unit. Two units u1 and u2 are compatible if and only if (u1.getDimension().equals(u2.getDimension())))

Instances of this class are immutable.

Version:

3.1, April 22, 2006

Author:

Jean-Marie Dautelle

See Also:

Wikipedia: Dimensional Analysis, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Dimension.Model This interface represents the mapping between base units and dimensions.

Field Summary

Fields

Modifier and Type	Field and Description
static Dimension	AMOUNT_OF_SUBSTANCE Holds amount of substance dimension (N).
static Dimension	ELECTRIC_CURRENT Holds electric current dimension (I).
static Dimension	LENGTH Holds length dimension (L).
static Dimension	MASS Holds mass dimension (M).
static Dimension	NONE Holds dimensionless.
static Dimension	TEMPERATURE Holds temperature dimension (θ).
static Dimension	TIME Holds time dimension (T).

Constructor Summary

Constructors

Constructor and Description
Dimension(char symbol) Creates a new dimension associated to the specified symbol.

Method Summary

Modifier and Type	Method and Description
Dimension	divide(Dimension that) Returns the quotient of this dimension with the one specified.
boolean	equals(java.lang.Object that) Indicates if the specified dimension is equals to the one specified.
static Dimension.Model	getModel() Returns the model used to determinate the units dimensions (default STANDARD).
int	hashCode() Returns the hash code for this dimension.
Dimension	pow(int n) Returns this dimension raised to an exponent.
Dimension	root(int n) Returns the given root of this dimension.
static void	setModel(Dimension.Model model) Sets the model used to determinate the units dimensions.
Dimension	times(Dimension that) Returns the product of this dimension with the one specified.
java.lang.String	toString() Returns the representation of this dimension.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final Dimension NONE

Holds dimensionless.

LENGTH

public static final Dimension LENGTH

Holds length dimension (L).

MASS

public static final Dimension MASS

Holds mass dimension (M).

TIME

public static final Dimension TIME

Holds time dimension (T).

ELECTRIC_CURRENT

public static final Dimension ELECTRIC_CURRENT

Holds electric current dimension (I).

TEMPERATURE

public static final Dimension TEMPERATURE

Holds temperature dimension (θ).

AMOUNT_OF_SUBSTANCE

public static final Dimension AMOUNT_OF_SUBSTANCE

Holds amount of substance dimension (N).

Constructor Detail

Dimension

public Dimension(char symbol)

Creates a new dimension associated to the specified symbol.

Parameters:

symbol - the associated symbol.

Method Detail

times

public final Dimension times(Dimension that)

Returns the product of this dimension with the one specified.

Parameters:

that - the dimension multiplicand.

Returns:

this * that

divide

public final Dimension divide(Dimension that)

Returns the quotient of this dimension with the one specified.

Parameters:

that - the dimension divisor.

Returns:

this / that

pow

public final Dimension pow(int n)

Returns this dimension raised to an exponent.

Parameters:

n - the exponent.

Returns:

the result of raising this dimension to the exponent.

root

public final Dimension root(int n)

Returns the given root of this dimension.

Parameters:

n - the root's order.

Returns:

the result of taking the given root of this dimension.

Throws:

java.lang.ArithmeticException - if n == 0.

toString

public java.lang.String toString()

Returns the representation of this dimension.

Overrides:

toString in class java.lang.Object

Returns:

the representation of this dimension.

equals

public boolean equals(java.lang.Object that)

Indicates if the specified dimension is equals to the one specified.

Overrides:

equals in class java.lang.Object

Parameters:

that - the object to compare to.

Returns:

true if this dimension is equals to that dimension; false otherwise.

hashCode

public int hashCode()

Returns the hash code for this dimension.

Overrides:

hashCode in class java.lang.Object

Returns:

this dimension hashcode value.

setModel

public static void setModel(Dimension.Model model)

Sets the model used to determinate the units dimensions.

Parameters:

model - the new model to be used when calculating unit dimensions.

getModel

public static Dimension.Model getModel()

Returns the model used to determinate the units dimensions (default STANDARD).

Returns:

the model used when calculating unit dimensions.