Class AbsoluteOrRelativeInt

java.lang.Object

ch.nolix.system.element.base.AbstractElement

ch.nolix.system.element.relativevalue.AbsoluteOrRelativeInt

All Implemented Interfaces:

IElement, IAbsoluteOrRelativeInt

public final class AbsoluteOrRelativeInt
extends AbstractElement
implements IAbsoluteOrRelativeInt

A AbsoluteOrRelativeInt stores either an integer or a percentage. A AbsoluteOrRelativeInt is not mutable.

Author:

Silvan Wyss

Method Summary

Modifier and Type	Method	Description
static AbsoluteOrRelativeInt	fromSpecification(INode<?> specification)
int	getAbsoluteValue()
IContainer<INode<?>>	getAttributes()
double	getPercentage()
int	getValueRelativeToHundredPercentValue(int hundredPercentValue)
boolean	isAbsolute()
boolean	isPositive()
boolean	isRelative()
static AbsoluteOrRelativeInt	withIntValue(int intValue)
static AbsoluteOrRelativeInt	withPercentage(double percentage)

Methods inherited from class AbstractElement

equals, getSpecification, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface IElement

getSpecification, toFormatedString, toXml

Method Details

fromSpecification

public static AbsoluteOrRelativeInt fromSpecification(INode<?> specification)

Parameters:

specification -

Returns:

a new AbsoluteOrRelativeInt from the given specification.

Throws:

RuntimeException - if the given specification is not valid.

withIntValue

public static AbsoluteOrRelativeInt withIntValue(int intValue)

Parameters:

intValue -

Returns:

a new AbsoluteOrRelativeInt with the given intValue.

withPercentage

public static AbsoluteOrRelativeInt withPercentage(double percentage)

Parameters:

percentage -

Returns:

a new AbsoluteOrRelativeInt with the given percentage.

Throws:

RuntimeException - if the given percentage is negative.

getAttributes

public IContainer<INode<?>> getAttributes()

Specified by:

getAttributes in interface IElement

Returns:

the attributes of the current IElement.

getAbsoluteValue

public int getAbsoluteValue()

Specified by:

getAbsoluteValue in interface IAbsoluteOrRelativeInt

Returns:

the absolute value of the current IAbsoluteOrRelativeInt.

getPercentage

public double getPercentage()

Specified by:

getPercentage in interface IAbsoluteOrRelativeInt

Returns:

the percentage of the current IAbsoluteOrRelativeInt.

getValueRelativeToHundredPercentValue

public int getValueRelativeToHundredPercentValue(int hundredPercentValue)

Specified by:

getValueRelativeToHundredPercentValue in interface IAbsoluteOrRelativeInt

Parameters:

hundredPercentValue -

Returns:

the value of the current IAbsoluteOrRelativeInt relative to the given hundredPercentValue.

isAbsolute

public boolean isAbsolute()

Specified by:

isAbsolute in interface IAbsoluteOrRelativeInt

Returns:

true if the current IAbsoluteOrRelativeInt is absolute, false otherwise.

isPositive

public boolean isPositive()

Specified by:

isPositive in interface IAbsoluteOrRelativeInt

Returns:

true if the current IAbsoluteOrRelativeInt is positive, false otherwise.

isRelative

public boolean isRelative()

Specified by:

isRelative in interface IAbsoluteOrRelativeInt

Returns:

true if the current IAbsoluteOrRelativeInt is relative, false otherwise.