com.aquafold.openapi.type
Interface AQFloatFactory

public interface AQFloatFactory

This interface provides manipulation and validation functionality for Float data type.

An instance of this interface is available via aqua.type.getFloat(). (For technical reasons, aqua.type.float is not available).

Method Summary

boolean	isCloseTo(Object a, Object b, Object distance) Checks if two values are within the specified distance.
boolean	isGreater(Object a, Object b) Checks if the value is greater than a specified threshold.
boolean	isGreaterOrEqual(Object a, Object b) Checks if the value is less than or equals to a specified threshold.
boolean	isInRange(Object value, Object min, Object max) Checks if the value is within a specified range, inclusive.
boolean	isLess(Object a, Object b) Checks if the value is less than a specified threshold.
boolean	isLessOrEqual(Object a, Object b) Checks if the value is less than or equals to a specified threshold.
boolean	isValid(String value) Interprets a specified value as a Float (using default platform locale).
Float	parse(Object value) Creates a Float instance assuming default platform locale.
Float	parse(String value, String pattern) Creates a Float instance using a specified pattern and locale.
Float	parse(String value, String pattern, String locale) Interprets a specified value as a Float using a specified pattern and locale.

Method Detail

parse

Float parse(Object value)

Creates a Float instance assuming default platform locale. Depending on the type of its argument, this method tries to make the most precise conversion.

If conversion is successful, the method returns the resulting Float object, otherwise it throws an exception.

Parameters:

value -

parse

Float parse(String value,
            String pattern)

Creates a Float instance using a specified pattern and locale.

If conversion is successful, the method returns the resulting Float object, otherwise it throws an exception.

Parameters:

value -

pattern -

parse

Float parse(String value,
            String pattern,
            String locale)

Interprets a specified value as a Float using a specified pattern and locale.

If conversion is successful, the method returns the resulting Float object, otherwise it throws an exception.

Parameters:

value -

pattern -

locale -

isInRange

boolean isInRange(Object value,
                  Object min,
                  Object max)

Checks if the value is within a specified range, inclusive.

Parameters:

value - The value in question.

min - Start of the range.

max - End of the range. * @throws Exception If any of the parameters cannot be converted to a float.

Returns:

true if value is within the range specified, inclusive of the min and max parameters.

isLess

boolean isLess(Object a,
               Object b)

Checks if the value is less than a specified threshold.

Parameters:

a - The double value to compare to.

b - The double value to compare with.

Returns:

true if the value of the parameter a is less then the value of the parameter b.

Throws:

Exception - If any of the parameters cannot be converted to float.

isLessOrEqual

boolean isLessOrEqual(Object a,
                      Object b)

Checks if the value is less than or equals to a specified threshold.

Parameters:

a - The double value to compare to.

b - The double value to compare with.

Returns:

true if the value of the parameter a is less or equal to the value of the parameter b.

Throws:

Exception - If any of the parameters cannot be converted to float.

isGreater

boolean isGreater(Object a,
                  Object b)

Checks if the value is greater than a specified threshold.

Parameters:

a - The float value to compare to.

b - The float value to compare with.

Returns:

true if the value of the parameter a is greater then the value of the parameter b.

Throws:

Exception - If any of the parameters cannot be converted to float.

isGreaterOrEqual

boolean isGreaterOrEqual(Object a,
                         Object b)

Checks if the value is less than or equals to a specified threshold.

Parameters:

a - The float value to compare to.

b - The float value to compare with.

Returns:

true if the value of the parameter a is greater or equal to the value of the parameter b.

Throws:

Exception - If any of the parameters cannot be converted to float.

isCloseTo

boolean isCloseTo(Object a,
                  Object b,
                  Object distance)

Checks if two values are within the specified distance. Since Float is inexact, mathematical operations may produce small errors, which make exact comparison fail.

Parameters:

a - The 1st float value.

b - The 2nd float value.

distance - The distance, as specified by the user to compare the difference between a and b.

Returns:

true the comparison is successful.

Throws:

Exception - if any of the parameters cannot be converted to a float.

isValid

boolean isValid(String value)

Interprets a specified value as a Float (using default platform locale).

If conversion is successful, the method returns resulting Float object, otherwise it returns null.

Parameters:

value -