au.com.codeka.carrot

Class ValueHelper

java.lang.Object

au.com.codeka.carrot.ValueHelper

public class ValueHelper
extends java.lang.Object

Various helpers for working with Objects.

Constructor Summary

Constructors

Constructor and Description
ValueHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.Number	add(java.lang.Object lhs, java.lang.Object rhs) Adds the two values together.
static java.lang.Number	divide(java.lang.Object lhs, java.lang.Object rhs) Divides the left hand side by the right hand side, and returns the result.
static boolean	isTrue(java.lang.Object value) Does the given value represent "true".
static java.util.List<java.lang.Object>	iterate(java.lang.Object iterable) Convert the given value to a list of object, as if it were an iterable.
static java.lang.Number	multiply(java.lang.Object lhs, java.lang.Object rhs) Multiplies the left hand side by the right hand side, and returns the result.
static java.lang.Number	negate(java.lang.Object value) Returns the "negative" of the given value.
static java.lang.Number	toNumber(java.lang.Object value) Converts the given value to a Number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValueHelper

public ValueHelper()

Method Detail

isTrue

public static boolean isTrue(java.lang.Object value)
                      throws CarrotException

Does the given value represent "true". For example, it's a Boolean that's true, a non-zero integer, etc.

Parameters:

value - The value to test.

Returns:

True if the value is "true-ish", false otherwise.

Throws:

CarrotException - When the value cannot be determined to be true or false.

negate

public static java.lang.Number negate(java.lang.Object value)
                               throws CarrotException

Returns the "negative" of the given value. For example, if you pass in "1" then "-1" is returned, etc.

Parameters:

value - The value to negate.

Returns:

The negated value.

Throws:

CarrotException - Thrown if the value can't be converted to a number.

toNumber

public static java.lang.Number toNumber(java.lang.Object value)
                                 throws CarrotException

Converts the given value to a Number.

Parameters:

value - The value to convert.

Returns:

A Number that the value represents.

Throws:

CarrotException - Thrown if the value can't be converted to a number.

add

public static java.lang.Number add(java.lang.Object lhs,
                                   java.lang.Object rhs)
                            throws CarrotException

Adds the two values together. We attempt to make them the most-precise they can be (i.e. if one of them is a double then double is returned, if one of them is a long then long is returned, etc).

Parameters:

lhs - The left-hand side to add.

rhs - The right-hand side to add.

Returns:

The two numbers added together.

Throws:

CarrotException - Thrown is either of the values can't be converted to a number.

divide

public static java.lang.Number divide(java.lang.Object lhs,
                                      java.lang.Object rhs)
                               throws CarrotException

Divides the left hand side by the right hand side, and returns the result.

Parameters:

lhs - The left hand side of the division.

rhs - The right hand side of the division.

Returns:

The result of "lhs / rhs".

Throws:

CarrotException - Thrown is either of the values cannot be converted to a number.

multiply

public static java.lang.Number multiply(java.lang.Object lhs,
                                        java.lang.Object rhs)
                                 throws CarrotException

Multiplies the left hand side by the right hand side, and returns the result.

Parameters:

lhs - The left hand side of the multiplication.

rhs - The right hand side of the multiplication.

Returns:

The result of "lhs * rhs".

Throws:

CarrotException - Thrown is either of the values cannot be converted to a number.

iterate

public static java.util.List<java.lang.Object> iterate(java.lang.Object iterable)
                                                throws CarrotException

Convert the given value to a list of object, as if it were an iterable. If the value is itself an array or a list then it's just returned in-place. Otherwise it will be converted to an ArrayList.

Parameters:

iterable - The value to "iterate".

Returns:

A List that can actually be iterated.

Throws:

CarrotException - If the value is not iterable.