Package org.faktorips.datatype.classtypes

Class MoneyDatatype

java.lang.Object

org.faktorips.datatype.AbstractDatatype

org.faktorips.datatype.ValueClassNameDatatype

org.faktorips.datatype.classtypes.MoneyDatatype

All Implemented Interfaces:

Comparable<Datatype>, Datatype, NumericDatatype, ValueDatatype

public class MoneyDatatype
extends ValueClassNameDatatype
implements NumericDatatype

Datatype for Money.

Author:

Jan Ortmann

Field Summary

Fields inherited from interface org.faktorips.datatype.Datatype

BIG_DECIMAL, BOOLEAN, DECIMAL, DOUBLE, GREGORIAN_CALENDAR, INTEGER, LONG, MONEY, PRIMITIVE_BOOLEAN, PRIMITIVE_INT, PRIMITIVE_LONG, STRING, VOID

Constructor Summary

Constructors

Constructor	Description
MoneyDatatype()

Method Summary

Modifier and Type	Method	Description
boolean	divisibleWithoutRemainder(String dividend, String divisor)	Decides whether the given dividend can be divided by the divisor without remainder or not.
org.faktorips.values.Money	getValue(String s)	This method parses the given string and returns the value as an instance of the class this value datatype represents.
boolean	hasDecimalPlaces()
boolean	hasNullObject()	Returns true if the datatype has a special instance representing null, otherwise false.
String	subtract(String minuend, String subtrahend)	Subtraction.
boolean	supportsCompare()

Methods inherited from class org.faktorips.datatype.ValueClassNameDatatype

areValuesEqual, compare, getDefaultValue, getName, getQualifiedName, getWrapperType, isAbstract, isImmutable, isMutable, isNull, isParsable, isPrimitive, isValueDatatype, valueToString

Methods inherited from class org.faktorips.datatype.AbstractDatatype

checkReadyToUse, compareTo, equals, hashCode, isEnum, isVoid, matchDatatype, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.faktorips.datatype.Datatype

getName, getQualifiedName, isAbstract, isEnum, isPrimitive, isValueDatatype, isVoid

Methods inherited from interface org.faktorips.datatype.ValueDatatype

areValuesEqual, checkReadyToUse, compare, getDefaultValue, getNullObjectId, getWrapperType, isImmutable, isMutable, isNull, isParsable, valueToString

Constructor Details

MoneyDatatype

public MoneyDatatype()

Method Details

getValue

public org.faktorips.values.Money getValue(String s)

Description copied from class: ValueClassNameDatatype

This method parses the given string and returns the value as an instance of the class this value datatype represents. Use with caution: During development time Faktor-IPS maintains all values with their string representation. This allows to change the value's datatype without the need to convert the value from one class to another (e.g. if the string representation is 42 you can change the datatype from integer to string without converting the integer object to a string object.

Specified by:

getValue in interface ValueDatatype

Specified by:

getValue in class ValueClassNameDatatype

Parameters:

s - string representation of the value

Returns:

The value as instance of the class this datatype represents.

See Also:

• ValueClassNameDatatype.valueToString(Object)

hasNullObject

public boolean hasNullObject()

Description copied from interface: Datatype

Returns true if the datatype has a special instance representing null, otherwise false. The design pattern is called the null-object pattern.

Specified by:

hasNullObject in interface Datatype

Overrides:

hasNullObject in class ValueClassNameDatatype

See Also:

• NullObject

supportsCompare

public boolean supportsCompare()

Specified by:

supportsCompare in interface ValueDatatype

Returns:

true if this datatype is able to compare two values.

subtract

public String subtract(String minuend,
 String subtrahend)

Description copied from interface: NumericDatatype

Subtraction. This method is used to validate numeric ranges, see RangeValueSet as an example.

Specified by:

subtract in interface NumericDatatype

Parameters:

minuend - The value to be reduced.

subtrahend - The value to be used to reduce the minuend

Returns:

The result of "minuend - subtrahend".

divisibleWithoutRemainder

public boolean divisibleWithoutRemainder(String dividend,
 String divisor)

Description copied from interface: NumericDatatype

Decides whether the given dividend can be divided by the divisor without remainder or not. This method is used to validate numeric ranges, see RangeValueSet as an example.

Specified by:

divisibleWithoutRemainder in interface NumericDatatype

Parameters:

dividend - The value to be divided

divisor - The value to be used to divide the dividend

Returns:

true if dividend can be divided by the divisor without remainder, false otherwise.

hasDecimalPlaces

public boolean hasDecimalPlaces()

Specified by:

hasDecimalPlaces in interface NumericDatatype