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>

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

Method Summary

Modifier and Type	Method and Description
Boolean	cast(Object o) Attempt to cast the passed object to the generic type T.
static BolType	get() Deprecated. since 0.4.1. Use instance() instead
static BolType	instance()
Boolean	parse(String sourceValue) Parses a String to a Boolean.

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

getDestinationType, isParsable, toString

Methods inherited from class java.lang.Object

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

Method Detail

get

@Deprecated
public static BolType get()

Deprecated. since 0.4.1. Use instance() instead

Returns:

An instance of the BolType()

instance

public static BolType instance()

Returns:

An instance of the BolType()

parse

public Boolean parse(String sourceValue)
              throws IllegalArgumentException

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

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

Trims the value and returns True if the trimmed String matches one of these values (case-insensitive) :

• true
• t
• yes
• y
• on

If it does not match a value in the list and does not trim to null, False is returned. If the value is null after trimming, null is returned.

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:

IllegalArgumentException - (doesn't currently happen)

cast

public Boolean cast(Object o)
             throws RuntimeException

Description copied from interface: ValueType

Attempt to cast the passed object to the generic type T. 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.

Returns:

Throws:

RuntimeException