org.yarnandtail.andhow.property

Class BolProp

java.lang.Object

org.yarnandtail.andhow.property.PropertyBase<Boolean>

org.yarnandtail.andhow.property.BolProp

All Implemented Interfaces:

Property<Boolean>

public class BolProp
extends PropertyBase<Boolean>

A Boolean configuration Property

Parsing values from strings is done by the BolType. When parsing, a string is considered True if it 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 RuntimeException at startup, values that are empty or have been trimmed to empty are considered null.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BolProp.BolBuilder

Constructor Summary

Constructors

Constructor and Description
BolProp(Boolean defaultValue, boolean nonNull, String shortDesc, List<Name> aliases, PropertyType paramType, ValueType<Boolean> valueType, Trimmer trimmer, String helpText)

Method Summary

Modifier and Type	Method and Description
static BolProp.BolBuilder	builder() A chainable builder for this property that should terminate with build()

Methods inherited from class org.yarnandtail.andhow.property.PropertyBase

getDefaultValue, getDescription, getExplicitValue, getHelpText, getPropertyType, getRequestedAliases, getTrimmer, getValidators, getValue, getValueType, isNonNullRequired

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yarnandtail.andhow.api.Property

getCanonicalName, getInAliases, getOutAliases, getValueAsString, isExplicitlySet

Constructor Detail

BolProp

public BolProp(Boolean defaultValue,
               boolean nonNull,
               String shortDesc,
               List<Name> aliases,
               PropertyType paramType,
               ValueType<Boolean> valueType,
               Trimmer trimmer,
               String helpText)

Method Detail

builder

public static BolProp.BolBuilder builder()

A chainable builder for this property that should terminate with build()

Use as: BolProp.builder()...series of builder methods...build();

Returns:

The builder instance that can be chained