Package org.daisy.dotify.api.paper

Class Length

java.lang.Object

org.daisy.dotify.api.paper.Length

All Implemented Interfaces:

Serializable

public class Length
extends Object
implements Serializable

Provides a length measurement that can be expressed using the preferred units of length.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Length.UnitsOfLength	Defines possible units to be used when expressing a length value.

Field Summary

Fields

Modifier and Type	Field	Description
static double	INCH_IN_MM	1 inch is 25.4 mm.

Method Summary

Modifier and Type	Method	Description
double	asInches()	Gets the value of this length, expressed in inch units.
double	asMillimeter()	Gets the value of this length, expressed in millimeter units.
boolean	equals(Object object)
double	getLength()	Gets the length, expressed in the original units of length.
Length.UnitsOfLength	getUnitsOfLength()	Gets the original units of length.
int	hashCode()
static Length	newCentimeterValue(double value)	Creates a new Length object with the specified value, expressed in centimeter units.
static Length	newInchValue(double value)	Creates a new Length object with the specified value, expressed in inch units.
static Length	newMillimeterValue(double value)	Creates a new Length object with the specified value, expressed in millimeter units.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INCH_IN_MM

public static final double INCH_IN_MM

1 inch is 25.4 mm.

See Also:

Constant Field Values

Method Detail

getLength

public double getLength()

Gets the length, expressed in the original units of length.

Returns:

returns the length

getUnitsOfLength

public Length.UnitsOfLength getUnitsOfLength()

Gets the original units of length.

Returns:

returns the original units of length

asMillimeter

public double asMillimeter()

Gets the value of this length, expressed in millimeter units.

Returns:

returns the value

asInches

public double asInches()

Gets the value of this length, expressed in inch units.

Returns:

returns the value

newMillimeterValue

public static Length newMillimeterValue(double value)

Creates a new Length object with the specified value, expressed in millimeter units.

Parameters:

value - the length in millimeters

Returns:

returns a new Length object

newCentimeterValue

public static Length newCentimeterValue(double value)

Creates a new Length object with the specified value, expressed in centimeter units.

Parameters:

value - the length in centimeter

Returns:

returns a new Length object

newInchValue

public static Length newInchValue(double value)

Creates a new Length object with the specified value, expressed in inch units.

Parameters:

value - the length in inches

Returns:

returns a new Length object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object