| java.lang.Object
 org.joda.time.field.FieldUtils
| FieldUtils | | public class FieldUtils (Code) | | General utilities that don't fit elsewhere.
FieldUtils is thread-safe and immutable.
author:
Stephen Colebourne
since:
1.0 |
| Method Summary | |
| public static boolean | equals(Object object1, Object object2)
Compares two objects as equals handling null. | | public static int | getWrappedValue(int currentValue, int wrapValue, int minValue, int maxValue)
Utility method used by addWrapField implementations to ensure the new
value lies within the field's legal value range.
Parameters:
currentValue - the current value of the data, which may lie outsidethe wrapped value range
Parameters:
wrapValue - the value to add to current value beforewrapping. | | public static int | getWrappedValue(int value, int minValue, int maxValue)
Utility method that ensures the given value lies within the field's
legal value range.
Parameters:
value - the value to fit into the wrapped value range
Parameters:
minValue - the wrap range minimum value.
Parameters:
maxValue - the wrap range maximum value. | | public static int | safeAdd(int val1, int val2)
Add two values throwing an exception if overflow occurs. | | public static long | safeAdd(long val1, long val2)
Add two values throwing an exception if overflow occurs. | | public static int | safeMultiply(int val1, int val2)
Multiply two values throwing an exception if overflow occurs. | | public static long | safeMultiply(long val1, int scalar)
Multiply two values throwing an exception if overflow occurs. | | public static long | safeMultiply(long val1, long val2)
Multiply two values throwing an exception if overflow occurs. | | public static int | safeMultiplyToInt(long val1, long val2)
Multiply two values to return an int throwing an exception if overflow occurs. | | public static int | safeNegate(int value)
Negates the input throwing an exception if it can't negate it. | | public static long | safeSubtract(long val1, long val2)
Subtracts two values throwing an exception if overflow occurs. | | public static int | safeToInt(long value)
Casts to an int throwing an exception if overflow occurs. | | public static void | verifyValueBounds(DateTimeField field, int value, int lowerBound, int upperBound)
Verify that input values are within specified bounds. | | public static void | verifyValueBounds(DateTimeFieldType fieldType, int value, int lowerBound, int upperBound)
Verify that input values are within specified bounds. | | public static void | verifyValueBounds(String fieldName, int value, int lowerBound, int upperBound)
Verify that input values are within specified bounds. |
| equals | | public static boolean equals(Object object1, Object object2)(Code) | | Compares two objects as equals handling null.
Parameters:
object1 - the first object
Parameters:
object2 - the second object true if equal
since:
1.4 |
| getWrappedValue | | public static int getWrappedValue(int currentValue, int wrapValue, int minValue, int maxValue)(Code) | | Utility method used by addWrapField implementations to ensure the new
value lies within the field's legal value range.
Parameters:
currentValue - the current value of the data, which may lie outsidethe wrapped value range
Parameters:
wrapValue - the value to add to current value beforewrapping. This may be negative.
Parameters:
minValue - the wrap range minimum value.
Parameters:
maxValue - the wrap range maximum value. This must begreater than minValue (checked by the method). the wrapped value
throws:
IllegalArgumentException - if minValue is greaterthan or equal to maxValue |
| getWrappedValue | | public static int getWrappedValue(int value, int minValue, int maxValue)(Code) | | Utility method that ensures the given value lies within the field's
legal value range.
Parameters:
value - the value to fit into the wrapped value range
Parameters:
minValue - the wrap range minimum value.
Parameters:
maxValue - the wrap range maximum value. This must begreater than minValue (checked by the method). the wrapped value
throws:
IllegalArgumentException - if minValue is greaterthan or equal to maxValue |
| safeAdd | | public static int safeAdd(int val1, int val2)(Code) | | Add two values throwing an exception if overflow occurs.
Parameters:
val1 - the first value
Parameters:
val2 - the second value the new total
throws:
ArithmeticException - if the value is too big or too small |
| safeAdd | | public static long safeAdd(long val1, long val2)(Code) | | Add two values throwing an exception if overflow occurs.
Parameters:
val1 - the first value
Parameters:
val2 - the second value the new total
throws:
ArithmeticException - if the value is too big or too small |
| safeMultiply | | public static int safeMultiply(int val1, int val2)(Code) | | Multiply two values throwing an exception if overflow occurs.
Parameters:
val1 - the first value
Parameters:
val2 - the second value the new total
throws:
ArithmeticException - if the value is too big or too small
since:
1.2 |
| safeMultiply | | public static long safeMultiply(long val1, int scalar)(Code) | | Multiply two values throwing an exception if overflow occurs.
Parameters:
val1 - the first value
Parameters:
scalar - the second value the new total
throws:
ArithmeticException - if the value is too big or too small
since:
1.2 |
| safeMultiply | | public static long safeMultiply(long val1, long val2)(Code) | | Multiply two values throwing an exception if overflow occurs.
Parameters:
val1 - the first value
Parameters:
val2 - the second value the new total
throws:
ArithmeticException - if the value is too big or too small |
| safeMultiplyToInt | | public static int safeMultiplyToInt(long val1, long val2)(Code) | | Multiply two values to return an int throwing an exception if overflow occurs.
Parameters:
val1 - the first value
Parameters:
val2 - the second value the new total
throws:
ArithmeticException - if the value is too big or too small |
| safeNegate | | public static int safeNegate(int value)(Code) | | Negates the input throwing an exception if it can't negate it.
Parameters:
value - the value to negate the negated value
throws:
ArithmeticException - if the value is Integer.MIN_VALUE
since:
1.1 |
| safeSubtract | | public static long safeSubtract(long val1, long val2)(Code) | | Subtracts two values throwing an exception if overflow occurs.
Parameters:
val1 - the first value, to be taken away from
Parameters:
val2 - the second value, the amount to take away the new total
throws:
ArithmeticException - if the value is too big or too small |
| safeToInt | | public static int safeToInt(long value)(Code) | | Casts to an int throwing an exception if overflow occurs.
Parameters:
value - the value the value as an int
throws:
ArithmeticException - if the value is too big or too small |
| verifyValueBounds | | public static void verifyValueBounds(DateTimeField field, int value, int lowerBound, int upperBound)(Code) | | Verify that input values are within specified bounds.
Parameters:
value - the value to check
Parameters:
lowerBound - the lower bound allowed for value
Parameters:
upperBound - the upper bound allowed for value
throws:
IllegalFieldValueException - if value is not in the specified bounds |
| verifyValueBounds | | public static void verifyValueBounds(DateTimeFieldType fieldType, int value, int lowerBound, int upperBound)(Code) | | Verify that input values are within specified bounds.
Parameters:
value - the value to check
Parameters:
lowerBound - the lower bound allowed for value
Parameters:
upperBound - the upper bound allowed for value
throws:
IllegalFieldValueException - if value is not in the specified bounds
since:
1.1 |
| verifyValueBounds | | public static void verifyValueBounds(String fieldName, int value, int lowerBound, int upperBound)(Code) | | Verify that input values are within specified bounds.
Parameters:
value - the value to check
Parameters:
lowerBound - the lower bound allowed for value
Parameters:
upperBound - the upper bound allowed for value
throws:
IllegalFieldValueException - if value is not in the specified bounds |
|
|