org.yarnandtail.andhow.valuetype

Class BolType

java.lang.Object

org.yarnandtail.andhow.valuetype.BaseValueType<Boolean>

org.yarnandtail.andhow.valuetype.BolType

All Implemented Interfaces:

ValueType<Boolean>

Direct Known Subclasses:

FlagType

public class BolType
extends BaseValueType<Boolean>

Metadata and parsing for configuration Properties of the Boolean type.

This class is threadsafe and uses a singleton pattern to prevent multiple instances, since all users can safely share the same instance.

Field Summary

Fields inherited from class org.yarnandtail.andhow.valuetype.BaseValueType

clazzType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BolType()

Method Summary

Modifier and Type	Method and Description
Boolean	cast(Object o) Attempt to cast the object to the generic type T, which is a concrete class in subclasses.
static BolType	instance() Fetch the single, shared instace of this ValueType
Boolean	parse(String sourceValue) Parses a String to a Boolean.

Methods inherited from class org.yarnandtail.andhow.valuetype.BaseValueType

getDestinationType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BolType

protected BolType()

Method Detail

instance

public static BolType instance()

Fetch the single, shared instace of this ValueType

Returns:

An instance of the BolType()

parse

public Boolean parse(String sourceValue)
              throws ParsingException

Parses a String to a Boolean. The String should already be trimmed.

Returns True if the String matches one of the 'true-ish' values or false if it matches one of the 'false-ish' values (case-insensitive). Recognized True strings:

• true
• t
• yes
• y
• on

Recognized False strings:

• false
• f
• no
• n
• off

Unrecognized values will throw a ParsingException, null values always return null. Values are assumed to be trimmed to null (if appropriate from where they are loaded from) prior to being passed to this method.

Note: The parsing behavior changed in the 0.5.0 release to have an explicit list of False values. See Issue 658.

Parameters:

sourceValue - The source string, which should already be trimmed and may be null

Returns:

The parsed value, or null if null is passed.

Throws:

ParsingException - If the value is not a recognized True or False string.

cast

public Boolean cast(Object o)
             throws RuntimeException

Description copied from interface: ValueType

Attempt to cast the object to the generic type T, which is a concrete class in subclasses.

AndHow uses this internally to cast values known to already be of type T, but were stored in a generic way. If used for unknown types that are not castable to T, it will throw a RuntimeException, though this should never happen unless used by application code.

Parameters:

o - Object to cast

Returns:

A cast obeject

Throws:

RuntimeException