Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W _ 

A

AbstractPropertyRegistrar - Class in org.yarnandtail.andhow.service
Provides a minimal implementation of PropertyRegistrar to simplify code that must be generated.
AbstractPropertyRegistrar() - Constructor for class org.yarnandtail.andhow.service.AbstractPropertyRegistrar
 
add(P) - Method in class org.yarnandtail.andhow.api.ProblemList
 
add(P) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
add(int, P) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
add(PropertyRegistration) - Method in class org.yarnandtail.andhow.service.PropertyRegistrationList
Adds a registration using the innerPath specified in the passed registration.
add(String) - Method in class org.yarnandtail.andhow.service.PropertyRegistrationList
Adds a property registration with the same path as the previously added one.
add(String, String...) - Method in class org.yarnandtail.andhow.service.PropertyRegistrationList
Adds a property registration with a specified path.
add(String, List<String>) - Method in class org.yarnandtail.andhow.service.PropertyRegistrationList
Adds a property registration with a specified path.
addAlias(Name, List<Name>) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Used by public alias methods to actually add the Alias.
addAll(int, Collection<? extends P>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
addAll(Collection<? extends P>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
addBlank() - Method in class org.yarnandtail.andhow.sample.TextBlock
Add a blank line, added as a TextLine.BlankLine.
ADDED_JNDI_ROOTS - Static variable in interface org.yarnandtail.andhow.load.std.StdJndiLoader.CONFIG
 
addExportGroup(ExportGroup) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
addFixedValue(Property<T>, T) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets a fixed, non-configurable value for a Property.
addFixedValue(String, Object) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets a fixed, non-configurable value for a named Property.
addFixedValue(Property<T>, T) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
addFixedValue(String, Object) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
addHandler(Handler) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
addHR() - Method in class org.yarnandtail.andhow.sample.TextBlock
Add a Horizontal Rule line, added as a TextLine.HRLine.
addLine(String) - Method in class org.yarnandtail.andhow.sample.TextBlock
Add a String, which will be added as TextLine with the wrap setting inherited from this block.
addProblem(ValueProblem) - Method in class org.yarnandtail.andhow.api.ValidatedValue
 
addProperty(NameAndProperty) - Method in class org.yarnandtail.andhow.api.GroupProxyMutable
 
addProperty(GroupProxy, Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
Adds a Group, its Property and the name and aliases for that property to all the collections.
addPropertyRegistrations(PropertyRegistrationList) - Method in class org.yarnandtail.andhow.service.AbstractPropertyRegistrar
Can be used by subclasses to build the property registration list.
addValues(LoaderValues) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
after(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
 
After(LocalDateTime) - Constructor for class org.yarnandtail.andhow.valid.LocalDateTimeValidator.After
 
aliasIn(String) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Adds an alternate name for this property that will be recognized when a Loader reads a property in from a source, such as JNDI or a properties file.
aliasInAndOut(String) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Adds an alternate name for this property that will both be recognized when reading in properties and can be used when exporting properties.
aliasOut(String) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Adds an alternate name for this property that can be used if this property is exported, such as exporting to System.properties.
AndHow - Class in org.yarnandtail.andhow
Central AndHow singleton class.
AndHow.Initialization - Class in org.yarnandtail.andhow
Encapsulate when and where AndHow was initialized.
ANDHOW_INLINE_NAME - Static variable in class org.yarnandtail.andhow.AndHow
 
ANDHOW_NAME - Static variable in class org.yarnandtail.andhow.AndHow
 
ANDHOW_TAG_LINE - Static variable in class org.yarnandtail.andhow.AndHow
 
ANDHOW_URL - Static variable in class org.yarnandtail.andhow.AndHow
 
AndHowConfiguration<C extends AndHowConfiguration> - Interface in org.yarnandtail.andhow
 
AndHowCore - Class in org.yarnandtail.andhow.internal
Actual central instance of AndHow's state after a successful initialization.
AndHowCore(NamingStrategy, List<Loader>, List<GroupProxy>) - Constructor for class org.yarnandtail.andhow.internal.AndHowCore
 
AndHowInit - Interface in org.yarnandtail.andhow
Marks a class as an auto-discoverable configuration provider for AndHow in production.
AndHowLog - Class in org.yarnandtail.andhow.util
A simple wrapper around the java.util.Logging utility that makes it behave more like SLF4J, including more use of standard message formatting.
AndHowLogFormatter - Class in org.yarnandtail.andhow.util
Formats LogRecords into a string to be displayed (typically on the console).
AndHowLogFormatter() - Constructor for class org.yarnandtail.andhow.util.AndHowLogFormatter
 
AndHowLogHandler - Class in org.yarnandtail.andhow.util
Handles writing a java.util.Logger to a PrintStream, by default System.err for errors and System.out for non-errors.
AndHowLogHandler() - Constructor for class org.yarnandtail.andhow.util.AndHowLogHandler
 
AndHowLogHandler(PrintStream, PrintStream) - Constructor for class org.yarnandtail.andhow.util.AndHowLogHandler
 
AndHowTestInit - Interface in org.yarnandtail.andhow
Marks a class as an auto-discoverable configuration provider for AndHow during testing.
AndHowUtil - Class in org.yarnandtail.andhow.util
Utilities used by AndHow during initial construction.
AndHowUtil() - Constructor for class org.yarnandtail.andhow.util.AndHowUtil
 
ANSI_CYAN - Static variable in class org.yarnandtail.andhow.util.AndHowLogFormatter
 
ANSI_RED - Static variable in class org.yarnandtail.andhow.util.AndHowLogFormatter
 
ANSI_RESET - Static variable in class org.yarnandtail.andhow.util.AndHowLogFormatter
 
AppFatalException - Exception in org.yarnandtail.andhow.api
An exception that causes configuration processing to stop b/c it cannot proceed.
AppFatalException(String, Throwable) - Constructor for exception org.yarnandtail.andhow.api.AppFatalException
Used for errors while the AndHow builder is still in use - we don't have full context b/c AndHow has not been constructed yet.
AppFatalException(String) - Constructor for exception org.yarnandtail.andhow.api.AppFatalException
Used for errors while the AndHow builder is still in use - we don't have full context b/c AndHow has not been constructed yet.
AppFatalException(String, ProblemList<Problem>) - Constructor for exception org.yarnandtail.andhow.api.AppFatalException
 
AppFatalException(String, Problem) - Constructor for exception org.yarnandtail.andhow.api.AppFatalException
 
AppFatalException(Problem) - Constructor for exception org.yarnandtail.andhow.api.AppFatalException
 
attemptToAdd(PropertyConfigurationInternal, List<ValidatedValue>, ProblemList<Problem>, String, String) - Method in class org.yarnandtail.andhow.load.BaseLoader
Util method to load a String to a property by name.
attemptToAdd(PropertyConfigurationInternal, List<ValidatedValue>, ProblemList<Problem>, String, Object) - Method in class org.yarnandtail.andhow.load.BaseLoader
Util method to load an Object value to a named Property.
attemptToAdd(PropertyConfigurationInternal, List<ValidatedValue>, ProblemList<Problem>, Property, Object) - Method in class org.yarnandtail.andhow.load.BaseLoader
Util method to attempt to load an object of an unknown type to a property.
attemptToAddIfNotDuplicate(PropertyConfigurationInternal, List<ValidatedValue>, ProblemList<Problem>, ValidatedValue) - Method in class org.yarnandtail.andhow.load.BaseLoader
Adds the ValidatedValue to the VV list if it is not a duplicate.

B

badPropertyCoord - Variable in class org.yarnandtail.andhow.internal.ConstructionProblem
The Property that actually has the problem
badValueCoord - Variable in class org.yarnandtail.andhow.internal.LoaderProblem
The Property that actually has the problem
badValueCoord - Variable in class org.yarnandtail.andhow.internal.ValueProblem
 
BaseConfig<C extends BaseConfig<C>> - Class in org.yarnandtail.andhow
Basic abstract implementation for AndHowConfiguration instances.
BaseConfig() - Constructor for class org.yarnandtail.andhow.BaseConfig
Construct a new instance.
BaseExporter - Class in org.yarnandtail.andhow.export
All implementations must have a zero argument constructor.
BaseExporter() - Constructor for class org.yarnandtail.andhow.export.BaseExporter
 
BaseLoader - Class in org.yarnandtail.andhow.load
 
BaseLoader() - Constructor for class org.yarnandtail.andhow.load.BaseLoader
 
BaseSamplePrinter - Class in org.yarnandtail.andhow.sample
 
BaseSamplePrinter() - Constructor for class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
BaseValueType<T> - Class in org.yarnandtail.andhow.valuetype
 
BaseValueType(Class<T>) - Constructor for class org.yarnandtail.andhow.valuetype.BaseValueType
 
before(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
 
Before(LocalDateTime) - Constructor for class org.yarnandtail.andhow.valid.LocalDateTimeValidator.Before
 
BigDecBuilder() - Constructor for class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
Construct an instance of BigDecBuilder
BigDecProp - Class in org.yarnandtail.andhow.property
A Property that refers to a BigDecimal value.
BigDecProp(BigDecimal, boolean, String, List<Validator<BigDecimal>>, List<Name>, PropertyType, ValueType<BigDecimal>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.BigDecProp
Construct an instance of BigDecProp
BigDecProp.BigDecBuilder - Class in org.yarnandtail.andhow.property
Build a BigDecProp
BigDecType - Class in org.yarnandtail.andhow.valuetype
Type representation of Java BigDecimal objects.
BigDecValidator - Class in org.yarnandtail.andhow.valid
Abstract class implementing Validator interface for BigDec.
BigDecValidator.GreaterThan - Class in org.yarnandtail.andhow.valid
Validate that a BigDecimal is greater than a specified reference.
BigDecValidator.GreaterThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that a BigDecimal is greater than or equal to a specified reference.
BigDecValidator.LessThan - Class in org.yarnandtail.andhow.valid
Validate that a BigDecimal is less than a specified reference.
BigDecValidator.LessThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that a BigDecimal is less than or equal to a specified reference.
BlankLine() - Constructor for class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
blockCommentEnd - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
blockCommentSeparator - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
blockCommentStart - Variable in class org.yarnandtail.andhow.sample.PrintFormat
either block comments or lineComment should be non-null, but not both
BolBuilder() - Constructor for class org.yarnandtail.andhow.property.BolProp.BolBuilder
 
BolProp - Class in org.yarnandtail.andhow.property
A True/False value that can be null, just like a Java Boolean Object.
BolProp(Boolean, boolean, String, List<Name>, PropertyType, ValueType<Boolean>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.BolProp
 
BolProp.BolBuilder - Class in org.yarnandtail.andhow.property
 
BolType - Class in org.yarnandtail.andhow.valuetype
Metadata and parsing for the Boolean type.
build() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Deprecated.
This method will be removed in the next major release. Use AndHow.instance() or AndHow.initialize()
build() - Method in class org.yarnandtail.andhow.BaseConfig
 
build() - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
 
build() - Method in class org.yarnandtail.andhow.property.BolProp.BolBuilder
 
build() - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
 
build() - Method in class org.yarnandtail.andhow.property.FlagProp.FlagBuilder
 
build() - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
 
build() - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
 
build() - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
 
build() - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Build the Property instance.
build() - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
buildDefinition(List<GroupProxy>, List<Loader>, NamingStrategy, ProblemList<Problem>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Build a fully populated ConstructionDefinition from the passed Groups, using the NamingStrategy to generate names for each.
builder() - Static method in class org.yarnandtail.andhow.property.BigDecProp
Return an instance of BigDecBuilder
builder() - Static method in class org.yarnandtail.andhow.property.BolProp
 
builder() - Static method in class org.yarnandtail.andhow.property.DblProp
 
builder() - Static method in class org.yarnandtail.andhow.property.FlagProp
 
builder() - Static method in class org.yarnandtail.andhow.property.IntProp
 
builder() - Static method in class org.yarnandtail.andhow.property.LngProp
 
builder() - Static method in class org.yarnandtail.andhow.property.LocalDateTimeProp
 
builder() - Static method in class org.yarnandtail.andhow.property.StrProp
 
buildExportNames() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
Build the export names based on annotation options.
buildFatalException(ProblemList<Problem>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
 
buildGroupProxies(Collection<Class<?>>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
 
buildGroupProxy(Class<?>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Invokes buildGroupProxy(group, true).
buildGroupProxy(Class<?>, boolean) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Wraps a class that contains AndHow Properties in Proxy class for use within AndHow.
buildJndiNames(PropertyConfigurationInternal, List<String>, Property) - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
Builds a complete list of complete JNDI names to search for a parameter value.
buildJndiRoots(ValidatedValues) - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
Combines the values of STANDARD_JNDI_ROOTS and ADDED_JNDI_ROOTS into one list of jndi root contexts to search.
buildLoaders() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
 
buildLoaders() - Method in class org.yarnandtail.andhow.BaseConfig
 
buildNames(Property, GroupProxy) - Method in interface org.yarnandtail.andhow.api.NamingStrategy
Build a list of names for the Property
buildNames(Property, GroupProxy) - Method in class org.yarnandtail.andhow.name.CaseInsensitiveNaming
 
buildNamesFromCanonical(Property, GroupProxy, String) - Method in class org.yarnandtail.andhow.name.CaseInsensitiveNaming
 
buildStdEnvVarLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdEnvVarLoader, passing it the needed context.
buildStdFixedValueLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdFixedValueLoader, passing it the needed context.
buildStdJndiLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdJndiLoader, passing it the needed context.
buildStdMainStringArgsLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdMainStringArgsLoader, passing it the needed context.
buildStdPropFileOnClasspathLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdPropFileOnClasspathLoader, passing it the needed context.
buildStdPropFileOnFilesystemLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdPropFileOnFilesystemLoader, passing it the needed context.
buildStdSysPropLoader() - Method in class org.yarnandtail.andhow.BaseConfig
Build a StdSysPropLoader, passing it the needed context.
buildValueMapImmutable(List<LoaderValues>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
 

C

calcLocation(String) - Static method in class org.yarnandtail.andhow.util.StackLocator
 
CaseInsensitiveNaming - Class in org.yarnandtail.andhow.name
Case insensitive naming.
CaseInsensitiveNaming() - Constructor for class org.yarnandtail.andhow.name.CaseInsensitiveNaming
 
cast(Object) - Method in interface org.yarnandtail.andhow.api.ValueType
Attempt to cast the passed object to the generic type T.
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.BigDecType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.BolType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.DblType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.FlagType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.IntType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.LngType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.LocalDateTimeType
 
cast(Object) - Method in class org.yarnandtail.andhow.valuetype.StrType
 
checkForInvalidDefaultValue(Property<T>, GroupProxy, String) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
Checks a Property's default value against its Validators and adds entries to constructProblems if there are issues.
classExists(String) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Returns true if the specified class name is on the classpath.
classpathPropertiesNotRequired() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets the properties file on the classpath to be optional, the default.
classpathPropertiesNotRequired() - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
classpathPropertiesRequired() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
If called to set this to 'required', a classpath properties file must exist and be readable.
classpathPropertiesRequired() - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
classpathPropFilePathProp - Variable in class org.yarnandtail.andhow.BaseConfig
 
classpathPropFilePathStr - Variable in class org.yarnandtail.andhow.BaseConfig
 
clazzType - Variable in class org.yarnandtail.andhow.valuetype.BaseValueType
 
clear() - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
close() - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
 
compareInnerPathTo(PropertyRegistration) - Method in class org.yarnandtail.andhow.service.PropertyRegistration
Equivalent to compareTo for just the inner path class and its fully qualified path.
compareRootTo(PropertyRegistration) - Method in class org.yarnandtail.andhow.service.PropertyRegistration
Equivalent to compareTo for just the root class and its fully qualified path.
compareTo(PropertyRegistration) - Method in class org.yarnandtail.andhow.service.PropertyRegistration
Comparison that results in sorting from root properties to the most nested, incrementally by each inner path step.
ConstructionProblem - Class in org.yarnandtail.andhow.internal
A problem bootstrapping the AndHow, prior to attempting to load any values.
ConstructionProblem() - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem
 
ConstructionProblem.DuplicateLoader - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.DuplicateProperty - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.ExportException - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.InitiationLoopException - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.InvalidDefaultValue - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.InvalidValidationConfiguration - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.LoaderPropertyIsNull - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.LoaderPropertyNotRegistered - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.NonUniqueNames - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.PropertyNotPartOfGroup - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.SecurityException - Class in org.yarnandtail.andhow.internal
 
ConstructionProblem.TooManyAndHowInitInstances - Class in org.yarnandtail.andhow.internal
 
containsUserGroups() - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
containsUserGroups() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
containsUserGroups() - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
Returns true if any of the registered groups are user groups.
containsUserGroups() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
CREATE_SAMPLES - Static variable in interface org.yarnandtail.andhow.Options
 
createValue(PropertyConfigurationInternal, Property<T>, String) - Method in class org.yarnandtail.andhow.load.BaseLoader
 

D

DblBuilder() - Constructor for class org.yarnandtail.andhow.property.DblProp.DblBuilder
 
DblProp - Class in org.yarnandtail.andhow.property
A Property that refers to a Double value.
DblProp(Double, boolean, String, List<Validator<Double>>, List<Name>, PropertyType, ValueType<Double>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.DblProp
 
DblProp.DblBuilder - Class in org.yarnandtail.andhow.property
 
DblType - Class in org.yarnandtail.andhow.valuetype
Type representation of Java Double objects.
DblValidator - Class in org.yarnandtail.andhow.valid
A collection of Double validation types
DblValidator() - Constructor for class org.yarnandtail.andhow.valid.DblValidator
 
DblValidator.GreaterThan - Class in org.yarnandtail.andhow.valid
Validate that a long is greater than a specified reference.
DblValidator.GreaterThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that an long is greater than or equal to a specified reference.
DblValidator.LessThan - Class in org.yarnandtail.andhow.valid
Validate that an long is less than a specified reference.
DblValidator.LessThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that a long is less than or equal to a specified reference.
debug(String) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
debug(String, Object...) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
debug(String, Throwable) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
DEFAULT_LINE_WIDTH - Static variable in class org.yarnandtail.andhow.internal.ReportGenerator
 
DEFAULT_LOADER_LIST - Static variable in class org.yarnandtail.andhow.BaseConfig
 
DEFAULT_PROP_FILE - Static variable in class org.yarnandtail.andhow.load.std.StdPropFileOnClasspathLoader
 
DEFAULT_VALUE_TEXT - Static variable in interface org.yarnandtail.andhow.api.SamplePrinter
Lead-in for a default value
defaultValue(T) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Assigns a default value for the property.
desc(String) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Same as description
description(String) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
doExport(String, Property<T>, PropertyConfigurationInternal, ValidatedValues) - Method in class org.yarnandtail.andhow.export.BaseExporter
Subclasses can implement just this method.
doExport(String, Property<T>, PropertyConfigurationInternal, ValidatedValues) - Method in class org.yarnandtail.andhow.export.SysPropExporter
 
doManualExport(List<Class<?>>, Collection<GroupProxy>) - Method in class org.yarnandtail.andhow.internal.export.ManualExportService
Perform an export for a list of Classes.
DuplicateLoader(Loader) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.DuplicateLoader
 
DuplicateProperty(GroupProxy, Property<?>, GroupProxy, Property<?>) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.DuplicateProperty
 
DuplicatePropertyLoaderProblem(Loader, Class<?>, Property) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.DuplicatePropertyLoaderProblem
 

E

EffectiveName - Class in org.yarnandtail.andhow.api
A name for a Property that has been processed by a NamingStrategy to create an effectiveIn name, which may be different than the original name.
EffectiveName(String, String, boolean, boolean) - Constructor for class org.yarnandtail.andhow.api.EffectiveName
A new instance using the actual name as the effective out.
EMPTY_PROBLEM_LIST - Static variable in class org.yarnandtail.andhow.api.ProblemList
Empty immutable
EMPTY_PROP_VALUE_LIST - Static variable in class org.yarnandtail.andhow.api.LoaderValues
 
EMPTY_PROPERTY_LIST - Static variable in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
 
EMPTY_STRING_ARRAY - Static variable in class org.yarnandtail.andhow.util.TextUtil
 
EMPTY_STRING_LIST - Static variable in class org.yarnandtail.andhow.util.TextUtil
 
endsWith(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
EndsWith(String, boolean) - Constructor for class org.yarnandtail.andhow.valid.StringValidator.EndsWith
 
endsWithIgnoringCase(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
ensureCapacity(int) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
envProperties - Variable in class org.yarnandtail.andhow.BaseConfig
 
equals(Object) - Method in class org.yarnandtail.andhow.PropertyValue
Overrides standard equals to return true if the Property is the same class instance and the values are equal.
error(String) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
error(String, Object...) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
error(String, Throwable) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
escapeXml(String) - Static method in class org.yarnandtail.andhow.util.TextUtil
 
expandDirectoryPath(String) - Static method in class org.yarnandtail.andhow.util.IOUtil
Expands directory path, replacing known values like java.io.tmpdir w/ their values.
expandFilePath(String) - Static method in class org.yarnandtail.andhow.util.IOUtil
Expands a file or directory path, replacing known values like java.io.tmpdir w/ their values.
export(Class<?>...) - Method in class org.yarnandtail.andhow.AndHow
Export Property's to a collection for use with frameworks that take configuration as key-value maps or similar.
export(PropertyConfigurationInternal, ValidatedValues) - Method in interface org.yarnandtail.andhow.api.Exporter
Deprecated.
This method violates the security and was never actually called by the system. Removing with no replacement.
export(GroupProxy, PropertyConfigurationInternal, ValidatedValues) - Method in interface org.yarnandtail.andhow.api.Exporter
Exports a Group.
export(GroupProxy, PropertyConfigurationInternal, ValidatedValues) - Method in class org.yarnandtail.andhow.export.BaseExporter
 
export(Property<?>, PropertyConfigurationInternal, ValidatedValues) - Method in class org.yarnandtail.andhow.export.BaseExporter
 
export(Class<?>...) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
exportClass(Class<?>, Exporter.EXPORT_CANONICAL_NAME, Exporter.EXPORT_OUT_ALIASES, Collection<GroupProxy>, Collection<PropertyExport>) - Method in class org.yarnandtail.andhow.internal.export.ManualExportService
Export the Properties contained in a single class with no recursion.
exportClassAndChildren(Class<?>, Exporter.EXPORT_CANONICAL_NAME, Exporter.EXPORT_OUT_ALIASES, Set<Class<?>>, Collection<GroupProxy>, Collection<PropertyExport>) - Method in class org.yarnandtail.andhow.internal.export.ManualExportService
Export this class and all contained, nested inner classes if permitted.
ExportCollector - Class in org.yarnandtail.andhow.export
Implementations of Collector that can be used collect a stream() of PropertyExports into key-value pair Maps or Properties.
Exporter - Interface in org.yarnandtail.andhow.api
An Exporter exports property names and values for classes that are annotated with GroupExport.
Exporter.EXPORT_CANONICAL_NAME - Enum in org.yarnandtail.andhow.api
 
Exporter.EXPORT_OUT_ALIASES - Enum in org.yarnandtail.andhow.api
 
ExportException(Exception, GroupProxy, String) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.ExportException
 
ExportGroup - Class in org.yarnandtail.andhow.api
Bundles an exporter and a Group for it to export.
ExportGroup(Exporter, GroupProxy) - Constructor for class org.yarnandtail.andhow.api.ExportGroup
 

F

fieldName - Variable in class org.yarnandtail.andhow.internal.NameAndProperty
 
filesystemPropFileNotRequired() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets the properties file on the filesystem to be optional, the default.
filesystemPropFileNotRequired() - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
filesystemPropFilePathProp - Variable in class org.yarnandtail.andhow.BaseConfig
 
filesystemPropFileRequired() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
If called to set this to 'required', a non-null configured value for the filesystem properties file must point to an existing, readable properties file.
filesystemPropFileRequired() - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
filter(Class<P>) - Method in class org.yarnandtail.andhow.api.ProblemList
 
findConfig() - Static method in class org.yarnandtail.andhow.AndHow
Prior to AndHow initialization, this method finds the configuration that will be used.
findConfiguration(AndHowConfiguration<? extends AndHowConfiguration>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
 
findDuplicateProperty(ValidatedValue, List<ValidatedValue>) - Method in class org.yarnandtail.andhow.load.BaseLoader
 
findEffectiveAllowAnnotation(Class<?>) - Method in class org.yarnandtail.andhow.internal.export.ManualExportService
Returns the effective ManualExportAllowed annotation instance if it exists.
findFirstInstanceOf(String, int, String...) - Static method in class org.yarnandtail.andhow.util.TextUtil
Find the first occurrence of one of an array of possible strings in another string, starting at the specified position, looking to the right.
findLastInstanceOf(String, int, String...) - Static method in class org.yarnandtail.andhow.util.TextUtil
Find the first occurrence of one of an array of possible strings in another string, starting at the specified position and seeking to the left.
findMethod(Class<?>, String, Class<?>...) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Hunts up the inheritance tree to find the specified method.
FixedValueLoader - Class in org.yarnandtail.andhow.load
A utility loader that is used internally to put fixed values into the effective list of configured values.
FixedValueLoader() - Constructor for class org.yarnandtail.andhow.load.FixedValueLoader
 
FlagBuilder() - Constructor for class org.yarnandtail.andhow.property.FlagProp.FlagBuilder
 
FlagProp - Class in org.yarnandtail.andhow.property
A True/False switch that is never null and behaves similarly to a unix cmd line switch.
FlagProp(Boolean, String, List<Name>, PropertyType, ValueType<Boolean>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.FlagProp
 
FlagProp.FlagBuilder - Class in org.yarnandtail.andhow.property
 
FlagType - Class in org.yarnandtail.andhow.valuetype
Metadata and parsing for a Boolean type which is never null (nix flag behavior).
flush() - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
 
format - Variable in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
format - Variable in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
format(LogRecord) - Method in class org.yarnandtail.andhow.util.AndHowLogFormatter
Format a LogRecord into a string to be displayed (typically on the console).
format(String, Object...) - Static method in class org.yarnandtail.andhow.util.TextUtil
Creates a message with {} instances replaced with values from the args list, similar to how SLF4J formats messages.

G

get() - Static method in class org.yarnandtail.andhow.valuetype.BolType
Deprecated.
since 0.4.1. Use BolType.instance() instead
get() - Static method in class org.yarnandtail.andhow.valuetype.DblType
Deprecated.
since 0.4.1. Use DblType.instance() instead
get() - Static method in class org.yarnandtail.andhow.valuetype.FlagType
Deprecated.
since 0.4.1. Use FlagType.instance() instead
get() - Static method in class org.yarnandtail.andhow.valuetype.IntType
Deprecated.
since 0.4.1. Use IntType.instance() instead
get() - Static method in class org.yarnandtail.andhow.valuetype.LngType
Deprecated.
since 0.4.1. Use LngType.instance() instead
get() - Static method in class org.yarnandtail.andhow.valuetype.LocalDateTimeType
Deprecated.
since 0.4.1. Use LocalDateTimeType.instance() instead
getActualName() - Method in class org.yarnandtail.andhow.api.Name
The actual, originally name.
getActualProperty(PropertyConfigurationInternal, GroupProxy, Property) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
getActualProperty(PropertyConfigurationInternal, GroupProxy, Property) - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getActualProperty(PropertyConfigurationInternal, GroupProxy, Property) - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getAliases(Property<?>) - Method in class org.yarnandtail.andhow.AndHow
 
getAliases(Property<?>) - Method in interface org.yarnandtail.andhow.api.PropertyConfiguration
All the effective 'in' & 'out' aliases for this property, not including the canonical name.
getAliases() - Method in class org.yarnandtail.andhow.api.PropertyNaming
All aliases for the property.
getAliases(Property<?>) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getAliases(Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getAliases(Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getAllLoaderValues() - Method in interface org.yarnandtail.andhow.api.ValidatedValuesWithContext
A sequential list of all loaders and all its values, even overwritten ones.
getAllLoaderValues() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getAllLoaderValues() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getAllowAnnotation(Class<?>) - Method in class org.yarnandtail.andhow.internal.export.ManualExportService
Gets the ManualExportAllowed annotation directly on this class.
getAllValuesLoadedByLoader(Loader) - Method in interface org.yarnandtail.andhow.api.ValidatedValuesWithContext
All the values loaded by the specified Loader, even if they were overridden by earlier loaders.
getAllValuesLoadedByLoader(List<LoaderValues>, Loader) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
 
getAllValuesLoadedByLoader(Loader) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getAllValuesLoadedByLoader(Loader) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getAndHowConfiguration(AndHowConfiguration) - Method in class org.yarnandtail.andhow.service.InitLoader
Returns an AndHowConfiguration from an AndHowInit instance from the service loader, or if not found, the default one passed in.
getAndHowConfiguration(AndHowConfiguration) - Method in class org.yarnandtail.andhow.service.TestInitLoader
Returns an AndHowConfiguration from an AndHowInit instance from the service loader, or if not found, the default one passed in.
getAndHowName(String, String, List<String>) - Static method in class org.yarnandtail.andhow.util.NameUtil
The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots.
getAndHowName(String, String, String...) - Static method in class org.yarnandtail.andhow.util.NameUtil
The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots.
getAndHowName(String, String[]) - Static method in class org.yarnandtail.andhow.util.NameUtil
The AndHow canonical name of the direct parent of the AndHow Property.
getAndHowName(Class<?>) - Static method in class org.yarnandtail.andhow.util.NameUtil
The AndHow style name for a class.
getAndHowName(Class<?>, Property<?>) - Static method in class org.yarnandtail.andhow.util.NameUtil
Gets the true canonical name for a Property in the group.
getBadPropertyCoord() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem
The Property that has the problem.
getBadValueCoord() - Method in class org.yarnandtail.andhow.internal.LoaderProblem
The Property that has the problem.
getBadValueCoord() - Method in class org.yarnandtail.andhow.internal.ValueProblem
 
getBlockComment(PrintFormat, boolean, boolean) - Method in class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
getBlockComment(PrintFormat, boolean, boolean) - Method in class org.yarnandtail.andhow.sample.TextLine.HRLine
 
getBlockComment(PrintFormat, boolean, boolean) - Method in class org.yarnandtail.andhow.sample.TextLine.StringLine
 
getCanonicalName(Property<?>) - Method in class org.yarnandtail.andhow.AndHow
 
getCanonicalName() - Method in interface org.yarnandtail.andhow.api.GroupProxy
Returns the AndHow canonical name of the class this group is proxying.
getCanonicalName(Property<?>) - Method in interface org.yarnandtail.andhow.api.GroupProxy
The complete canonical name of a Property in this Group.
getCanonicalName() - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
getCanonicalName(Property<?>) - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
getCanonicalName() - Method in interface org.yarnandtail.andhow.api.Property
The canonical name of a Property.
getCanonicalName(Property<?>) - Method in interface org.yarnandtail.andhow.api.PropertyConfiguration
The canonical name of a Property.
getCanonicalName() - Method in class org.yarnandtail.andhow.api.PropertyNaming
The canonical in and out names of the Property.
getCanonicalName(Property<?>) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getCanonicalName(Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getCanonicalName(Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getCanonicalNameOption() - Method in interface org.yarnandtail.andhow.export.PropertyExport
Option read from the containing ManualExportAllowed annotation to determine if the canonical name of the Property should be included.
getCanonicalNameOption() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getCanonicalNameOption() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getCanonicalParentName() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The AndHow canonical name of the direct parent of the AndHow Property.
getCanonicalPropertyName() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The AndHow canonical name of the property, which is the root canonical name plus the elements of the inner path and the property name, all separated by dots.
getCanonicalRootName() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The canonical propName of the root class, which is the top level class, typically one per Java source file (unless someone has stuffed multiple top level classes into a single file, which is technically allowed).
getClassConfig() - Method in interface org.yarnandtail.andhow.api.Loader
Returns a PropertyGroup used to globally configure a class of Loader.
getClassConfig() - Method in class org.yarnandtail.andhow.load.BaseLoader
 
getClassConfig() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
getClassForName(String) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Loads a class by name with no errors, returning null if the class cannot be found.
getClassInstanceForName(String) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Creates a new Object instance from the named class using the default no-arg constructor.
getConfig() - Method in class org.yarnandtail.andhow.AndHow.Initialization
 
getConfigSamplePrinter() - Method in interface org.yarnandtail.andhow.api.Loader
Returns a ConfigSamplePrinter, which can be used to print a configuration sample for this Loader.
getConfigSamplePrinter() - Method in class org.yarnandtail.andhow.load.BaseLoader
 
getConfigSamplePrinter() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
getConfigSamplePrinter() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
getConfiguration() - Method in interface org.yarnandtail.andhow.AndHowInit
 
getConflictName() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.NonUniqueNames
 
getContainingClass() - Method in interface org.yarnandtail.andhow.export.PropertyExport
The class directly containing the Property.
getContainingClass() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getContainingClass() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getDefaultLoaderList() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
The default list of standard loaders, as a list of Classes that implement StandardLoader
getDefaultLoaderList() - Method in class org.yarnandtail.andhow.BaseConfig
 
getDefaultValue() - Method in interface org.yarnandtail.andhow.api.Property
The default value, as defined when this Property was constructed.
getDefaultValue() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getDescription() - Method in interface org.yarnandtail.andhow.api.Property
A description of the property, what it is for and what it does in the system.
getDescription() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getDestinationType() - Method in interface org.yarnandtail.andhow.api.ValueType
 
getDestinationType() - Method in class org.yarnandtail.andhow.valuetype.BaseValueType
 
getEffectiveInName() - Method in class org.yarnandtail.andhow.api.EffectiveName
The name as transformed by the NamingStrategy.
getEffectiveOutName() - Method in class org.yarnandtail.andhow.api.EffectiveName
 
getEffectivePath(ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
Utility method to simplify finding the effective path.
getEffectivePath(ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.std.StdPropFileOnClasspathLoader
 
getEffectiveValue(List<LoaderValues>, Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
Returns the effective value from the values that are loaded so far.
getEffectiveValuesLoadedByLoader(Loader) - Method in interface org.yarnandtail.andhow.api.ValidatedValuesWithContext
The list of Properties and values loaded by the specified loader that were not overridden by earlier Loaders.
getEffectiveValuesLoadedByLoader(List<LoaderValues>, Loader) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
 
getEffectiveValuesLoadedByLoader(Loader) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getEffectiveValuesLoadedByLoader(Loader) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getErrStream() - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Returns the PrintStream used for error level logging (java.util.logging SEVERE level).
getException() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.ExportException
 
getException() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.SecurityException
 
getExplicitValue(Property<T>) - Method in class org.yarnandtail.andhow.AndHow
 
getExplicitValue(Property<T>) - Method in class org.yarnandtail.andhow.api.LoaderValues
A linear search for the Property in the values loaded by this loader.
getExplicitValue() - Method in interface org.yarnandtail.andhow.api.Property
The value found and loaded for this value by a Loader.
getExplicitValue(Property<T>) - Method in interface org.yarnandtail.andhow.api.ValidatedValues
The value found and loaded for this value by a Loader.
getExplicitValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getExplicitValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesImmutable
 
getExplicitValue(List<LoaderValues>, Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
 
getExplicitValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getExplicitValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getExplicitValue() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getExporter() - Method in class org.yarnandtail.andhow.api.ExportGroup
 
getExporters(GroupProxy) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Returns the list of Exporters that are annotated for a BasePropertyGroup.
getExportGroups() - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getExportGroups() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getExportGroups() - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
The list of ExportGroups, which handles exporting property values for use outside the AndHow framework.
getExportGroups() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getExportNames() - Method in interface org.yarnandtail.andhow.export.PropertyExport
The complete list of export names for this property, which may be null, empty or many.
getExportNames() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getExportNames() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getFieldName(Class<?>, Property<?>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Gets the field name for a property in a class, which is just the last portion of the canonical name.
getFormat() - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getFormat() - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getFullMessage() - Method in interface org.yarnandtail.andhow.api.Problem
A complete description of the problem w/ context and problem description.
getFullMessage() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem
 
getFullMessage() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InitiationLoopException
 
getFullMessage() - Method in class org.yarnandtail.andhow.internal.LoaderProblem
 
getFullMessage() - Method in class org.yarnandtail.andhow.internal.RequirementProblem
 
getFullMessage() - Method in class org.yarnandtail.andhow.internal.ValueProblem
 
getGroup() - Method in class org.yarnandtail.andhow.api.ExportGroup
 
getGroup() - Method in class org.yarnandtail.andhow.internal.PropertyCoord
The group containing the Property, if that can be determined.
getGroupForProperty(Property<?>) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getGroupForProperty(Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getGroupForProperty(Property<?>) - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
Finds the Group containing the specified Property.
getGroupForProperty(Property<?>) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getGroupName() - Method in class org.yarnandtail.andhow.internal.PropertyCoord
The canonical name of the group, or some form of [[Unknown]] if it is null.
getGroups() - Method in class org.yarnandtail.andhow.service.PropertyRegistrarLoader
Returns a newly created list of GroupProxys.
getHandlers() - Method in class org.yarnandtail.andhow.util.AndHowLog
 
getHelpText() - Method in interface org.yarnandtail.andhow.api.Property
Additional help information for this Property that will be included in configuration documentation.
getHelpText() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getInAliases() - Method in interface org.yarnandtail.andhow.api.Property
All the effective 'in' aliases for this property, not including the canonical name.
getInAliases() - Method in class org.yarnandtail.andhow.api.PropertyNaming
A list of the in-type aliases.
getInAliaseString(PropertyConfigurationInternal, EffectiveName) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
getInAliaseString(PropertyConfigurationInternal, EffectiveName) - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getInAliaseString(PropertyConfigurationInternal, EffectiveName) - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getInitializationTrace() - Static method in class org.yarnandtail.andhow.AndHow
Get the stacktrace of where AndHow was initialized.
getInitInstances() - Method in class org.yarnandtail.andhow.service.InitLoader
Returns all the AndHowInit instances found by the service loader.
getInitInstances() - Method in class org.yarnandtail.andhow.service.TestInitLoader
Returns all the AndHowInit instances found by the service loader.
getInnerPath() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The names of the nested inner classes/interfaces containing the named property for this registration.
getInnerPathLength() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The number of nested inner classes / interfaces from the root class to the inner class containing the AndHow Property.
getInstanceConfig() - Method in interface org.yarnandtail.andhow.api.Loader
A list of properties that the user has specified as being configuration properties for this Loader.
getInstanceConfig() - Method in class org.yarnandtail.andhow.load.BaseLoader
 
getInstanceConfig() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
getInstanceNames() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.TooManyAndHowInitInstances
 
getInvalidMessage(T) - Method in interface org.yarnandtail.andhow.api.Validator
If the value is not valid, this will create a user message explaining why the value is not valid.
getInvalidMessage() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InvalidDefaultValue
 
getInvalidSpecificationMessage() - Method in interface org.yarnandtail.andhow.api.Validator
If the specification itself is invalid (such as a bad regex string), this will build a message describing the problem to the user.
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.BigDecValidator
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.DblValidator
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.IntValidator
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.LngValidator
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.StringValidator.EndsWith
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOf
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOfIgnoringCase
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.StringValidator.Regex
 
getInvalidSpecificationMessage() - Method in class org.yarnandtail.andhow.valid.StringValidator.StartsWith
 
getJavaCanonicalName() - Method in interface org.yarnandtail.andhow.api.GroupProxy
Returns the Java canonical name of the class this group is proxying.
getJavaCanonicalName() - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
getJavaCanonicalParentName() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The Java canonical name of the direct parent of the AndHow Property.
getJavaName(String, String[]) - Static method in class org.yarnandtail.andhow.util.NameUtil
The Java canonical name of the direct parent of the AndHow Property.
getJavaName(String, List<String>) - Static method in class org.yarnandtail.andhow.util.NameUtil
The Java canonical name of the direct parent of the AndHow Property.
getJavaName(Class<?>) - Static method in class org.yarnandtail.andhow.util.NameUtil
The Java style name for a class, usable with Class.forName().
getLine(int) - Method in class org.yarnandtail.andhow.sample.TextBlock
Return a single TextLine
getLine(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
getLine(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.HRLine
 
getLine(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.StringLine
 
getLineComment(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
getLineComment(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.HRLine
 
getLineComment(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.StringLine
 
getLines() - Method in class org.yarnandtail.andhow.sample.TextBlock
Return all the TextLines in this block.
getLoader() - Method in class org.yarnandtail.andhow.api.LoaderValues
 
getLoader() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.DuplicateLoader
 
getLoader() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyIsNull
 
getLoader() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyNotRegistered
 
getLoader() - Method in class org.yarnandtail.andhow.internal.LoaderValueCoord
The loader attempting to load this property, if that can be determined.
getLoaderDialect() - Method in interface org.yarnandtail.andhow.api.Loader
The type dialect of the loader.
getLoaderDialect() - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
getLoaderDialect() - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
getLoaderDialect() - Method in class org.yarnandtail.andhow.load.MapLoader
 
getLoaderDialect() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
getLoaderDialect() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
getLoaderType() - Method in interface org.yarnandtail.andhow.api.Loader
The type of the loader, such as JNDI, PropertyFile, SystemProperty, etc..
getLoaderType() - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
getLoaderType() - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
getLoaderType() - Method in class org.yarnandtail.andhow.load.MapLoader
 
getLoaderType() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
getLoaderType() - Method in class org.yarnandtail.andhow.load.std.StdEnvVarLoader
 
getLoaderType() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
getLoaderType() - Method in class org.yarnandtail.andhow.load.std.StdSysPropLoader
 
getLogger(Class<?>) - Static method in class org.yarnandtail.andhow.util.AndHowLog
 
getLogger(Class<?>, Handler) - Static method in class org.yarnandtail.andhow.util.AndHowLog
 
getMap() - Method in class org.yarnandtail.andhow.load.MapLoader
 
getMap() - Method in class org.yarnandtail.andhow.load.std.StdEnvVarLoader
 
getMap() - Method in class org.yarnandtail.andhow.load.std.StdSysPropLoader
 
getName() - Method in class org.yarnandtail.andhow.load.KeyObjectPair
The KeyObjectPair name, which has been trimmed to remove leading and trailing spaces.
getName() - Method in class org.yarnandtail.andhow.load.KVP
 
getNameMatchingDescription() - Method in interface org.yarnandtail.andhow.api.NamingStrategy
Returns a description of how names are matched for use in samples and documentation.
getNameMatchingDescription() - Method in class org.yarnandtail.andhow.name.CaseInsensitiveNaming
 
getNamingStrategy() - Method in class org.yarnandtail.andhow.AndHow
 
getNamingStrategy() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Return the naming strategy used to form Property names, match them to values and display them.
getNamingStrategy() - Method in interface org.yarnandtail.andhow.api.PropertyConfiguration
Defines how names are created for Properties.
getNamingStrategy() - Method in class org.yarnandtail.andhow.BaseConfig
 
getNamingStrategy() - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getNamingStrategy() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getNamingStrategy() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getNonErrStream() - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Returns the PrintStream used for non-error level logging (java.util.logging WARNING and lower).
getOriginalInit() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InitiationLoopException
 
getOutAliases() - Method in interface org.yarnandtail.andhow.api.Property
All the 'out' aliases for this property, not including the canonical name.
getOutAliases() - Method in class org.yarnandtail.andhow.api.PropertyNaming
A list of the out-type aliases.
getOutAliasOption() - Method in interface org.yarnandtail.andhow.export.PropertyExport
Option read from the containing ManualExportAllowed annotation to determine if 'out' aliases of the Property should be included.
getOutAliasOption() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getOutAliasOption() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getProblemContext() - Method in interface org.yarnandtail.andhow.api.Problem
The context for the problem, for the user.
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.DuplicateLoader
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.ExportException
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyIsNull
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyNotRegistered
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.SecurityException
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.LoaderProblem
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.RequirementProblem.NonNullPropertyProblem
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.RequirementProblem.RequiredPropertyGroupProblem
 
getProblemContext() - Method in class org.yarnandtail.andhow.internal.ValueProblem
 
getProblemDescription() - Method in interface org.yarnandtail.andhow.api.Problem
The problem description, for the user.
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.DuplicateLoader
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.DuplicateProperty
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.ExportException
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InitiationLoopException
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InvalidDefaultValue
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InvalidValidationConfiguration
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyIsNull
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyNotRegistered
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.NonUniqueNames
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.PropertyNotPartOfGroup
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.SecurityException
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.TooManyAndHowInitInstances
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.DuplicatePropertyLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.IOLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.JndiContextLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.ObjectConversionValueProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.ParsingLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.SourceNotFoundLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.StringConversionLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.UnknownPropertyLoaderProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.RequirementProblem.NonNullPropertyProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.RequirementProblem.RequiredPropertyGroupProblem
 
getProblemDescription() - Method in class org.yarnandtail.andhow.internal.ValueProblem.InvalidValueProblem
 
getProblems() - Method in exception org.yarnandtail.andhow.api.AppFatalException
 
getProblems() - Method in class org.yarnandtail.andhow.api.LoaderValues
Returns loader and value problems, if any.
getProblems() - Method in class org.yarnandtail.andhow.api.ValidatedValue
Returns an unmodifiable list of Problems.
getProblemText() - Method in exception org.yarnandtail.andhow.api.ParsingException
 
getProperties() - Method in interface org.yarnandtail.andhow.api.GroupProxy
Returns a complete list of all AndHow Properties in this group.
getProperties() - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
getProperties() - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getProperties() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getProperties() - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
Returns a complete list of all registered properties.
getProperties() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getProperties(Class<?>) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
Builds a list of all Properties and their field names contained in the passed class.
getPropertiesForGroup(GroupProxy) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getPropertiesForGroup(GroupProxy) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getPropertiesForGroup(GroupProxy) - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
Returns a list of Properties registered in the passed group.
getPropertiesForGroup(GroupProxy) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getProperty() - Method in class org.yarnandtail.andhow.api.ValidatedValue
 
getProperty() - Method in interface org.yarnandtail.andhow.export.PropertyExport
The Property being exported.
getProperty(String) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getProperty() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyNotRegistered
 
getProperty() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getProperty() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getProperty(String) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getProperty(String) - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
Finds a registered property by any recognized classpath style name, including the canonical name or 'in' aliases.
getProperty(String) - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getProperty() - Method in class org.yarnandtail.andhow.internal.PropertyCoord
The property, if that can be determined.
getProperty() - Method in class org.yarnandtail.andhow.PropertyValue
Fetch the Property of this Property/Value pair.
getPropertyCoord() - Method in class org.yarnandtail.andhow.internal.RequirementProblem
The required property that has not been given a value.
getPropertyGroups() - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getPropertyGroups() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
getPropertyGroups() - Method in interface org.yarnandtail.andhow.internal.PropertyConfigurationInternal
Returns a list of all registered groups.
getPropertyGroups() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
getPropertyName() - Method in class org.yarnandtail.andhow.service.PropertyRegistration
The name of the AndHow property, which is the name of the variable it is assigned to where it is constructed.
getPropertyRegistrars() - Method in class org.yarnandtail.andhow.service.PropertyRegistrarLoader
Returns a newly created list of PropertyRegistrars.
getPropertyType() - Method in interface org.yarnandtail.andhow.api.Property
The basic type of the property: Flag, name/value, multi=value.
getPropertyType() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getPropName() - Method in class org.yarnandtail.andhow.internal.PropertyCoord
The canonical name of the Property, or one of a series of placeholder names if the value can't be determined.
getProxiedGroup() - Method in interface org.yarnandtail.andhow.api.GroupProxy
The proxied class or interface containing Properties that this proxy wraps.
getProxiedGroup() - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
getRefPropertyCoord() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem
For Properties that have some type of duplication w/ other properties, this is the Property that is duplicated (the earlier of the two duplicates).
getRegisteredGroups() - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Return a custom list of 'Groups' (classes or interfaces containing AndHow Properties) to use instead of allowing the auto-discovery to find the Groups.
getRegisteredGroups() - Method in class org.yarnandtail.andhow.BaseConfig
 
getRegistrationList() - Method in class org.yarnandtail.andhow.service.AbstractPropertyRegistrar
 
getRegistrationList() - Method in interface org.yarnandtail.andhow.service.PropertyRegistrar
Get the list if individual Property registrations.
getRequestedAliases() - Method in interface org.yarnandtail.andhow.api.Property
'In' & 'Out' aliases requested when this Property was constructed.
getRequestedAliases() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getResourceAsString(String, Charset) - Static method in class org.yarnandtail.andhow.util.IOUtil
Retrieve a String from a classpath resource.
getRootCanonicalName() - Method in interface org.yarnandtail.andhow.service.PropertyRegistrar
The Java canonical name of a root class containing AndHow Properties.
getRootCanonicalName() - Method in class org.yarnandtail.andhow.service.PropertyRegistrationList
The root / top level class which contains (either directly or indirectly) the properties listed within it.
getSampleDirectory() - Method in exception org.yarnandtail.andhow.api.AppFatalException
 
getSampleFileEnd() - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
getSampleFileEnd() - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getSampleFileEnd() - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getSampleFileExtension() - Method in interface org.yarnandtail.andhow.api.SamplePrinter
The file extention to use for sample files, eg 'properties' or 'xml'.
getSampleFileExtension() - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getSampleFileExtension() - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getSampleFileStart() - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
getSampleFileStart() - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getSampleFileStart() - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getSampleStartComment(PropertyConfigurationInternal) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
Must provide its own line comment prefix if the format has no block comment.
getSampleStartComment(PropertyConfigurationInternal) - Method in class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 
getSampleStartComment(PropertyConfigurationInternal) - Method in class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
getSecondInit() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InitiationLoopException
 
getSimpleName(Property<?>) - Method in interface org.yarnandtail.andhow.api.GroupProxy
The simple name of a Property in this Group.
getSimpleName(Property<?>) - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
getSpecificLoadDescription() - Method in interface org.yarnandtail.andhow.api.Loader
For this particular load, where was info loaded from? This may vary from run to run based on config params.
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.MapLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.PropFileOnClasspathLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.PropFileOnFilesystemLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.std.StdEnvVarLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.std.StdMainStringArgsLoader
 
getSpecificLoadDescription() - Method in class org.yarnandtail.andhow.load.std.StdSysPropLoader
 
getStackTrace() - Method in class org.yarnandtail.andhow.AndHow.Initialization
 
getTheValueMustDescription() - Method in interface org.yarnandtail.andhow.api.Validator
Get a description of the validation rule.
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.BigDecValidator.GreaterThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.BigDecValidator.GreaterThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.BigDecValidator.LessThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.BigDecValidator.LessThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.DblValidator.GreaterThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.DblValidator.GreaterThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.DblValidator.LessThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.DblValidator.LessThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.IntValidator.GreaterThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.IntValidator.GreaterThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.IntValidator.LessThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.IntValidator.LessThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LngValidator.GreaterThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LngValidator.GreaterThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LngValidator.LessThan
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LngValidator.LessThanOrEqualTo
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.After
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.Before
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.SameTimeOrAfter
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.SameTimeOrBefore
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.StringValidator.EndsWith
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOf
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOfIgnoringCase
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.StringValidator.Regex
 
getTheValueMustDescription() - Method in class org.yarnandtail.andhow.valid.StringValidator.StartsWith
 
getTimeStamp() - Method in class org.yarnandtail.andhow.AndHow.Initialization
 
getTrimmer() - Method in interface org.yarnandtail.andhow.api.Property
The Trimmer responsible for trimming String values before they are converted to the appropriate property type.
getTrimmer() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getUnknownPropertyName() - Method in class org.yarnandtail.andhow.internal.LoaderProblem.UnknownPropertyLoaderProblem
 
getUriName(String) - Method in interface org.yarnandtail.andhow.api.NamingStrategy
Converts a standard classpath style property name to a URI based one.
getUTF8ResourceAsString(String) - Static method in class org.yarnandtail.andhow.util.IOUtil
Retrieve a String from an UTF-8 encoded classpath resource.
getValidator() - Method in class org.yarnandtail.andhow.internal.ConstructionProblem.InvalidValidationConfiguration
 
getValidators() - Method in interface org.yarnandtail.andhow.api.Property
List of validators to validate the converted value.
getValidators() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getValue(Property<T>) - Method in class org.yarnandtail.andhow.AndHow
 
getValue(Property<T>) - Method in class org.yarnandtail.andhow.api.LoaderValues
 
getValue() - Method in interface org.yarnandtail.andhow.api.Property
Returns the effective value of this property.
getValue() - Method in class org.yarnandtail.andhow.api.ValidatedValue
 
getValue(Property<T>) - Method in interface org.yarnandtail.andhow.api.ValidatedValues
The effective value, similar to Property.getValue, but specifically for the context of this ValueMap.
getValue() - Method in interface org.yarnandtail.andhow.export.PropertyExport
Fetch the Object value of the Property, e.g., an Integer Property will return an Integer.
getValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
getValue() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getValue() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesImmutable
 
getValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getValue(Property<T>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getValue() - Method in class org.yarnandtail.andhow.load.KeyObjectPair
The value exactly as passed in the constructor, which may be null.
getValue() - Method in class org.yarnandtail.andhow.load.KVP
 
getValue() - Method in class org.yarnandtail.andhow.property.FlagProp
 
getValue() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getValue() - Method in class org.yarnandtail.andhow.PropertyValue
Fetch the Value of this Property/Value pair.
getValueAsString() - Method in interface org.yarnandtail.andhow.api.Property
Converts the effective value of the Property to a String.
getValueAsString() - Method in interface org.yarnandtail.andhow.export.PropertyExport
Fetch the value as a String from the Property.
getValueAsString() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
getValueAsString() - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
getValueMapImmutable() - Method in interface org.yarnandtail.andhow.api.ValidatedValuesWithContext
Unmodifiable minimum data for Properties to retrieve their data from.
getValueMapImmutable() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getValueMapImmutable() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getValueMapWithContextImmutable() - Method in interface org.yarnandtail.andhow.api.ValidatedValuesWithContext
Unmodifiable minimum data collection to store the structure of how data was loaded.
getValueMapWithContextImmutable() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
getValueMapWithContextImmutable() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
getValues() - Method in class org.yarnandtail.andhow.api.LoaderValues
 
getValueType() - Method in interface org.yarnandtail.andhow.api.Property
The type of the value (String, Number, Integer, etc).
getValueType() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
getWrappedBlockComment(PrintFormat, boolean, boolean) - Method in class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
getWrappedBlockComment(PrintFormat, boolean, boolean) - Method in class org.yarnandtail.andhow.sample.TextLine.HRLine
 
getWrappedBlockComment(PrintFormat, boolean, boolean) - Method in class org.yarnandtail.andhow.sample.TextLine.StringLine
 
getWrappedLine(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
getWrappedLine(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.HRLine
 
getWrappedLine(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.StringLine
 
getWrappedLineComment(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.BlankLine
 
getWrappedLineComment(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.HRLine
 
getWrappedLineComment(PrintFormat) - Method in class org.yarnandtail.andhow.sample.TextLine.StringLine
 
greaterThan(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
The property must be greater than the reference
greaterThan(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
 
greaterThan(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
 
greaterThan(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
 
GreaterThan(BigDecimal) - Constructor for class org.yarnandtail.andhow.valid.BigDecValidator.GreaterThan
Construct a GreaterThan property constraint
GreaterThan(double) - Constructor for class org.yarnandtail.andhow.valid.DblValidator.GreaterThan
 
GreaterThan(int) - Constructor for class org.yarnandtail.andhow.valid.IntValidator.GreaterThan
 
GreaterThan(long) - Constructor for class org.yarnandtail.andhow.valid.LngValidator.GreaterThan
 
greaterThanOrEqualTo(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
The property must be greater than or equal to the reference
greaterThanOrEqualTo(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
 
greaterThanOrEqualTo(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
 
greaterThanOrEqualTo(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
 
GreaterThanOrEqualTo(BigDecimal) - Constructor for class org.yarnandtail.andhow.valid.BigDecValidator.GreaterThanOrEqualTo
Construct a GreaterThanOrEqualTo property constraint
GreaterThanOrEqualTo(double) - Constructor for class org.yarnandtail.andhow.valid.DblValidator.GreaterThanOrEqualTo
 
GreaterThanOrEqualTo(int) - Constructor for class org.yarnandtail.andhow.valid.IntValidator.GreaterThanOrEqualTo
 
GreaterThanOrEqualTo(long) - Constructor for class org.yarnandtail.andhow.valid.LngValidator.GreaterThanOrEqualTo
 
GroupExport - Annotation Type in org.yarnandtail.andhow
Causes all the Properties in the annotated class to be exported by the specified Exporter.
GroupExport.List - Annotation Type in org.yarnandtail.andhow
Required container for Repeatable annotations.
GroupInfo - Annotation Type in org.yarnandtail.andhow
Annotation to allow users to include documentation on PropertyGroups.
GroupProxy - Interface in org.yarnandtail.andhow.api
A GroupProxy is generated as a proxy for any class containing AndHow Properties.
GroupProxyBase - Class in org.yarnandtail.andhow.api
 
GroupProxyBase(String, String) - Constructor for class org.yarnandtail.andhow.api.GroupProxyBase
Constructs a new instance w/ final unmodifiable fields.
GroupProxyBase(String, String, List<NameAndProperty>, boolean) - Constructor for class org.yarnandtail.andhow.api.GroupProxyBase
 
GroupProxyImmutable - Class in org.yarnandtail.andhow.api
A non-modifiable GroupProxy.
GroupProxyImmutable(String, String, List<NameAndProperty>, boolean) - Constructor for class org.yarnandtail.andhow.api.GroupProxyImmutable
Constructs a new instance w/ final unmodifiable fields.
GroupProxyMutable - Class in org.yarnandtail.andhow.api
A modifiable GroupProxy.
GroupProxyMutable(String, String) - Constructor for class org.yarnandtail.andhow.api.GroupProxyMutable
Constructs a new instance w/ final unmodifiable fields.

H

hasConfig() - Method in class org.yarnandtail.andhow.service.InitLoader
Returns true if there are any AndHowInit instances available from the loader, even if more than one.
hasConfig() - Method in class org.yarnandtail.andhow.service.TestInitLoader
Returns true if there are any AndHowInit instances available from the loader, even if more than one.
hashCode() - Method in class org.yarnandtail.andhow.PropertyValue
 
hasOutAlias(Property<?>, PropertyConfigurationInternal) - Method in class org.yarnandtail.andhow.export.BaseExporter
 
hasProblems() - Method in class org.yarnandtail.andhow.api.ValidatedValue
 
hasProblems() - Method in interface org.yarnandtail.andhow.api.ValidatedValuesWithContext
Returns true if any value or loader has any sort of issue (invalid value, parsing error, etc).
hasProblems() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
hasProblems() - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
helpText(String) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
hr - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
HRLine() - Constructor for class org.yarnandtail.andhow.sample.TextLine.HRLine
 

I

ILLEGAL_PROPERTY_NAME_CHARS - Static variable in class org.yarnandtail.andhow.api.Name
These characters are not allowed in Property names because they may collide with characters allowed in various formats, in particular, uri style JNDI names or property files conventions.
includeCanonical - Variable in class org.yarnandtail.andhow.export.BaseExporter
 
includeOutAlias - Variable in class org.yarnandtail.andhow.export.BaseExporter
 
info(String) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
info(String, Object...) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
info(String, Throwable) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
Initialization(AndHowConfiguration<? extends AndHowConfiguration>) - Constructor for class org.yarnandtail.andhow.AndHow.Initialization
 
InitiationLoopException(AndHow.Initialization, AndHow.Initialization) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.InitiationLoopException
 
InitLoader - Class in org.yarnandtail.andhow.service
Dedicated wrapper for a java.util.ServiceLoader that loads InitLoader instances.
InitLoader() - Constructor for class org.yarnandtail.andhow.service.InitLoader
 
InitLoader(ClassLoader) - Constructor for class org.yarnandtail.andhow.service.InitLoader
 
insertAfter - Variable in class org.yarnandtail.andhow.BaseConfig
 
insertBefore - Variable in class org.yarnandtail.andhow.BaseConfig
 
insertLoaderAfter(Class<? extends StandardLoader>, Loader) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
 
insertLoaderAfter(Class<? extends StandardLoader>, Loader) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
insertLoaderBefore(Class<? extends StandardLoader>, Loader) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
 
insertLoaderBefore(Class<? extends StandardLoader>, Loader) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
instance() - Static method in class org.yarnandtail.andhow.AndHow
Returns the singleton instance of AndHow, initializing a new instance if one doesn't exist.
instance(AndHowConfiguration) - Static method in class org.yarnandtail.andhow.AndHow
Deprecated.
See notes on AndHow.findConfig().
instance - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
instance() - Static method in class org.yarnandtail.andhow.property.QuotedSpacePreservingTrimmer
 
instance() - Static method in class org.yarnandtail.andhow.property.TrimToNullTrimmer
 
instance() - Static method in class org.yarnandtail.andhow.StdConfig
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.BigDecType
Construct an instance of BigDecType
instance() - Static method in class org.yarnandtail.andhow.valuetype.BolType
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.DblType
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.FlagType
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.IntType
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.LngType
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.LocalDateTimeType
 
instance() - Static method in class org.yarnandtail.andhow.valuetype.StrType
 
IntBuilder() - Constructor for class org.yarnandtail.andhow.property.IntProp.IntBuilder
 
IntProp - Class in org.yarnandtail.andhow.property
A Property that refers to an Integer value.
IntProp(Integer, boolean, String, List<Validator<Integer>>, List<Name>, PropertyType, ValueType<Integer>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.IntProp
 
IntProp.IntBuilder - Class in org.yarnandtail.andhow.property
 
IntType - Class in org.yarnandtail.andhow.valuetype
Type representation of Java Integer objects.
IntValidator - Class in org.yarnandtail.andhow.valid
A collection of String validation types
IntValidator() - Constructor for class org.yarnandtail.andhow.valid.IntValidator
 
IntValidator.GreaterThan - Class in org.yarnandtail.andhow.valid
Validate that an integer is greater than a reference value.
IntValidator.GreaterThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that an integer is greater than or equal to a reference value.
IntValidator.LessThan - Class in org.yarnandtail.andhow.valid
Validate that an integer is less than a reference value.
IntValidator.LessThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that an integer is less than or equal to a reference value.
InvalidDefaultValue(GroupProxy, Property<?>, String) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.InvalidDefaultValue
 
InvalidValidationConfiguration(GroupProxy, Property<?>, Validator<?>) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.InvalidValidationConfiguration
 
InvalidValueProblem(Loader, Class<?>, Property<T>, T, Validator<T>) - Constructor for class org.yarnandtail.andhow.internal.ValueProblem.InvalidValueProblem
 
IOLoaderProblem(Loader, Exception, String) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.IOLoaderProblem
 
IOUtil - Class in org.yarnandtail.andhow.util
Utility class to handle some IO purposes.
isAccumulate() - Method in enum org.yarnandtail.andhow.api.PropertyType
 
isBlankLineAfter() - Method in class org.yarnandtail.andhow.sample.TextBlock
Should a blank line be printed after this block?
isBlankLineBefore() - Method in class org.yarnandtail.andhow.sample.TextBlock
Should a blank line be printed before this block?
isComment() - Method in class org.yarnandtail.andhow.sample.TextBlock
Should the text in this block be printed as a comment?
isExplicitlySet(Property<?>) - Method in class org.yarnandtail.andhow.AndHow
 
isExplicitlySet(Property<?>) - Method in class org.yarnandtail.andhow.api.LoaderValues
A linear search for the Property in the values loaded by this loader.
isExplicitlySet() - Method in interface org.yarnandtail.andhow.api.Property
True if the Property's value is explicitly set to a non-null value via one of the loaders.
isExplicitlySet(Property<?>) - Method in interface org.yarnandtail.andhow.api.ValidatedValues
True if the Property's value is explicitly set to a non-null value via one of the loaders.
isExplicitlySet(Property<?>) - Method in class org.yarnandtail.andhow.internal.AndHowCore
 
isExplicitlySet(Property<?>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesImmutable
 
isExplicitlySet(Property<?>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
isExplicitlySet(Property<?>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
isFailedEnvironmentAProblem() - Method in interface org.yarnandtail.andhow.api.LookupLoader
If true, then a failure to initiate or connect to the needed environment or external system will result in a failure and it will register a 'Propblem' during load which will cause application initiation to stop.
isFailedEnvironmentAProblem() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
isFlag() - Method in enum org.yarnandtail.andhow.api.PropertyType
 
isIn() - Method in class org.yarnandtail.andhow.api.Name
If true, this name is recognized when reading a property from a configuration source.
isInitialize() - Static method in class org.yarnandtail.andhow.AndHow
Deprecated.
This method name was typod. Please use isInitialized() instead.
isInitialized() - Static method in class org.yarnandtail.andhow.AndHow
Determine if AndHow is initialized or not w/out forcing AndHow to load.
isLoggable(Level) - Method in class org.yarnandtail.andhow.util.AndHowLog
Check if a message of the given level would actually be logged by this logger.
isManualExportDisallowed(Class<?>) - Method in class org.yarnandtail.andhow.internal.export.ManualExportService
Returns true if manual export is explicitly annotated to not be allowed on this class.
isMissingFileAProblem() - Method in interface org.yarnandtail.andhow.api.LocalFileLoader
If true, a loader that loads from a file will report a Problem that will stop application startup if it cannot find the configured file.
isMissingFileAProblem() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
isMultipleOk() - Method in enum org.yarnandtail.andhow.api.PropertyType
 
isNonNullRequired() - Method in interface org.yarnandtail.andhow.api.Property
If true, the effective value must be non-null to be considered valid.
isNonNullRequired() - Method in class org.yarnandtail.andhow.property.PropertyBase
 
isNotReal() - Method in enum org.yarnandtail.andhow.api.PropertyType
 
isOut() - Method in class org.yarnandtail.andhow.api.Name
If true, this name is used when exporting properties to some other system.
isParsable(String) - Method in interface org.yarnandtail.andhow.api.ValueType
Returns true if the string can safely be parsed into the destination type by the parse() method.
isParsable(String) - Method in class org.yarnandtail.andhow.valuetype.BaseValueType
 
isPropertyPresent(List<LoaderValues>, Property<?>) - Method in class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
 
isReal() - Method in enum org.yarnandtail.andhow.api.PropertyType
 
isSpecificationValid() - Method in interface org.yarnandtail.andhow.api.Validator
Returns true if the validation criteria itself is valid.
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.BigDecValidator
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.DblValidator
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.IntValidator
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.LngValidator
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.StringValidator.EndsWith
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOf
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOfIgnoringCase
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.StringValidator.Regex
 
isSpecificationValid() - Method in class org.yarnandtail.andhow.valid.StringValidator.StartsWith
 
isTrimmingRequiredForStringValues() - Method in interface org.yarnandtail.andhow.api.Loader
If true, values for string properties are trimmed by the Trimmer of the property they are associated with.
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.MapLoader
 
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.std.StdEnvVarLoader
 
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
isTrimmingRequiredForStringValues() - Method in class org.yarnandtail.andhow.load.std.StdSysPropLoader
 
isUnknownPropertyAProblem() - Method in interface org.yarnandtail.andhow.api.ReadLoader
If true, an unrecognized name is considered a problem that will stop application startup.
isUnknownPropertyAProblem() - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
isUnknownPropertyAProblem() - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
isUnknownPropertyAProblem() - Method in class org.yarnandtail.andhow.load.MapLoader
 
isUnknownPropertyAProblem() - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
isUriNameDistinct(String) - Method in interface org.yarnandtail.andhow.api.NamingStrategy
Returns true if the Uri version of the passed name would be a disctict name from the passed name.
isUserGroup() - Method in interface org.yarnandtail.andhow.api.GroupProxy
Returns true if this is a group created for user properties, which is the typical case.
isUserGroup() - Method in class org.yarnandtail.andhow.api.GroupProxyBase
 
isValid(T) - Method in interface org.yarnandtail.andhow.api.Validator
 
isValid(BigDecimal) - Method in class org.yarnandtail.andhow.valid.BigDecValidator.GreaterThan
 
isValid(BigDecimal) - Method in class org.yarnandtail.andhow.valid.BigDecValidator.GreaterThanOrEqualTo
 
isValid(BigDecimal) - Method in class org.yarnandtail.andhow.valid.BigDecValidator.LessThan
 
isValid(BigDecimal) - Method in class org.yarnandtail.andhow.valid.BigDecValidator.LessThanOrEqualTo
 
isValid(Double) - Method in class org.yarnandtail.andhow.valid.DblValidator.GreaterThan
 
isValid(Double) - Method in class org.yarnandtail.andhow.valid.DblValidator.GreaterThanOrEqualTo
 
isValid(Double) - Method in class org.yarnandtail.andhow.valid.DblValidator.LessThan
 
isValid(Double) - Method in class org.yarnandtail.andhow.valid.DblValidator.LessThanOrEqualTo
 
isValid(Integer) - Method in class org.yarnandtail.andhow.valid.IntValidator.GreaterThan
 
isValid(Integer) - Method in class org.yarnandtail.andhow.valid.IntValidator.GreaterThanOrEqualTo
 
isValid(Integer) - Method in class org.yarnandtail.andhow.valid.IntValidator.LessThan
 
isValid(Integer) - Method in class org.yarnandtail.andhow.valid.IntValidator.LessThanOrEqualTo
 
isValid(Long) - Method in class org.yarnandtail.andhow.valid.LngValidator.GreaterThan
 
isValid(Long) - Method in class org.yarnandtail.andhow.valid.LngValidator.GreaterThanOrEqualTo
 
isValid(Long) - Method in class org.yarnandtail.andhow.valid.LngValidator.LessThan
 
isValid(Long) - Method in class org.yarnandtail.andhow.valid.LngValidator.LessThanOrEqualTo
 
isValid(LocalDateTime) - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.After
 
isValid(LocalDateTime) - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.Before
 
isValid(LocalDateTime) - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.SameTimeOrAfter
 
isValid(LocalDateTime) - Method in class org.yarnandtail.andhow.valid.LocalDateTimeValidator.SameTimeOrBefore
 
isValid(String) - Method in class org.yarnandtail.andhow.valid.StringValidator.EndsWith
 
isValid(String) - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOf
 
isValid(String) - Method in class org.yarnandtail.andhow.valid.StringValidator.OneOfIgnoringCase
 
isValid(String) - Method in class org.yarnandtail.andhow.valid.StringValidator.Regex
 
isValid(String) - Method in class org.yarnandtail.andhow.valid.StringValidator.StartsWith
 
isValidPropertyName(String) - Static method in class org.yarnandtail.andhow.api.Name
Returns true if the name contains no special characters, as defined in ILLEGAL_PROPERTY_NAME_CHARS.
isValidState() - Method in class org.yarnandtail.andhow.service.InitLoader
Returns true if there are no more than 1 production init and 1 test init.
isValidState() - Method in class org.yarnandtail.andhow.service.TestInitLoader
Returns true if there are no more than 1 production init and 1 test init.
isWrap() - Method in class org.yarnandtail.andhow.sample.TextBlock
Should lines in this block be wrapped to the max column width?
iterator() - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 

J

JndiContextLoaderProblem(Loader) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.JndiContextLoaderProblem
 
JndiFileFormat - Class in org.yarnandtail.andhow.sample
PrintFormat implementation specifically for property files.
JndiFileFormat() - Constructor for class org.yarnandtail.andhow.sample.JndiFileFormat
Constructor that initializes all needed values to be a properties file.
JndiLoaderSamplePrinter - Class in org.yarnandtail.andhow.sample
 
JndiLoaderSamplePrinter() - Constructor for class org.yarnandtail.andhow.sample.JndiLoaderSamplePrinter
 

K

KeyObjectPair - Class in org.yarnandtail.andhow.load
Key-Object Pair Contains a String name and an Object value.
KeyObjectPair(String) - Constructor for class org.yarnandtail.andhow.load.KeyObjectPair
Construct an instance with a null value.
KeyObjectPair(String, Object) - Constructor for class org.yarnandtail.andhow.load.KeyObjectPair
New instance with name and value.
keyObjectPairValues - Variable in class org.yarnandtail.andhow.load.FixedValueLoader
 
KeyValuePairLoader - Class in org.yarnandtail.andhow.load
Intended to reads properties from the command line, but could be used for other sources where properties can be passed as an array of strings, each of the form name=value.
KeyValuePairLoader() - Constructor for class org.yarnandtail.andhow.load.KeyValuePairLoader
 
killStream(PrintStream) - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Kills a PrintStream, first ensuring that it is not currently assigned to System.out or System.err.
KVP - Class in org.yarnandtail.andhow.load
Key-value pair
KVP(String) - Constructor for class org.yarnandtail.andhow.load.KVP
 
KVP(String, String) - Constructor for class org.yarnandtail.andhow.load.KVP
 
KVP_DELIMITER - Static variable in class org.yarnandtail.andhow.load.KeyValuePairLoader
The default delimiter between a key and a value.

L

lessThan(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
The property must be less than the reference
lessThan(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
 
lessThan(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
 
lessThan(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
 
LessThan(BigDecimal) - Constructor for class org.yarnandtail.andhow.valid.BigDecValidator.LessThan
Construct a LessThan property constraint
LessThan(double) - Constructor for class org.yarnandtail.andhow.valid.DblValidator.LessThan
 
LessThan(int) - Constructor for class org.yarnandtail.andhow.valid.IntValidator.LessThan
 
LessThan(long) - Constructor for class org.yarnandtail.andhow.valid.LngValidator.LessThan
 
lessThanOrEqualTo(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
The property must be less than or equal to the reference
lessThanOrEqualTo(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
 
lessThanOrEqualTo(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
 
lessThanOrEqualTo(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
 
LessThanOrEqualTo(BigDecimal) - Constructor for class org.yarnandtail.andhow.valid.BigDecValidator.LessThanOrEqualTo
Construct a LessThanOrEqualTo property constraint
LessThanOrEqualTo(double) - Constructor for class org.yarnandtail.andhow.valid.DblValidator.LessThanOrEqualTo
 
LessThanOrEqualTo(int) - Constructor for class org.yarnandtail.andhow.valid.IntValidator.LessThanOrEqualTo
 
LessThanOrEqualTo(long) - Constructor for class org.yarnandtail.andhow.valid.LngValidator.LessThanOrEqualTo
 
lineCommentPrefix - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
lineCommentPrefixSeparator - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
lineWidth - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
listIterator() - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
listIterator(int) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
LngBuilder() - Constructor for class org.yarnandtail.andhow.property.LngProp.LngBuilder
 
LngProp - Class in org.yarnandtail.andhow.property
A Property that refers to a Long value.
LngProp(Long, boolean, String, List<Validator<Long>>, List<Name>, PropertyType, ValueType<Long>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.LngProp
 
LngProp.LngBuilder - Class in org.yarnandtail.andhow.property
 
LngType - Class in org.yarnandtail.andhow.valuetype
Type representation of Java Long objects.
LngValidator - Class in org.yarnandtail.andhow.valid
A collection of Long validation types
LngValidator() - Constructor for class org.yarnandtail.andhow.valid.LngValidator
 
LngValidator.GreaterThan - Class in org.yarnandtail.andhow.valid
Validate that a long is greater than a specified reference.
LngValidator.GreaterThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that an long is greater than or equal to a specified reference.
LngValidator.LessThan - Class in org.yarnandtail.andhow.valid
Validate that an long is less than a specified reference.
LngValidator.LessThanOrEqualTo - Class in org.yarnandtail.andhow.valid
Validate that a long is less than or equal to a specified reference.
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in interface org.yarnandtail.andhow.api.Loader
Builds up a list of LoaderValues by loading property values from a configuration source.
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.MapLoader
 
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.PropFileOnClasspathLoader
 
load(PropertyConfigurationInternal, ValidatedValuesWithContext, String) - Method in class org.yarnandtail.andhow.load.PropFileOnClasspathLoader
Load from a non-null classpathProp path.
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.PropFileOnFilesystemLoader
 
load(PropertyConfigurationInternal, ValidatedValuesWithContext, String) - Method in class org.yarnandtail.andhow.load.PropFileOnFilesystemLoader
 
load(PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
Loader - Interface in org.yarnandtail.andhow.api
Each instance is responsible for loading values from a particular type of source.
LoaderProblem - Class in org.yarnandtail.andhow.internal
A problem bootstrapping the AndHow, prior to attempting to load any values.
LoaderProblem() - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem
 
LoaderProblem.DuplicatePropertyLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.IOLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.JndiContextLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.ObjectConversionValueProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.ParsingLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.SourceNotFoundLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.StringConversionLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderProblem.UnknownPropertyLoaderProblem - Class in org.yarnandtail.andhow.internal
 
LoaderPropertyIsNull(Loader) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyIsNull
 
LoaderPropertyNotRegistered(Loader, Property) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.LoaderPropertyNotRegistered
 
LoaderValueCoord - Class in org.yarnandtail.andhow.internal
Location of a value, as loaded by a specific loader for a specific Property.
LoaderValueCoord(Loader, Class<?>, Property<?>) - Constructor for class org.yarnandtail.andhow.internal.LoaderValueCoord
 
LoaderValues - Class in org.yarnandtail.andhow.api
The Properties and values loaded by a single Loader.
LoaderValues(Loader, Problem) - Constructor for class org.yarnandtail.andhow.api.LoaderValues
A constructor when there is just a problem to report.
LoaderValues(Loader) - Constructor for class org.yarnandtail.andhow.api.LoaderValues
A constructor when there is no problem, but there were no values loaded.
LoaderValues(Loader, List<ValidatedValue>, ProblemList<Problem>) - Constructor for class org.yarnandtail.andhow.api.LoaderValues
 
loadInputStreamToProps(InputStream, String, PropertyConfigurationInternal, ValidatedValuesWithContext) - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
LocalDateTimeBuilder() - Constructor for class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
 
LocalDateTimeProp - Class in org.yarnandtail.andhow.property
A Property that refers to a Long value.
LocalDateTimeProp(LocalDateTime, boolean, String, List<Validator<LocalDateTime>>, List<Name>, PropertyType, ValueType<LocalDateTime>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.LocalDateTimeProp
 
LocalDateTimeProp.LocalDateTimeBuilder - Class in org.yarnandtail.andhow.property
 
LocalDateTimeType - Class in org.yarnandtail.andhow.valuetype
Type representation of Java LocalDateTime objects.
LocalDateTimeValidator - Class in org.yarnandtail.andhow.valid
A collection of LocalDateTime validation types
LocalDateTimeValidator() - Constructor for class org.yarnandtail.andhow.valid.LocalDateTimeValidator
 
LocalDateTimeValidator.After - Class in org.yarnandtail.andhow.valid
 
LocalDateTimeValidator.Before - Class in org.yarnandtail.andhow.valid
 
LocalDateTimeValidator.SameTimeOrAfter - Class in org.yarnandtail.andhow.valid
 
LocalDateTimeValidator.SameTimeOrBefore - Class in org.yarnandtail.andhow.valid
 
LocalFileLoader - Interface in org.yarnandtail.andhow.api
A Loader that loads values from some type of file locally.
LookupLoader - Interface in org.yarnandtail.andhow.api
A Lookup Loader looks up values, possibly in an external system and may not be able to (easily) enumerate all values.

M

MANDATORY_NOTE_PREFIX - Static variable in class org.yarnandtail.andhow.util.AndHowLogHandler
Messages beginning with this prefix are important for users to see, but not an error.
mandatoryNote(String, Object...) - Method in class org.yarnandtail.andhow.util.AndHowLog
Log a manditory note.
ManualExportAllowed - Annotation Type in org.yarnandtail.andhow.export
Enables manual export of Property's contained in the annotated class, for use with frameworks that take configuration as key-value maps or similar.
ManualExportNotAllowed - Annotation Type in org.yarnandtail.andhow.export
Disables manual export of Property's contained in the annotated class, and inner classes contained in the class.
ManualExportService - Class in org.yarnandtail.andhow.internal.export
A service for performing a manual export.
ManualExportService() - Constructor for class org.yarnandtail.andhow.internal.export.ManualExportService
 
map - Variable in class org.yarnandtail.andhow.load.MapLoader
 
MapLoader - Class in org.yarnandtail.andhow.load
Loads values from a map.
MapLoader() - Constructor for class org.yarnandtail.andhow.load.MapLoader
 
mapNames(List<String>) - Method in interface org.yarnandtail.andhow.export.PropertyExport
Intended for using with Java stream()s, this method maps this instance to a new one with new export names.
mapNames(List<String>) - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
mapNames(List<String>, PropertyExport) - Static method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
Construct a new PropertyExport, overriding the getExportNames() method.
mapNames(List<String>) - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
mapNametoProperty(PropertyConfigurationInternal, String) - Method in class org.yarnandtail.andhow.load.BaseLoader
Maps the passed Property name or alias to a Property or null if it cannot be found.
mapValue(Object) - Method in interface org.yarnandtail.andhow.export.PropertyExport
Intended for using with Java stream()s, this method maps this instance to a new one with a new Object value for the Property, i.e., the 'value' part of a key-value pair.
mapValue(Object) - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
mapValue(Object, PropertyExport) - Static method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
Construct a new PropertyExport, overriding the getValue() method.
mapValue(Object) - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
mapValueAsString(String) - Method in interface org.yarnandtail.andhow.export.PropertyExport
Intended for using with Java stream()s, this method maps this instance to a new one with a new String value for the Property, i.e., the 'value' part of a key-value pair.
mapValueAsString(String) - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
 
mapValueAsString(String, PropertyExport) - Static method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl
Construct a new PropertyExport, overriding the getValueAsString() method.
mapValueAsString(String) - Method in class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
 
matches(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
missingFileAProblem - Variable in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
mustBeAfter(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
Deprecated.
Use LocalDateTimeBuilder.after()
mustBeBefore(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
Deprecated.
Use LocalDateTimeBuilder.before()
mustBeGreaterThan(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
Deprecated.
Use BigDecBuilder.greaterThan()
mustBeGreaterThan(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
Deprecated.
Use DblBuilder.greaterThan()
mustBeGreaterThan(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
Deprecated.
Use IntBuilder.greaterThan()
mustBeGreaterThan(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
Deprecated.
Use LngBuilder.greaterThan()
mustBeGreaterThanOrEqualTo(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
Deprecated.
Use BigDecBuilder.greaterThanOrEqualTo()
mustBeGreaterThanOrEqualTo(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
Deprecated.
Use DblBuilder.greaterThanOrEqualTo()
mustBeGreaterThanOrEqualTo(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
Deprecated.
Use IntBuilder.greaterThanOrEqualTo()
mustBeGreaterThanOrEqualTo(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
Deprecated.
Use LngBuilder.greaterThanOrEqualTo()
mustBeLessThan(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
Deprecated.
Use BigDecBuilder.lessThan()
mustBeLessThan(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
Deprecated.
Use DblBuilder.lessThan()
mustBeLessThan(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
Deprecated.
Use IntBuilder.lessThan()
mustBeLessThan(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
Deprecated.
Use LngBuilder.lessThan()
mustBeLessThanOrEqualTo(BigDecimal) - Method in class org.yarnandtail.andhow.property.BigDecProp.BigDecBuilder
Deprecated.
Use BigDecBuilder.lessThanOrEqualTo()
mustBeLessThanOrEqualTo(double) - Method in class org.yarnandtail.andhow.property.DblProp.DblBuilder
Deprecated.
Use DblBuilder.lessThanOrEqualTo()
mustBeLessThanOrEqualTo(int) - Method in class org.yarnandtail.andhow.property.IntProp.IntBuilder
Deprecated.
Use IntBuilder.lessThanOrEqualTo()
mustBeLessThanOrEqualTo(long) - Method in class org.yarnandtail.andhow.property.LngProp.LngBuilder
Deprecated.
Use LngBuilder.lessThanOrEqualTo()
mustBeNonNull() - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Deprecated.
Use PropertyBuilderBase.notNull()
mustBeSameTimeOrAfter(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
Deprecated.
Use LocalDateTimeBuilder.sameOrAfter()
mustBeSameTimeOrBefore(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
Deprecated.
Use LocalDateTimeBuilder.sameOrBefore()
mustEndWith(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
Deprecated.
Use StrBuilder.endsWith()
mustEndWithIgnoreCase(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
Deprecated.
Use StrBuilder.endsWithIgnoringCase()
mustEqual(String...) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
Deprecated.
Use StrBuilder.oneOf()
mustMatchRegex(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
Deprecated.
Use StrBuilder.matches()
mustStartWith(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
Deprecated.
Use StrBuilder.startsWith()
mustStartWithIgnoreCase(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
Deprecated.
Use StrBuilder.startsWithIgnoringCase()

N

Name - Class in org.yarnandtail.andhow.api
A name for a Property, either incoming (when read by a property Loader) or outgoing (when properties are exported to some destination).
Name(String, boolean, boolean) - Constructor for class org.yarnandtail.andhow.api.Name
 
NameAndProperty - Class in org.yarnandtail.andhow.internal
Simple way to pass the canonical name and associated property around
NameAndProperty(String, Property<?>) - Constructor for class org.yarnandtail.andhow.internal.NameAndProperty
 
NameUtil - Class in org.yarnandtail.andhow.util
 
NameUtil() - Constructor for class org.yarnandtail.andhow.util.NameUtil
 
naming - Variable in class org.yarnandtail.andhow.BaseConfig
 
NamingStrategy - Interface in org.yarnandtail.andhow.api
Defines how Property names are formed, matched and displayed.
NonNullPropertyProblem(Class<?>, Property<?>) - Constructor for class org.yarnandtail.andhow.internal.RequirementProblem.NonNullPropertyProblem
 
NonUniqueNames(GroupProxy, Property<?>, GroupProxy, Property<?>, String) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.NonUniqueNames
 
notNull() - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
If set, the effective value must be non-null to be considered valid.
NULL_KVP - Static variable in class org.yarnandtail.andhow.load.KVP
 
NULL_PRINT - Static variable in class org.yarnandtail.andhow.util.TextUtil
 
nullToEmpty(String) - Static method in class org.yarnandtail.andhow.util.TextUtil
Converts a null string to empty.

O

ObjectConversionValueProblem(Loader, Class<?>, Property, Object) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.ObjectConversionValueProblem
 
objectMap() - Static method in class org.yarnandtail.andhow.export.ExportCollector
Returns a Collector that collects PropertyExports into a Map<String, Object> collection of key-value pairs.
objectProperties(Object) - Static method in class org.yarnandtail.andhow.export.ExportCollector
Returns a Collector that collects PropertyExports into a Properties object with key-value entries that have Strings keys and Object values.
oneOf(String...) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
OneOf(String...) - Constructor for class org.yarnandtail.andhow.valid.StringValidator.OneOf
 
oneOfIgnoringCase(String...) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
OneOfIgnoringCase(String...) - Constructor for class org.yarnandtail.andhow.valid.StringValidator.OneOfIgnoringCase
 
Options - Interface in org.yarnandtail.andhow
Global options to configure AndHow behavior.
org.yarnandtail.andhow - package org.yarnandtail.andhow
 
org.yarnandtail.andhow.api - package org.yarnandtail.andhow.api
 
org.yarnandtail.andhow.export - package org.yarnandtail.andhow.export
 
org.yarnandtail.andhow.internal - package org.yarnandtail.andhow.internal
 
org.yarnandtail.andhow.internal.export - package org.yarnandtail.andhow.internal.export
 
org.yarnandtail.andhow.load - package org.yarnandtail.andhow.load
 
org.yarnandtail.andhow.load.std - package org.yarnandtail.andhow.load.std
 
org.yarnandtail.andhow.name - package org.yarnandtail.andhow.name
 
org.yarnandtail.andhow.property - package org.yarnandtail.andhow.property
 
org.yarnandtail.andhow.sample - package org.yarnandtail.andhow.sample
 
org.yarnandtail.andhow.service - package org.yarnandtail.andhow.service
 
org.yarnandtail.andhow.util - package org.yarnandtail.andhow.util
 
org.yarnandtail.andhow.valid - package org.yarnandtail.andhow.valid
 
org.yarnandtail.andhow.valuetype - package org.yarnandtail.andhow.valuetype
 
overrideGroups - Variable in class org.yarnandtail.andhow.BaseConfig
If non-null, overrides the default group discovery process with this override list.

P

padRight(String, String, int) - Static method in class org.yarnandtail.andhow.util.TextUtil
Pads the right side of the string with repeating repeatString's until the specified totalLength is reached.
parse(String) - Method in interface org.yarnandtail.andhow.api.ValueType
Attempts to parse the passed String into the destinationType.
parse(String) - Method in class org.yarnandtail.andhow.valuetype.BigDecType
Attempts to parse the passed String into the destinationType.
parse(String) - Method in class org.yarnandtail.andhow.valuetype.BolType
 
parse(String) - Method in class org.yarnandtail.andhow.valuetype.DblType
 
parse(String) - Method in class org.yarnandtail.andhow.valuetype.FlagType
 
parse(String) - Method in class org.yarnandtail.andhow.valuetype.IntType
 
parse(String) - Method in class org.yarnandtail.andhow.valuetype.LngType
 
parse(String) - Method in class org.yarnandtail.andhow.valuetype.LocalDateTimeType
The text format used is the default for LocalDateTime objects, which uses the ISO format like this: 2011-12-03T10:15:30.
parse(String) - Method in class org.yarnandtail.andhow.valuetype.StrType
 
ParsingException - Exception in org.yarnandtail.andhow.api
An exception where a String is unreadable or unconvertable to a target type.
ParsingException(String, String, Throwable) - Constructor for exception org.yarnandtail.andhow.api.ParsingException
 
ParsingException(String, String) - Constructor for exception org.yarnandtail.andhow.api.ParsingException
 
ParsingLoaderProblem(Loader, Class<?>, Property, Exception) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.ParsingLoaderProblem
 
pathProp - Variable in class org.yarnandtail.andhow.load.PropFileBaseLoader
Property containing the path of a property file.
pathStr - Variable in class org.yarnandtail.andhow.load.PropFileBaseLoader
String containing path of a property file.
print(PrintStream, TextBlock, PrintFormat) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
printConfigSamples(PropertyConfigurationInternal, List<Loader>, boolean) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
Writes sample configuration files for all Loaders that support it.
printConfigSamples(PropertyConfigurationInternal, File, List<Loader>, boolean) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
Print configurations samples for Loaders that support it.
printConstructionProblems(PrintStream, List<ConstructionProblem>, PropertyConfigurationInternal) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
PrintFormat - Class in org.yarnandtail.andhow.sample
 
PrintFormat() - Constructor for class org.yarnandtail.andhow.sample.PrintFormat
 
printIfNotNull(PrintStream, String) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
println(PrintStream, String, Object...) - Static method in class org.yarnandtail.andhow.util.TextUtil
println to the passed PrintStream using the format {} patterning.
println(PrintStream, int, String, String, Object...) - Static method in class org.yarnandtail.andhow.util.TextUtil
println to the passed PrintStream using the format {} patterning and wrapping to a specified line length.
println(PrintStream, int, String, String) - Static method in class org.yarnandtail.andhow.util.TextUtil
println to the passed PrintStream, wrapped to a specified line length.
printLoaderProblems(PrintStream, List<LoaderProblem>, PropertyConfigurationInternal) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
printProblemHR(PrintStream) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
printProblems(PrintStream, AppFatalException, PropertyConfigurationInternal) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
printProperty(PropertyConfigurationInternal, PrintStream, GroupProxy, Property<?>) - Method in interface org.yarnandtail.andhow.api.SamplePrinter
 
printProperty(PropertyConfigurationInternal, PrintStream, GroupProxy, Property<?>) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
printPropertyGroupEnd(PropertyConfigurationInternal, PrintStream, GroupProxy) - Method in interface org.yarnandtail.andhow.api.SamplePrinter
 
printPropertyGroupEnd(PropertyConfigurationInternal, PrintStream, GroupProxy) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
printPropertyGroupStart(PropertyConfigurationInternal, PrintStream, GroupProxy) - Method in interface org.yarnandtail.andhow.api.SamplePrinter
 
printPropertyGroupStart(PropertyConfigurationInternal, PrintStream, GroupProxy) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
printRequirementProblems(PrintStream, List<RequirementProblem>, PropertyConfigurationInternal) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
printSampleEnd(PropertyConfigurationInternal, PrintStream) - Method in interface org.yarnandtail.andhow.api.SamplePrinter
 
printSampleEnd(PropertyConfigurationInternal, PrintStream) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
printSampleStart(PropertyConfigurationInternal, PrintStream) - Method in interface org.yarnandtail.andhow.api.SamplePrinter
 
printSampleStart(PropertyConfigurationInternal, PrintStream) - Method in class org.yarnandtail.andhow.sample.BaseSamplePrinter
 
printSingleLoader(PropertyConfigurationInternal, PrintStream, SamplePrinter) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
printValueProblems(PrintStream, List<ValueProblem>, PropertyConfigurationInternal) - Static method in class org.yarnandtail.andhow.internal.ReportGenerator
 
Problem - Interface in org.yarnandtail.andhow.api
 
ProblemList<P extends Problem> - Class in org.yarnandtail.andhow.api
Simple List of Problems that refuses to add nulls.
ProblemList(int) - Constructor for class org.yarnandtail.andhow.api.ProblemList
 
ProblemList(ProblemList<P>) - Constructor for class org.yarnandtail.andhow.api.ProblemList
 
ProblemList() - Constructor for class org.yarnandtail.andhow.api.ProblemList
 
ProblemList.UnmodifiableProblemList<P extends Problem> - Class in org.yarnandtail.andhow.api
 
Property<T> - Interface in org.yarnandtail.andhow.api
Represents a configuration point of an application.
property - Variable in class org.yarnandtail.andhow.internal.NameAndProperty
 
PropertyBase<T> - Class in org.yarnandtail.andhow.property
Base property implementation that handles most of state information and common methods.
PropertyBase(T, boolean, String, List<Validator<T>>, List<Name>, PropertyType, ValueType<T>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.PropertyBase
 
PropertyBuilderBase<B extends PropertyBuilderBase,P extends Property<T>,T> - Class in org.yarnandtail.andhow.property
A generic PropertyBuilder class which needs to be fully implemented as an inner class in each Property implementation.
PropertyBuilderBase() - Constructor for class org.yarnandtail.andhow.property.PropertyBuilderBase
 
PropertyConfiguration - Interface in org.yarnandtail.andhow.api
Public view of configuration and metadata for all known static Properties.
PropertyConfigurationImmutable - Class in org.yarnandtail.andhow.internal
An immutable instance that can be used during runtime.
PropertyConfigurationImmutable(NamingStrategy, List<GroupProxy>, List<Property<?>>, Map<GroupProxy, List<Property<?>>>, Map<String, Property<?>>, Map<Property<?>, List<EffectiveName>>, Map<Property<?>, String>, List<ExportGroup>) - Constructor for class org.yarnandtail.andhow.internal.PropertyConfigurationImmutable
 
PropertyConfigurationInternal - Interface in org.yarnandtail.andhow.internal
Provides a complete view of all known Properties.
PropertyConfigurationMutable - Class in org.yarnandtail.andhow.internal
A mutable version that can be used during AndHow startup.
PropertyConfigurationMutable(NamingStrategy) - Constructor for class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
 
PropertyCoord - Class in org.yarnandtail.andhow.internal
Logical location of a Property (Group and Property).
PropertyCoord(Class<?>, Property<?>) - Constructor for class org.yarnandtail.andhow.internal.PropertyCoord
 
propertyCoord - Variable in class org.yarnandtail.andhow.internal.RequirementProblem
The Property that actually has the problem
PropertyExport - Interface in org.yarnandtail.andhow.export
A set of data for a single Property being exported.
PropertyExportImpl - Class in org.yarnandtail.andhow.internal.export
Implementation w/ wrapper inner subclass to simplify wrapped instances for mapXXX methods.
PropertyExportImpl(Property<?>, Class<?>, Exporter.EXPORT_CANONICAL_NAME, Exporter.EXPORT_OUT_ALIASES) - Constructor for class org.yarnandtail.andhow.internal.export.PropertyExportImpl
Full state constructor.
PropertyExportImpl.PropertyExportWrap - Class in org.yarnandtail.andhow.internal.export
A wrapper class that make it easy to wrap, delegate and override methods.
PropertyExportWrap(PropertyExport) - Constructor for class org.yarnandtail.andhow.internal.export.PropertyExportImpl.PropertyExportWrap
Construct a wrapper instance that wraps 'inner' and delegates to it for all methods.
PropertyNaming - Class in org.yarnandtail.andhow.api
Names by which a Property is recognized.
PropertyNaming(EffectiveName, List<EffectiveName>) - Constructor for class org.yarnandtail.andhow.api.PropertyNaming
 
PropertyNotPartOfGroup(GroupProxy, Property<?>) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.PropertyNotPartOfGroup
 
PropertyRegistrar - Interface in org.yarnandtail.andhow.service
Basic interface used by the java.util.ServiceLoader to discover all implementations on the classpath.
PropertyRegistrarLoader - Class in org.yarnandtail.andhow.service
Dedicated wrapper for a java.util.ServiceLoader that loads PropertyRegistrar instances.
PropertyRegistrarLoader() - Constructor for class org.yarnandtail.andhow.service.PropertyRegistrarLoader
New instance with default class loader (class.getClassLoader())
PropertyRegistrarLoader(ClassLoader) - Constructor for class org.yarnandtail.andhow.service.PropertyRegistrarLoader
New instance w/ specific classloader
PropertyRegistration - Class in org.yarnandtail.andhow.service
Registration for a single Property, which registers a single Property with AndHow during startup at run time.
PropertyRegistrationList - Class in org.yarnandtail.andhow.service
A List of Registrations with simplified add methods that make it efficient (source code wise) to add Registrations.
PropertyRegistrationList(String) - Constructor for class org.yarnandtail.andhow.service.PropertyRegistrationList
Construct a new registration list for properties in a specific top level class.
PropertyType - Enum in org.yarnandtail.andhow.api
The broad type of the Property Currently only two types are supported.
PropertyValue<T> - Class in org.yarnandtail.andhow
Simple class to bundle a Property and value.
PropertyValue(Property<T>, T) - Constructor for class org.yarnandtail.andhow.PropertyValue
New instance
PropFileBaseLoader - Class in org.yarnandtail.andhow.load
Shared functionality for all Property file loaders.
PropFileBaseLoader() - Constructor for class org.yarnandtail.andhow.load.PropFileBaseLoader
 
PropFileFormat - Class in org.yarnandtail.andhow.sample
PrintFormat implementation specifically for property files.
PropFileFormat() - Constructor for class org.yarnandtail.andhow.sample.PropFileFormat
Constructor that initializes all needed values to be a properties file.
PropFileLoaderSamplePrinter - Class in org.yarnandtail.andhow.sample
 
PropFileLoaderSamplePrinter() - Constructor for class org.yarnandtail.andhow.sample.PropFileLoaderSamplePrinter
 
PropFileOnClasspathLoader - Class in org.yarnandtail.andhow.load
Reads from a Java .properties file on the classpath, following standard java conventions for the structure of those key:value pair files.
PropFileOnClasspathLoader() - Constructor for class org.yarnandtail.andhow.load.PropFileOnClasspathLoader
 
PropFileOnFilesystemLoader - Class in org.yarnandtail.andhow.load
Reads from a Java .property file from the filesystem, following standard java conventions for the structure of those file.
PropFileOnFilesystemLoader() - Constructor for class org.yarnandtail.andhow.load.PropFileOnFilesystemLoader
 
props - Variable in class org.yarnandtail.andhow.api.GroupProxyBase
 
publish(LogRecord) - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Publish a message to either System.out or System.err based on the message Level.
publishMandatoryNote(LogRecord) - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Publish a message that must be seen, but is not an error.

Q

QuotedSpacePreservingTrimmer - Class in org.yarnandtail.andhow.property
This trimmer trims to null and treats double quotes as whitespace preserving markers.
QuotedSpacePreservingTrimmer() - Constructor for class org.yarnandtail.andhow.property.QuotedSpacePreservingTrimmer
 

R

ReadLoader - Interface in org.yarnandtail.andhow.api
A Read Loader is a loader that reads properties from a resource for which it is possible to enumerate all values.
ref - Variable in class org.yarnandtail.andhow.valid.LocalDateTimeValidator
 
refPropertyCoord - Variable in class org.yarnandtail.andhow.internal.ConstructionProblem
For construction problems that duplicate or reference another Property...
Regex(String) - Constructor for class org.yarnandtail.andhow.valid.StringValidator.Regex
 
registerGroup(PropertyConfigurationMutable, GroupProxy) - Static method in class org.yarnandtail.andhow.util.AndHowUtil
 
releaseResources() - Method in interface org.yarnandtail.andhow.api.Loader
Release any resources held by this loader.
releaseResources() - Method in class org.yarnandtail.andhow.load.BaseLoader
 
releaseResources() - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
releaseResources() - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
releaseResources() - Method in class org.yarnandtail.andhow.load.MapLoader
 
reload() - Method in class org.yarnandtail.andhow.service.InitLoader
Forces a reload of the service loader, which normally caches instances.
reload() - Method in class org.yarnandtail.andhow.service.TestInitLoader
Forces a reload of the service loader, which normally caches instances.
remove(Object) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
remove(int) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
removeAll(Collection<?>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
removeFixedValue(Property<?>) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Removes a Property value set only via addFixedValue(Property, T value) from the list of fixed values.
removeFixedValue(String) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Removes a Property value set only via addFixedValue(String name, Object value) from the list of fixed values.
removeFixedValue(Property<?>) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
removeFixedValue(String) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
removeHandler(Handler) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
removeIf(Predicate<? super P>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
removeRange(int, int) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
repeat(String, int) - Static method in class org.yarnandtail.andhow.util.TextUtil
 
replaceAll(UnaryOperator<P>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
ReportGenerator - Class in org.yarnandtail.andhow.internal
Generates configuration template files for the user, based on configured properties and the Loaders currently available.
ReportGenerator() - Constructor for class org.yarnandtail.andhow.internal.ReportGenerator
 
REQUIRED_HEADER_TEXT - Static variable in interface org.yarnandtail.andhow.api.SamplePrinter
A general explanation for a sample header of what a required property is
REQUIRED_KEYWORD - Static variable in interface org.yarnandtail.andhow.api.SamplePrinter
Required properties will be marked w/ this text in the sample
RequiredPropertyGroupProblem(Class<?>) - Constructor for class org.yarnandtail.andhow.internal.RequirementProblem.RequiredPropertyGroupProblem
 
RequirementProblem - Class in org.yarnandtail.andhow.internal
A problem of required values not being specified.
RequirementProblem() - Constructor for class org.yarnandtail.andhow.internal.RequirementProblem
 
RequirementProblem.NonNullPropertyProblem - Class in org.yarnandtail.andhow.internal
 
RequirementProblem.RequiredPropertyGroupProblem - Class in org.yarnandtail.andhow.internal
 
retainAll(Collection<?>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 

S

sameOrAfter(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
 
sameOrBefore(LocalDateTime) - Method in class org.yarnandtail.andhow.property.LocalDateTimeProp.LocalDateTimeBuilder
 
SameTimeOrAfter(LocalDateTime) - Constructor for class org.yarnandtail.andhow.valid.LocalDateTimeValidator.SameTimeOrAfter
 
SameTimeOrBefore(LocalDateTime) - Constructor for class org.yarnandtail.andhow.valid.LocalDateTimeValidator.SameTimeOrBefore
 
SamplePrinter - Interface in org.yarnandtail.andhow.api
Statelessly writes a sample configuration to the passed in PrintStream.
SAMPLES_DIRECTORY - Static variable in interface org.yarnandtail.andhow.Options
 
SECOND_LINE_INDENT - Static variable in class org.yarnandtail.andhow.util.TextUtil
 
secondLineIndent - Variable in class org.yarnandtail.andhow.sample.PrintFormat
 
SecurityException(Exception, Class<?>) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.SecurityException
 
set(int, P) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
setBlankLineAfter(boolean) - Method in class org.yarnandtail.andhow.sample.TextBlock
Specify if a blank line be printed after this block.
setBlankLineBefore(boolean) - Method in class org.yarnandtail.andhow.sample.TextBlock
Specify if a blank line be printed before this block.
setClasspathPropFilePath(String) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets the classpath path to a properties file for the StdPropFileOnClasspathLoader to read and load from.
setClasspathPropFilePath(StrProp) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets the classpath path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnClasspathLoader to read and load from.
setClasspathPropFilePath(String) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
setClasspathPropFilePath(StrProp) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
setCmdLineArgs(String[]) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets the command line arguments, removing any previously set commandline args.
setCmdLineArgs(String[]) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
setConfig(AndHowConfiguration<? extends AndHowConfiguration>) - Static method in class org.yarnandtail.andhow.AndHow
Prior to AndHow initialization, this method explicitly sets the configuration to be used.
setEnvironmentProperties(Map<String, String>) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
Deprecated.
This method will be removed in a future release - it has no meaningful usage. Use the addFixedValue() methods instead.
setErrStream(PrintStream) - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Sets the PrintStream used for error level logging (java.util.logging SEVERE level).
setExportByCanonicalName(Exporter.EXPORT_CANONICAL_NAME) - Method in interface org.yarnandtail.andhow.api.Exporter
Specify if canonical names should be exported.
setExportByCanonicalName(Exporter.EXPORT_CANONICAL_NAME) - Method in class org.yarnandtail.andhow.export.BaseExporter
 
setExportByOutAliases(Exporter.EXPORT_OUT_ALIASES) - Method in interface org.yarnandtail.andhow.api.Exporter
Specify if out alias names should be exported.
setExportByOutAliases(Exporter.EXPORT_OUT_ALIASES) - Method in class org.yarnandtail.andhow.export.BaseExporter
 
setFailedEnvironmentAProblem(boolean) - Method in interface org.yarnandtail.andhow.api.LookupLoader
If true, failing to initialize the environment needed to lookup values is considered a problem/error.
setFailedEnvironmentAProblem(boolean) - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
 
setFilePath(String) - Method in interface org.yarnandtail.andhow.api.LocalFileLoader
Sets the path to the file to be loaded.
setFilePath(Property<String>) - Method in interface org.yarnandtail.andhow.api.LocalFileLoader
Sets the path to the file to be loaded.
setFilePath(String) - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
setFilePath(Property<String>) - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
setFilesystemPropFilePath(StrProp) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
Sets the filesystem path via a StrProp (a Property of String type) to a properties file for the StdPropFileOnFilesystemLoader to load.
setFilesystemPropFilePath(StrProp) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
setInstance(B) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
setKeyObjectPairValues(List<KeyObjectPair>) - Method in class org.yarnandtail.andhow.load.FixedValueLoader
Set property values as KeyObjectPair's.
setKeyValuePairs(List<String>) - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
Sets the list of string arguments, each string containing a key-value pair or just a key for flag type values.
setKeyValuePairs(String...) - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
Deprecated.
Use KeyValuePairLoader.setKeyValuePairs(List<String>) instead.
setLevel(Level) - Method in class org.yarnandtail.andhow.util.AndHowLog
Assigns a log level.
setMap(Map<?, ?>) - Method in class org.yarnandtail.andhow.load.MapLoader
 
setMissingFileAProblem(boolean) - Method in interface org.yarnandtail.andhow.api.LocalFileLoader
If set true, a file path that does not point to a file is a Problem/error.
setMissingFileAProblem(boolean) - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
setNonErrStream(PrintStream) - Method in class org.yarnandtail.andhow.util.AndHowLogHandler
Sets the PrintStream used for non-error level logging (java.util.logging WARNING and lower).
setPropertyValues(List<PropertyValue>) - Method in class org.yarnandtail.andhow.load.FixedValueLoader
Set property values as PropertyValues, which require live references to each Property.
setPropertyValues(PropertyValue...) - Method in class org.yarnandtail.andhow.load.FixedValueLoader
Deprecated.
Use FixedValueLoader.setPropertyValues(List<PropertyValue>) instead.
setSampleDirectory(String) - Method in exception org.yarnandtail.andhow.api.AppFatalException
 
setStandardLoaders(List<Class<? extends StandardLoader>>) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
 
setStandardLoaders(Class<? extends StandardLoader>...) - Method in interface org.yarnandtail.andhow.AndHowConfiguration
 
setStandardLoaders(List<Class<? extends StandardLoader>>) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
setStandardLoaders(Class<? extends StandardLoader>...) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
setSystemProperties(Properties) - Method in class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
Deprecated. 
setUnknownPropertyAProblem(boolean) - Method in interface org.yarnandtail.andhow.api.ReadLoader
If true, an unrecognized property name is considered a problem/error.
setUnknownPropertyAProblem(boolean) - Method in class org.yarnandtail.andhow.load.FixedValueLoader
 
setUnknownPropertyAProblem(boolean) - Method in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
setUnknownPropertyAProblem(boolean) - Method in class org.yarnandtail.andhow.load.MapLoader
 
setUnknownPropertyAProblem(boolean) - Method in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
sort(Comparator<? super P>) - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
sort() - Method in class org.yarnandtail.andhow.service.PropertyRegistrationList
Sorts in lexagraphical order.
SourceNotFoundLoaderProblem(Loader, String) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.SourceNotFoundLoaderProblem
 
split(String) - Method in class org.yarnandtail.andhow.load.std.StdJndiLoader
Spits a comma separate list of JNDI roots into individual root strings.
splitKVP(String, String) - Static method in class org.yarnandtail.andhow.load.KVP
Splits a key value pair String into its key and value using the passed delimiter.
StackLocator - Class in org.yarnandtail.andhow.util
A utility class for find the calling class, method and line number for use in creating more detailed logging information.
StackLocator() - Constructor for class org.yarnandtail.andhow.util.StackLocator
 
STANDARD_JNDI_ROOTS - Static variable in interface org.yarnandtail.andhow.load.std.StdJndiLoader.CONFIG
 
StandardLoader - Interface in org.yarnandtail.andhow.api
Marker interface that indicates direct support and automatic construction for a Loader.
standardLoaders - Variable in class org.yarnandtail.andhow.BaseConfig
 
startsWith(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
StartsWith(String, boolean) - Constructor for class org.yarnandtail.andhow.valid.StringValidator.StartsWith
 
startsWithIgnoringCase(String) - Method in class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
StdConfig - Class in org.yarnandtail.andhow
 
StdConfig() - Constructor for class org.yarnandtail.andhow.StdConfig
 
StdConfig.StdConfigAbstract<S extends StdConfig.StdConfigAbstract<S>> - Class in org.yarnandtail.andhow
Abstract class here lets this be extended maintaining the generic types
StdConfig.StdConfigImpl - Class in org.yarnandtail.andhow
Final class 'closes' the generics for an actual implementation.
StdConfigAbstract() - Constructor for class org.yarnandtail.andhow.StdConfig.StdConfigAbstract
 
StdConfigImpl() - Constructor for class org.yarnandtail.andhow.StdConfig.StdConfigImpl
 
StdEnvVarLoader - Class in org.yarnandtail.andhow.load.std
Reads the operating system defined environment variables and loads the value for any environmental variable who's name matches a Property.
StdEnvVarLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdEnvVarLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StdFixedValueLoader - Class in org.yarnandtail.andhow.load.std
Sets values directly in code.
StdFixedValueLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdFixedValueLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StdJndiLoader - Class in org.yarnandtail.andhow.load.std
Attempts to look up the name of each known Property in the JNDI environment and loads the value for any that are found.
StdJndiLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdJndiLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StdJndiLoader.CONFIG - Interface in org.yarnandtail.andhow.load.std
 
StdMainStringArgsLoader - Class in org.yarnandtail.andhow.load.std
Reads an array of Strings containing key value pairs in the form key=value, and loads the value for any key that matches a Property.
StdMainStringArgsLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdMainStringArgsLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StdPropFileOnClasspathLoader - Class in org.yarnandtail.andhow.load.std
Parses and loads Properties from a Java .property file on the classpath.
StdPropFileOnClasspathLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdPropFileOnClasspathLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StdPropFileOnFilesystemLoader - Class in org.yarnandtail.andhow.load.std
Parses and loads Properties from a Java .property file on the file system.
StdPropFileOnFilesystemLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdPropFileOnFilesystemLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StdSysPropLoader - Class in org.yarnandtail.andhow.load.std
Reads the Java system properties and loads the value for any system property who's name matches a Property.
StdSysPropLoader() - Constructor for class org.yarnandtail.andhow.load.std.StdSysPropLoader
There is no reason to use the constructor in production application code because AndHow creates a single instance on demand at runtime.
StrBuilder() - Constructor for class org.yarnandtail.andhow.property.StrProp.StrBuilder
 
StringConversionLoaderProblem(Loader, Class<?>, Property, String) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.StringConversionLoaderProblem
 
StringLine(String, boolean) - Constructor for class org.yarnandtail.andhow.sample.TextLine.StringLine
 
StringLine(String) - Constructor for class org.yarnandtail.andhow.sample.TextLine.StringLine
 
stringMap() - Static method in class org.yarnandtail.andhow.export.ExportCollector
Returns a Collector that collects PropertyExports into a Map<String, String> collection of key-value pairs.
stringProperties(String) - Static method in class org.yarnandtail.andhow.export.ExportCollector
Returns a Collector that collects PropertyExports into a Properties object with key-value entries that are Strings.
StringValidator - Class in org.yarnandtail.andhow.valid
A collection of String validation types
StringValidator() - Constructor for class org.yarnandtail.andhow.valid.StringValidator
 
StringValidator.EndsWith - Class in org.yarnandtail.andhow.valid
Validate that a string ends with a specific string.
StringValidator.OneOf - Class in org.yarnandtail.andhow.valid
Validate that a string is one from the specified set.
StringValidator.OneOfIgnoringCase - Class in org.yarnandtail.andhow.valid
Validate that a string is one from the specified set ignoring case.
StringValidator.Regex - Class in org.yarnandtail.andhow.valid
Validate based on a regex string.
StringValidator.StartsWith - Class in org.yarnandtail.andhow.valid
Validate that a string starts with a specific string.
StrProp - Class in org.yarnandtail.andhow.property
A Property that refers to a String value.
StrProp(String, boolean, String, List<Validator<String>>, List<Name>, PropertyType, ValueType<String>, Trimmer, String) - Constructor for class org.yarnandtail.andhow.property.StrProp
 
StrProp.StrBuilder - Class in org.yarnandtail.andhow.property
 
StrType - Class in org.yarnandtail.andhow.valuetype
Metadata and parsing for the String type.
SysPropExporter - Class in org.yarnandtail.andhow.export
Exports Properties to System.Properties.
SysPropExporter() - Constructor for class org.yarnandtail.andhow.export.SysPropExporter
A default constructor is required.
systemProperties - Variable in class org.yarnandtail.andhow.BaseConfig
 

T

TestInitLoader - Class in org.yarnandtail.andhow.service
Dedicated wrapper for a java.util.ServiceLoader that loads TestInitLoader instances.
TestInitLoader() - Constructor for class org.yarnandtail.andhow.service.TestInitLoader
 
TestInitLoader(ClassLoader) - Constructor for class org.yarnandtail.andhow.service.TestInitLoader
 
TextBlock - Class in org.yarnandtail.andhow.sample
A block of Text made up of multiple TextLines.
TextBlock(boolean, boolean) - Constructor for class org.yarnandtail.andhow.sample.TextBlock
New instance
TextLine - Class in org.yarnandtail.andhow.sample
A line of text, which may need to be wrapped and/or commented.
TextLine() - Constructor for class org.yarnandtail.andhow.sample.TextLine
 
TextLine.BlankLine - Class in org.yarnandtail.andhow.sample
A blank line will continue the comment or non-comment status of the block.
TextLine.HRLine - Class in org.yarnandtail.andhow.sample
A horizontal rule / separator line.
TextLine.StringLine - Class in org.yarnandtail.andhow.sample
A line of text.
TextUtil - Class in org.yarnandtail.andhow.util
Text utility used for formatting output for reports, auto generated descriptions and Problems.
TextUtil() - Constructor for class org.yarnandtail.andhow.util.TextUtil
 
THE_VALUE_MUST_TEXT - Static variable in interface org.yarnandtail.andhow.api.SamplePrinter
Lead-in text for validation requirements
toBoolean(String) - Static method in class org.yarnandtail.andhow.util.TextUtil
Parses a string to a boolean.
toEffectiveName(String) - Method in interface org.yarnandtail.andhow.api.NamingStrategy
Transforms a property name found in a property source (like a properties file, cmd line argument, env variable, etc.) into the form needed to match the expected property names.
toEffectiveName(String) - Method in class org.yarnandtail.andhow.name.CaseInsensitiveNaming
 
toImmutable() - Method in class org.yarnandtail.andhow.internal.PropertyConfigurationMutable
Return an immutable instance.
TooManyAndHowInitInstances(List<? extends AndHowInit>) - Constructor for class org.yarnandtail.andhow.internal.ConstructionProblem.TooManyAndHowInitInstances
 
toString(T) - Method in interface org.yarnandtail.andhow.api.ValueType
Converts an instance of the destination type to String.
toString() - Method in class org.yarnandtail.andhow.load.KeyObjectPair
String representation: name : "value" If the value is null, the string [null] is used.
toString(InputStream, Charset) - Static method in class org.yarnandtail.andhow.util.IOUtil
Build a String from the content on an InputStream using the encoding provided.
toString(T) - Method in class org.yarnandtail.andhow.valuetype.BaseValueType
 
trace(String) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
trace(String, Object...) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
trace(String, Throwable) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
trim(String) - Method in interface org.yarnandtail.andhow.api.Trimmer
Trims the raw string to remove whitespace
trim(String) - Method in class org.yarnandtail.andhow.property.QuotedSpacePreservingTrimmer
 
trim(String) - Method in class org.yarnandtail.andhow.property.TrimToNullTrimmer
 
Trimmer - Interface in org.yarnandtail.andhow.api
Trims raw Strings brought in by Loaders to remove whitespace.
trimmer(Trimmer) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Assigns the whitespace trimmer that is used on the raw value.
trimToEmpty(String) - Static method in class org.yarnandtail.andhow.util.TextUtil
 
trimToNull(String) - Static method in class org.yarnandtail.andhow.util.TextUtil
 
TrimToNullTrimmer - Class in org.yarnandtail.andhow.property
This trimmer trims to null.
TrimToNullTrimmer() - Constructor for class org.yarnandtail.andhow.property.TrimToNullTrimmer
 
trimToSize() - Method in class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 

U

UNKNOWN - Static variable in interface org.yarnandtail.andhow.api.Problem
 
unknownPropertyAProblem - Variable in class org.yarnandtail.andhow.load.FixedValueLoader
 
unknownPropertyAProblem - Variable in class org.yarnandtail.andhow.load.KeyValuePairLoader
 
unknownPropertyAProblem - Variable in class org.yarnandtail.andhow.load.MapLoader
 
unknownPropertyAProblem - Variable in class org.yarnandtail.andhow.load.PropFileBaseLoader
 
UnknownPropertyLoaderProblem(Loader, String) - Constructor for class org.yarnandtail.andhow.internal.LoaderProblem.UnknownPropertyLoaderProblem
 
UnmodifiableProblemList(ProblemList<P>) - Constructor for class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
UnmodifiableProblemList() - Constructor for class org.yarnandtail.andhow.api.ProblemList.UnmodifiableProblemList
 
usesBlockComments() - Method in class org.yarnandtail.andhow.sample.PrintFormat
 
usesLineComments() - Method in class org.yarnandtail.andhow.sample.PrintFormat
 

V

ValidatedValue<T> - Class in org.yarnandtail.andhow.api
Simple class to bundle a Property, its value and any associated problems with the Property.
ValidatedValue(Property<T>, T) - Constructor for class org.yarnandtail.andhow.api.ValidatedValue
New instance w/o Problems Problems can be added later.
ValidatedValues - Interface in org.yarnandtail.andhow.api
A map of Properties to their loaded values.
ValidatedValuesImmutable - Class in org.yarnandtail.andhow.internal
Immutable implementation of ValidatedValues.
ValidatedValuesImmutable(Map<Property<?>, Object>) - Constructor for class org.yarnandtail.andhow.internal.ValidatedValuesImmutable
 
ValidatedValuesWithContext - Interface in org.yarnandtail.andhow.api
Extention of ValidatedValues that adds contextual information.
ValidatedValuesWithContextBase - Class in org.yarnandtail.andhow.internal
Shared base implementation for both immutable and mutable versions.
ValidatedValuesWithContextBase() - Constructor for class org.yarnandtail.andhow.internal.ValidatedValuesWithContextBase
 
ValidatedValuesWithContextImmutable - Class in org.yarnandtail.andhow.internal
Immutable ValidatedValues implementation that stores extra context info.
ValidatedValuesWithContextImmutable(List<LoaderValues>) - Constructor for class org.yarnandtail.andhow.internal.ValidatedValuesWithContextImmutable
 
ValidatedValuesWithContextMutable - Class in org.yarnandtail.andhow.internal
Mutable ValidatedValues implementation w/ context info.
ValidatedValuesWithContextMutable() - Constructor for class org.yarnandtail.andhow.internal.ValidatedValuesWithContextMutable
 
validation(Validator<T>) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Adds a validation to the list of validators,
validations(List<Validator<T>>) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
Adds a list of Validators to the list of validators being built.
Validator<T> - Interface in org.yarnandtail.andhow.api
 
valueOf(String) - Static method in enum org.yarnandtail.andhow.api.Exporter.EXPORT_CANONICAL_NAME
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.yarnandtail.andhow.api.Exporter.EXPORT_OUT_ALIASES
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.yarnandtail.andhow.api.PropertyType
Returns the enum constant of this type with the specified name.
ValueProblem - Class in org.yarnandtail.andhow.internal
Problems with invalid values, values that cannot be converted to their destination type.
ValueProblem() - Constructor for class org.yarnandtail.andhow.internal.ValueProblem
 
ValueProblem.InvalidValueProblem<T> - Class in org.yarnandtail.andhow.internal
 
values() - Static method in enum org.yarnandtail.andhow.api.Exporter.EXPORT_CANONICAL_NAME
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.yarnandtail.andhow.api.Exporter.EXPORT_OUT_ALIASES
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.yarnandtail.andhow.api.PropertyType
Returns an array containing the constants of this enum type, in the order they are declared.
values - Variable in class org.yarnandtail.andhow.load.FixedValueLoader
 
ValueType<T> - Interface in org.yarnandtail.andhow.api
The type of a Property.
valueType(ValueType<T>) - Method in class org.yarnandtail.andhow.property.PropertyBuilderBase
This method should be called by subclasses.

W

warn(String) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
warn(String, Object...) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
warn(String, Throwable) - Method in class org.yarnandtail.andhow.util.AndHowLog
 
wrap - Variable in class org.yarnandtail.andhow.sample.TextLine
Indicates if this line should be wrapped if too long.
wrap(String, int, String, String) - Static method in class org.yarnandtail.andhow.util.TextUtil
Wraps text to be no longer than the specified length, if possible, and adds a prefix to each line, which is subtracted from the overall length.
wrap(String, int) - Static method in class org.yarnandtail.andhow.util.TextUtil
Wraps text to be no longer than the specified length, if possible.

_

_aliases - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_cmdLineArgs - Variable in class org.yarnandtail.andhow.BaseConfig
 
_defaultValue - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_desc - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_fixedKeyObjectPairVals - Variable in class org.yarnandtail.andhow.BaseConfig
 
_fixedVals - Variable in class org.yarnandtail.andhow.BaseConfig
 
_helpText - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_missingClasspathPropFileAProblem - Variable in class org.yarnandtail.andhow.BaseConfig
 
_missingFilesystemPropFileAProblem - Variable in class org.yarnandtail.andhow.BaseConfig
 
_nonNull - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_trimmer - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_validators - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
_valueType - Variable in class org.yarnandtail.andhow.property.PropertyBuilderBase
 
A B C D E F G H I J K L M N O P Q R S T U V W _ 
Skip navigation links

Copyright © 2021. All rights reserved.