org.yarnandtail.andhow.property

Class StrProp

java.lang.Object

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

org.yarnandtail.andhow.property.StrProp

All Implemented Interfaces:

Property<String>

public class StrProp
extends PropertyBase<String>

A String configuration Property

By default, StrProp uses the QuotedSpacePreservingTrimmer, which will keep whitespace inside double quotes for loaders that are coming from text based sources, such as properties files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StrProp.StrBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static StrProp.StrBuilder	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

StrProp

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

Method Detail

builder

public static StrProp.StrBuilder builder()

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

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

Returns:

The builder instance that can be chained