ariba.util.formatter
Class BooleanFormatter

java.lang.Object
  ariba.util.formatter.Formatter
      ariba.util.formatter.BooleanFormatter

All Implemented Interfaces:

Compare, StringParser

public class BooleanFormatter
extends Formatter

BooleanFormatter is a subclass of Formatter which is responsible for formatting, parsing, and comparing boolean values and/or Boolean objects.

Field Summary

static String	BooleanTrueOrFalseKey
static String	ClassName Our Java class name.

Fields inherited from interface ariba.util.core.Compare

EqualTo, GreaterThan, LessThan

Constructor Summary

BooleanFormatter()
Creates a new BooleanFormatter.

Method Summary

static int	compareBooleans(boolean b1, boolean b2) Compares two boolean values for sorting purposes.
static int	compareBooleans(Boolean b1, Boolean b2) Compares two Boolean objects for sorting purposes.
static boolean	getBooleanValue(Object object) Returns a boolean value derived from the given object.
static String	getStringValue(Boolean object) Returns a formatted string for the given Boolean object in the default locale.
static String	getStringValue(Boolean object, Locale locale) Returns a formatted string for the given Boolean object in the given locale.
Object	getValue(Object object, Locale locale) Returns a new Boolean derived from the given object.
static boolean	parseBoolean(String string) Parses the given string as a boolean value.
static Boolean	parseStringAsBoolean(String string) Parses the given string as a Boolean value.

Methods inherited from class ariba.util.formatter.Formatter

canFormatNulls, compare, compare, equal, equal, getFormat, getFormat, getFormatterClassForType, getFormatterForObject, getFormatterForType, getLocale, getStringValue, getStringValue, getValue, handlesNulls, isBidirectional, makeParseException, makeParseException, objectsAreEqual, objectsAreEqual, parse, parse, parseString, parseString, quickCompare, quickCompare, quickCompareValue, registerFormatter

Methods inherited from class java.lang.Object

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

Field Detail

ClassName

public static final String ClassName

Our Java class name.

See Also:

Constant Field Values

BooleanTrueOrFalseKey

public static final String BooleanTrueOrFalseKey

See Also:

Constant Field Values

Constructor Detail

BooleanFormatter

public BooleanFormatter()

Creates a new BooleanFormatter.

Method Detail

getStringValue

public static String getStringValue(Boolean object)

Returns a formatted string for the given Boolean object in the default locale.

Parameters:

object - the Boolean object to format into a string

Returns:

a formatted string for the given Boolean object in the default locale

getStringValue

public static String getStringValue(Boolean object,
                                    Locale locale)

Returns a formatted string for the given Boolean object in the given locale.

Parameters:

object - the Boolean object to format into a string

locale - the Locale to use for formatting

Returns:

a formatted string for the given Boolean object in the given locale

parseBoolean

public static boolean parseBoolean(String string)

Parses the given string as a boolean value. Returns true if and only if the given string is "true".

Parameters:

string - the String to parse

Returns:

true if the given string is "true"; false otherwise.

parseStringAsBoolean

public static Boolean parseStringAsBoolean(String string)

Parses the given string as a Boolean value. Returns Boolean.TRUE if and only if the given string is "true".

Parameters:

string - the String to parse

Returns:

Boolean.TRUE if the given string is "true"; Boolean.FALSE otherwise.

getBooleanValue

public static boolean getBooleanValue(Object object)

Returns a boolean value derived from the given object. If the object is not a Boolean, it is converted to a string and compared against the string "true".

Parameters:

object - the object to covert to a boolean

Returns:

a boolean derived from the given object

compareBooleans

public static int compareBooleans(Boolean b1,
                                  Boolean b2)

Compares two Boolean objects for sorting purposes. Returns an int value which is less than, equal to, or greater than zero depending on whether the first object sorts before, the same, or after the second object. Sorts Boolean.TRUE before Boolean.FALSE.

Parameters:

b1 - the first Boolean to compare

b2 - the second Boolean to compare

Returns:

int value which determines how the two objects should be ordered

compareBooleans

public static int compareBooleans(boolean b1,
                                  boolean b2)

Compares two boolean values for sorting purposes. Returns an int value which is less than, equal to, or greater than zero depending on whether the first object sorts before, the same, or after the second object. Sorts true before false.

Parameters:

b1 - the first boolean to compare

b2 - the second boolean to compare

Returns:

int value which determines how the two objects should be ordered

getValue

public Object getValue(Object object,
                       Locale locale)

Returns a new Boolean derived from the given object. If the object is not a Boolean, it is converted to a string and compared against the string "true".

Specified by:

getValue in class Formatter

Parameters:

object - the object to convert to a Boolean

locale - the Locale to use for conversion

Returns:

a Boolean derived from the given object