org.yarnandtail.andhow.property

Class BigDecProp

java.lang.Object

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

org.yarnandtail.andhow.property.BigDecProp

All Implemented Interfaces:

Property<BigDecimal>

public class BigDecProp
extends PropertyBase<BigDecimal>

A BigDecimal configuration Property

Parsing values from strings is done by the BigDecType, which parses values using the BigDecimal.BigDecimal(String). The constructor accepts many different forms - refer there for valid String formats.

Before parsing String values, the TrimToNullTrimmer is applied by default.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigDecProp.BigDecBuilder Build a BigDecProp

Constructor Summary

Constructors

Constructor and Description
BigDecProp(BigDecimal defaultValue, boolean required, String shortDesc, List<Validator<BigDecimal>> validators, List<Name> aliases, PropertyType paramType, ValueType<BigDecimal> valueType, Trimmer trimmer, String helpText) Construct an instance of BigDecProp

Method Summary

Modifier and Type	Method and Description
static BigDecProp.BigDecBuilder	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

BigDecProp

public BigDecProp(BigDecimal defaultValue,
                  boolean required,
                  String shortDesc,
                  List<Validator<BigDecimal>> validators,
                  List<Name> aliases,
                  PropertyType paramType,
                  ValueType<BigDecimal> valueType,
                  Trimmer trimmer,
                  String helpText)

Construct an instance of BigDecProp

Parameters:

defaultValue - default value

required - make the property required or not

shortDesc - short description of the property

validators - list of validators for the property

aliases - aliases of the property

paramType - property type

valueType - property value type

trimmer - trimmer associated with the property

helpText - help text of the property

Method Detail

builder

public static BigDecProp.BigDecBuilder builder()

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

Use as BigDecProp.builder()...series of builder methods...build();

Returns:

The builder instance that can be chained