OpenAPI 1.0

com.aquafold.openapi.type
Interface AQIntegerFactory


public interface AQIntegerFactory

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

An instance of this interface is available via aqua.type.integer alias.


Method Summary
 boolean isEqual(Object a, Object b)
          Checks if two values are equal.
 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 Integer (using default platform locale).
 Integer parse(Object value)
          Creates a Integer instance assuming default platform locale.
 Integer parse(String value, String pattern)
          Creates a Integer instance using a specified pattern and locale.
 Integer parse(String value, String pattern, String locale)
          Interprets a specified value as a Integer using a specified pattern and locale.
 

Method Detail

parse

Integer parse(Object value)
Creates a Integer 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 Integer object, otherwise it throws an exception.

Parameters:
value - The value to be converted.
Returns:
An integer object.
Throws:
Exception - If the parameter is invalid.

parse

Integer parse(String value,
              String pattern)
Creates a Integer instance using a specified pattern and locale.

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

Parameters:
value - The value to be converted.
pattern - The pattern used to validate the value against or null to use the default for the Locale. Please see DecimalFormatSymbols
Returns:
An integer object.
Throws:
Exception - If the parameter is invalid.

parse

Integer parse(String value,
              String pattern,
              String locale)
Interprets a specified value as a Integer using a specified pattern and locale.

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

Parameters:
value - The value to be converted.
pattern - The pattern used to validate the value against or null to use the default for the Locale. Please see DecimalFormatSymbols
locale - The locale to use for the format, system default if null. Please see Locale.
Returns:
An integer object.
Throws:
Exception - If the parameter is invalid.

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.
Returns:
true if value is within the range specified, inclusive of the min and max parameters.
Throws:
Exception - If any of the parameters cannot be converted to an integer.

isLess

boolean isLess(Object a,
               Object b)
Checks if the value is less than a specified threshold.

Parameters:
a - The integer value to compare to.
b - The integer 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 an integer.

isLessOrEqual

boolean isLessOrEqual(Object a,
                      Object b)
Checks if the value is less than or equals to a specified threshold.

Parameters:
a - The integer value to compare to.
b - The integer 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 an integer.

isGreater

boolean isGreater(Object a,
                  Object b)
Checks if the value is greater than a specified threshold.

Parameters:
a - The integer value to compare to.
b - The integer 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 an integer.

isGreaterOrEqual

boolean isGreaterOrEqual(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 greater or equal to the value of the parameter b.
Throws:
Exception - If any of the parameters cannot be converted to an integer.

isEqual

boolean isEqual(Object a,
                Object b)
Checks if two values are equal.

Parameters:
a - The first integer value.
b - The second integer value.
Returns:
True if the 2 values are equal.
Throws:
Exception - If any of the parameters cannot be converted to an Integer.

isValid

boolean isValid(String value)
Interprets a specified value as a Integer (using default platform locale).

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

Parameters:
value -

OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.