Units of Measurement Reference Implementation 2.2.2 · tech.units.indriya.unit.UnitDimension

Field Summary

Modifier and Type	Field and Description
public static final Dimension	AMOUNT_OF_SUBSTANCE Holds amount of substance dimension (N).
public static final Dimension	ELECTRIC_CURRENT Holds electric current dimension (I).
public static final Dimension	LENGTH Holds length dimension (L).
private static final java.util.logging.Logger	LOGGER
public static final Dimension	LUMINOUS_INTENSITY Holds luminous intensity dimension (J).
public static final Dimension	MASS Holds mass dimension (M).
public static final Dimension	NONE Holds dimensionless.
private final Unit<?>	pseudoUnit Holds the pseudo unit associated to this dimension.
private static final long	serialVersionUID
public static final Dimension	TEMPERATURE Holds temperature dimension (Θ).
public static final Dimension	TIME Holds time dimension (T).

Constructor Summary

Access	Constructor and Description
private	UnitDimension(char the associated symbol. symbol) Returns the unit dimension having the specified symbol.
private	UnitDimension(Unit<?> the pseudo-unit. pseudoUnit) Constructor from pseudo-unit (not visible).
protected	UnitDimension() Default Constructor (not visible).

Method Summary

Modifier and Type	Method and Description
public Dimension	Returns: `this / that` divide(Dimension the dimension divisor. that) Implements javax.measure.Dimension.divide. Returns the quotient of this dimension with the one specified.
private UnitDimension	Returns: `this / that` divide(UnitDimension the dimension divisor. that) Returns the quotient of this dimension with the one specified.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Map<? extends Dimension, Integer>	Returns: the mapping between the base dimensions and their exponent. getBaseDimensions() Implements javax.measure.Dimension.getBaseDimensions. Returns the fundamental (base) dimensions and their exponent whose product is this dimension or `null` if this dimension is a fundamental dimension.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Dimension	Returns: `this * that` multiply(Dimension the dimension multiplicand. that) Implements javax.measure.Dimension.multiply. Returns the product of this dimension with the one specified.
private UnitDimension	Returns: `this * that` multiply(UnitDimension the dimension multiplicand. that) Returns the product of this dimension with the one specified.
public static <Q extends Quantity<Q>> Dimension	Returns: the dimension for the quantity type or `null`. of(Class<Q> the quantity type. quantityType) Returns the dimension for the specified quantity type by aggregating the results from the default `SystemOfUnits` or `null` if the specified quantity is unknown.
public static Dimension	Returns: the dimension for the given symbol. parse(char symbol) Returns the dimension for the specified symbol.
public UnitDimension	Returns: the result of raising this dimension to the exponent. pow(int the exponent. n) Implements javax.measure.Dimension.pow. Returns this dimension raised to an exponent.
public UnitDimension	Returns: the result of taking the given root of this dimension. root(int the root's order. n) Implements javax.measure.Dimension.root. Returns the given root of this dimension.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

AMOUNT_OF_SUBSTANCE	back to summary
public static final Dimension AMOUNT_OF_SUBSTANCE Holds amount of substance dimension (N). Since 1.0

AMOUNT_OF_SUBSTANCE

back to summary

public static final Dimension AMOUNT_OF_SUBSTANCE

Holds amount of substance dimension (N).

Since: 1.0

ELECTRIC_CURRENT	back to summary
public static final Dimension ELECTRIC_CURRENT Holds electric current dimension (I). Since 1.0

ELECTRIC_CURRENT

back to summary

public static final Dimension ELECTRIC_CURRENT

Holds electric current dimension (I).

Since: 1.0

LENGTH	back to summary
public static final Dimension LENGTH Holds length dimension (L). Since 1.0

LENGTH

back to summary

public static final Dimension LENGTH

Holds length dimension (L).

Since: 1.0

LOGGER	back to summary
private static final java.util.logging.Logger LOGGER

LUMINOUS_INTENSITY	back to summary
public static final Dimension LUMINOUS_INTENSITY Holds luminous intensity dimension (J).

MASS	back to summary
public static final Dimension MASS Holds mass dimension (M). Since 1.0

MASS

back to summary

public static final Dimension MASS

Holds mass dimension (M).

Since: 1.0

NONE	back to summary
public static final Dimension NONE Holds dimensionless. Since 1.0

NONE

back to summary

public static final Dimension NONE

Holds dimensionless.

Since: 1.0

pseudoUnit	back to summary
private final Unit<?> pseudoUnit Holds the pseudo unit associated to this dimension.

serialVersionUID	back to summary
private static final long serialVersionUID

TEMPERATURE	back to summary
public static final Dimension TEMPERATURE Holds temperature dimension (Θ). Since 1.0

TEMPERATURE

back to summary

public static final Dimension TEMPERATURE

Holds temperature dimension (Θ).

Since: 1.0

TIME	back to summary
public static final Dimension TIME Holds time dimension (T). Since 1.0

TIME

back to summary

public static final Dimension TIME

Holds time dimension (T).

Since: 1.0

Constructor Detail

UnitDimension	back to summary
private UnitDimension(char symbol) Returns the unit dimension having the specified symbol. Parameters symbol:char the associated symbol. Annotations @SuppressWarnings:rawtypes

UnitDimension

back to summary

private UnitDimension(char symbol)

Returns the unit dimension having the specified symbol.

Parameters

symbol:char: the associated symbol.

Annotations

@SuppressWarnings:rawtypes

UnitDimension	back to summary
private UnitDimension(Unit<?> pseudoUnit) Constructor from pseudo-unit (not visible). Parameters pseudoUnit:Unit<?> the pseudo-unit.

UnitDimension

back to summary

private UnitDimension(Unit<?> pseudoUnit)

Constructor from pseudo-unit (not visible).

Parameters

pseudoUnit:Unit<?>: the pseudo-unit.

UnitDimension	back to summary
protected UnitDimension() Default Constructor (not visible).

Method Detail

divide back to summary

divide	back to summary
public Dimension divide(Dimension that) Implements javax.measure.Dimension.divide. Returns the quotient of this dimension with the one specified. If the specified dimension is not a `UnitDimension`, then `that.divide(this).pow(-1)` is returned. Parameters that:Dimension the dimension divisor. Returns:Dimension `this / that` Since 1.0

public Dimension divide(Dimension that)

Implements javax.measure.Dimension.divide.

Returns the quotient of this dimension with the one specified. If the specified dimension is not a UnitDimension, then that.divide(this).pow(-1) is returned.

Parameters

that:Dimension: the dimension divisor.

Returns:Dimension

this / that

Since

1.0

divide back to summary

divide	back to summary
private UnitDimension divide(UnitDimension that) Returns the quotient of this dimension with the one specified. Parameters that:UnitDimension the dimension divisor. Returns:UnitDimension `this / that` Since 1.0

private UnitDimension divide(UnitDimension that)

Returns the quotient of this dimension with the one specified.

Parameters

that:UnitDimension: the dimension divisor.

Returns:UnitDimension

this / that

Since

1.0

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getBaseDimensions back to summary

getBaseDimensions	back to summary
public Map<? extends Dimension, Integer> getBaseDimensions() Implements javax.measure.Dimension.getBaseDimensions. Returns the fundamental (base) dimensions and their exponent whose product is this dimension or `null` if this dimension is a fundamental dimension. Returns:Map<? extends Dimension, Integer> the mapping between the base dimensions and their exponent. Annotations @SuppressWarnings:rawtypes Since 1.0

public Map<? extends Dimension, Integer> getBaseDimensions()

Implements javax.measure.Dimension.getBaseDimensions.

Returns the fundamental (base) dimensions and their exponent whose product is this dimension or null if this dimension is a fundamental dimension.

Returns:Map<? extends Dimension, Integer>

the mapping between the base dimensions and their exponent.

Annotations

@SuppressWarnings:rawtypes

Since

1.0

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

multiply back to summary

multiply	back to summary
public Dimension multiply(Dimension that) Implements javax.measure.Dimension.multiply. Returns the product of this dimension with the one specified. If the specified dimension is not a `UnitDimension`, then `that.multiply(this)` is returned. Parameters that:Dimension the dimension multiplicand. Returns:Dimension `this * that` Since 1.0

public Dimension multiply(Dimension that)

Implements javax.measure.Dimension.multiply.

Returns the product of this dimension with the one specified. If the specified dimension is not a UnitDimension, then that.multiply(this) is returned.

Parameters

that:Dimension: the dimension multiplicand.

Returns:Dimension

this * that

Since

1.0

multiply back to summary

multiply	back to summary
private UnitDimension multiply(UnitDimension that) Returns the product of this dimension with the one specified. Parameters that:UnitDimension the dimension multiplicand. Returns:UnitDimension `this * that` Since 1.0

private UnitDimension multiply(UnitDimension that)

Returns the product of this dimension with the one specified.

Parameters

that:UnitDimension: the dimension multiplicand.

Returns:UnitDimension

this * that

Since

1.0

of back to summary

of	back to summary
public static <Q extends Quantity<Q>> Dimension of(Class<Q> quantityType) Returns the dimension for the specified quantity type by aggregating the results from the default `SystemOfUnits` or `null` if the specified quantity is unknown. Parameters quantityType:Class<Q> the quantity type. Returns:Dimension the dimension for the quantity type or `null`. Since 1.1

public static <Q extends Quantity<Q>> Dimension of(Class<Q> quantityType)

Returns the dimension for the specified quantity type by aggregating the results from the default SystemOfUnits or null if the specified quantity is unknown.

Parameters

quantityType:Class<Q>: the quantity type.

Returns:Dimension

the dimension for the quantity type or null.

Since

1.1

parse	back to summary
public static Dimension parse(char symbol) Returns the dimension for the specified symbol. Returns:Dimension the dimension for the given symbol. Since 1.0.1

parse

back to summary

public static Dimension parse(char symbol)

Returns the dimension for the specified symbol.

Returns:Dimension: the dimension for the given symbol.
Since: 1.0.1

pow	back to summary
public UnitDimension pow(int n) Implements javax.measure.Dimension.pow. Returns this dimension raised to an exponent. Parameters n:int the exponent. Returns:UnitDimension the result of raising this dimension to the exponent. Since 1.0

pow

back to summary

public UnitDimension pow(int n)

Implements javax.measure.Dimension.pow.

Returns this dimension raised to an exponent.

Parameters

n:int: the exponent.

Returns:UnitDimension

the result of raising this dimension to the exponent.

Since

1.0

root back to summary

root	back to summary
public UnitDimension root(int n) Implements javax.measure.Dimension.root. Returns the given root of this dimension. Parameters n:int the root's order. Returns:UnitDimension the result of taking the given root of this dimension. Exceptions ArithmeticException: if `n == 0`. Since 1.0

public UnitDimension root(int n)

Implements javax.measure.Dimension.root.

Returns the given root of this dimension.

Parameters

n:int: the root's order.

Returns:UnitDimension

the result of taking the given root of this dimension.

Exceptions

ArithmeticException:: if n == 0.

Since

1.0

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class UnitDimension

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail