org.yarnandtail.andhow.property

Class LngProp

java.lang.Object

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

org.yarnandtail.andhow.property.LngProp

All Implemented Interfaces:

Property<Long>

public class LngProp
extends PropertyBase<Long>

A Long configuration Property

Parsing values from strings is done by the LngType, which parses values using the Long.parseLong(String). Note that the parseLong method does not accept a trailing 'L' or 'l' as the Java literal does. E.g., this is the correct way to spec a Long value in a properties file: name.of.my.long.property.MY_PROPERTY = 90 Before parsing String values, the TrimToNullTrimmer is applied by default.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LngProp.LngBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static LngProp.LngBuilder	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

LngProp

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

Method Detail

builder

public static LngProp.LngBuilder builder()

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

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

Returns:

The builder instance that can be chained