org.djunits.value

Class Scalar<U extends Unit<U>>

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

Type Parameters:

U - the unit of the values in the constructor and for display

All Implemented Interfaces:

Serializable, Value<U>

Direct Known Subclasses:

AbstractDoubleScalar, AbstractFloatScalar

public abstract class Scalar<U extends Unit<U>>
extends Number
implements Value<U>, Serializable

Basics of the Scalar type

This file was generated by the djunits value classes generator, 26 jun, 2015

Copyright (c) 2015-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See DJUNITS License.

$LastChangedDate: 2019-03-16 15:13:56 +0100 (Sat, 16 Mar 2019) $, @version $Revision: 361 $, by $Author: averbraeck $, initial version 26 jun, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	NUMBER_PATTERN Number pattern regex to be used in valueOf() method.

Constructor Summary

Constructors

Constructor and Description
Scalar(U unit) Construct a new Scalar.

Method Summary

Modifier and Type	Method and Description
double	expressAsSIUnit(double value) Convert a value to the standard SI unit.
protected double	expressAsSpecifiedUnit(double value) Convert a value from the standard SI unit into the unit of this Scalar.
U	getUnit() Retrieve the unit of this Value.
boolean	isAbsolute() Indicate whether this is an Absolute Value.
boolean	isRelative() Indicate whether this is a Relative Value.
void	setDisplayUnit(U newUnit) Set a new display unit for the value.
static <U extends Unit<U>> String	stringOf(Scalar<U> value) Returns a String representation of the scalar value that can be parsed back into its scalar type.
static <U extends Unit<U>> String	stringOfDefaultLocale(Scalar<U> value) Returns a String representation of the scalar value that can be parsed back into its scalar type.
static <U extends Unit<U>> String	textualStringOf(Scalar<U> value) Returns a String representation of the scalar value that can be parsed back into its scalar type.
static <U extends Unit<U>> String	textualStringOfDefaultLocale(Scalar<U> value) Returns a String representation of the scalar value that can be parsed back into its scalar type.

Methods inherited from class java.lang.Number

byteValue, doubleValue, floatValue, intValue, longValue, shortValue

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_PATTERN

protected static final Pattern NUMBER_PATTERN

Number pattern regex to be used in valueOf() method.

Constructor Detail

Scalar

public Scalar(U unit)

Construct a new Scalar.

Parameters:

unit - U; the unit of the new Scalar

Method Detail

getUnit

public final U getUnit()

Retrieve the unit of this Value.

Specified by:

getUnit in interface Value<U extends Unit<U>>

Returns:

U; the unit of this Value

expressAsSIUnit

public final double expressAsSIUnit(double value)

Convert a value to the standard SI unit.

Specified by:

expressAsSIUnit in interface Value<U extends Unit<U>>

Parameters:

value - double; the value to convert to the standard SI unit

Returns:

double; the value in the standard SI unit

expressAsSpecifiedUnit

protected final double expressAsSpecifiedUnit(double value)

Convert a value from the standard SI unit into the unit of this Scalar.

Parameters:

value - double; the value to convert

Returns:

double; the value in the unit of this Scalar

setDisplayUnit

public void setDisplayUnit(U newUnit)

Set a new display unit for the value. Internally, the value will stay stored in the default or SI unit.

Specified by:

setDisplayUnit in interface Value<U extends Unit<U>>

Parameters:

newUnit - U; the new display unit of this Value

isAbsolute

public final boolean isAbsolute()

Indicate whether this is an Absolute Value.

Specified by:

isAbsolute in interface Value<U extends Unit<U>>

Returns:

boolean

isRelative

public final boolean isRelative()

Indicate whether this is a Relative Value.

Specified by:

isRelative in interface Value<U extends Unit<U>>

Returns:

boolean

stringOf

public static <U extends Unit<U>> String stringOf(Scalar<U> value)

Returns a String representation of the scalar value that can be parsed back into its scalar type. The String representation is the double value in the unit, followed by the official abbreviation of the unit without spaces, in the current locale.

Type Parameters:

U - the unit type for the scalar

Parameters:

value - Scalar<U>; the value to parse into a String

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

stringOfDefaultLocale

public static <U extends Unit<U>> String stringOfDefaultLocale(Scalar<U> value)

Returns a String representation of the scalar value that can be parsed back into its scalar type. The String representation is the double value in the unit, followed by the official abbreviation of the unit without spaces, in the English locale.

Type Parameters:

U - the unit type for the scalar

Parameters:

value - Scalar<U>; the value to parse into a String

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

textualStringOf

public static <U extends Unit<U>> String textualStringOf(Scalar<U> value)

Returns a String representation of the scalar value that can be parsed back into its scalar type. The String representation is the double value in the unit, followed by the default textual abbreviation of the unit without spaces, in the current locale.

Type Parameters:

U - the unit type for the scalar

Parameters:

value - Scalar<U>; the value to parse into a String

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit

textualStringOfDefaultLocale

public static <U extends Unit<U>> String textualStringOfDefaultLocale(Scalar<U> value)

Returns a String representation of the scalar value that can be parsed back into its scalar type. The String representation is the double value in the unit, followed by the default textual abbreviation of the unit without spaces, in the English locale.

Type Parameters:

U - the unit type for the scalar

Parameters:

value - Scalar<U>; the value to parse into a String

Returns:

the String representation of the value in its unit, followed by the official abbreviation of the unit