Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- addConfigurationBean(Object) - Method in class com.github.joschi.jadconfig.JadConfig
-
Adds a configuration bean annotated with JadConfig annotations.
- addConverterFactory(ConverterFactory) - Method in class com.github.joschi.jadconfig.JadConfig
-
Adds a
ConverterFactoryfor processing additional types
B
- BigDecimalConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
BigDecimal - BigDecimalConverter() - Constructor for class com.github.joschi.jadconfig.converters.BigDecimalConverter
- BigIntegerConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
BigInteger - BigIntegerConverter() - Constructor for class com.github.joschi.jadconfig.converters.BigIntegerConverter
- BooleanConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Boolean - BooleanConverter() - Constructor for class com.github.joschi.jadconfig.converters.BooleanConverter
- ByteConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Byte - ByteConverter() - Constructor for class com.github.joschi.jadconfig.converters.ByteConverter
- bytes(long) - Static method in class com.github.joschi.jadconfig.util.Size
- BYTES - Enum constant in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Bytes.
C
- CacheBuilderSpecConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
CacheBuilderSpec. - CacheBuilderSpecConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.CacheBuilderSpecConverter
- CharsetConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Charset - CharsetConverter() - Constructor for class com.github.joschi.jadconfig.converters.CharsetConverter
- ClassConverter - Class in com.github.joschi.jadconfig.converters
-
Class to convert from a given FQCN (fully qualified class name) to a
Classobject - ClassConverter() - Constructor for class com.github.joschi.jadconfig.converters.ClassConverter
- close() - Method in class com.github.joschi.jadconfig.documentation.printers.ConfigFileDocsPrinter
- close() - Method in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- close() - Method in class com.github.joschi.jadconfig.repositories.EnvironmentRepository
- close() - Method in class com.github.joschi.jadconfig.repositories.InMemoryRepository
- close() - Method in class com.github.joschi.jadconfig.repositories.PropertiesRepository
-
Close the underlying properties file.
- close() - Method in class com.github.joschi.jadconfig.repositories.SystemPropertiesRepository
- close() - Method in interface com.github.joschi.jadconfig.Repository
-
Closes the underlying data source when it isn't require any more.
- com.github.joschi.jadconfig - package com.github.joschi.jadconfig
- com.github.joschi.jadconfig.converters - package com.github.joschi.jadconfig.converters
- com.github.joschi.jadconfig.documentation - package com.github.joschi.jadconfig.documentation
- com.github.joschi.jadconfig.documentation.printers - package com.github.joschi.jadconfig.documentation.printers
- com.github.joschi.jadconfig.guava - package com.github.joschi.jadconfig.guava
- com.github.joschi.jadconfig.guava.converters - package com.github.joschi.jadconfig.guava.converters
- com.github.joschi.jadconfig.guice - package com.github.joschi.jadconfig.guice
- com.github.joschi.jadconfig.jodatime - package com.github.joschi.jadconfig.jodatime
- com.github.joschi.jadconfig.jodatime.converters - package com.github.joschi.jadconfig.jodatime.converters
- com.github.joschi.jadconfig.repositories - package com.github.joschi.jadconfig.repositories
- com.github.joschi.jadconfig.response - package com.github.joschi.jadconfig.response
- com.github.joschi.jadconfig.util - package com.github.joschi.jadconfig.util
- com.github.joschi.jadconfig.validators - package com.github.joschi.jadconfig.validators
- compareTo(TypeReference<T>) - Method in class com.github.joschi.jadconfig.TypeReference
-
Dummy implementation to prevent constructing a reference without type information.
- compareTo(Duration) - Method in class com.github.joschi.jadconfig.util.Duration
- compareTo(Size) - Method in class com.github.joschi.jadconfig.util.Size
- ConfigFileDocsPrinter - Class in com.github.joschi.jadconfig.documentation.printers
- ConfigFileDocsPrinter(OutputStreamWriter) - Constructor for class com.github.joschi.jadconfig.documentation.printers.ConfigFileDocsPrinter
- configName() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
configNamerecord component. - configurationBean() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
configurationBeanrecord component. - ConfigurationBeansSPI - Class in com.github.joschi.jadconfig.documentation
- ConfigurationBeansSPI() - Constructor for class com.github.joschi.jadconfig.documentation.ConfigurationBeansSPI
- ConfigurationDocsGenerator - Class in com.github.joschi.jadconfig.documentation
- ConfigurationDocsGenerator() - Constructor for class com.github.joschi.jadconfig.documentation.ConfigurationDocsGenerator
- ConfigurationEntry - Record Class in com.github.joschi.jadconfig.documentation
- ConfigurationEntry(Class<?>, String, String, String, Object, boolean, String) - Constructor for record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Creates an instance of a
ConfigurationEntryrecord class. - ConfigurationEntryWithSection - Record Class in com.github.joschi.jadconfig.documentation
- ConfigurationEntryWithSection(ConfigurationEntry, String, String) - Constructor for record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Creates an instance of a
ConfigurationEntryWithSectionrecord class. - ConfigurationSection - Record Class in com.github.joschi.jadconfig.documentation.printers
- ConfigurationSection(String, String, List<ConfigurationSection>, List<ConfigurationEntry>) - Constructor for record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Creates an instance of a
ConfigurationSectionrecord class. - convert(long, SizeUnit) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts a size of the given unit into the current unit.
- converter() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Specific
Converterto use for this parameter. - Converter<T> - Interface in com.github.joschi.jadconfig
-
Interface for type converters.
- ConverterFactory - Interface in com.github.joschi.jadconfig
-
Interface for converter factories A converter factory can be used to provider
Converters for several types instead of using theParameter.converter()annotation parameter for each class field. - convertFrom(String) - Method in interface com.github.joschi.jadconfig.Converter
-
Returns a typed instance representing the specified
Stringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.BigDecimalConverter
-
Returns a
BigDecimalinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.BigIntegerConverter
-
Returns a
BigIntegerinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.BooleanConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.ByteConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.CharsetConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.ClassConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.CurrencyConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.DecimalFormatConverter
-
Returns a
DecimalFormatinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.DoubleConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.DurationConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.FileConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.FloatConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.Inet4AddressConverter
-
Returns a
Inet4Addressinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.Inet6AddressConverter
-
Returns a
Inet6Addressinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.InetAddressConverter
-
Returns a
InetAddressinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.InetSocketAddressConverter
-
Returns a
InetSocketAddressinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.IntegerConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.LocaleConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.LongConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.NoConverter
-
Default
Converter.convertFrom(String)implementation. - convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.PathConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.PatternConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.ShortConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.SizeConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.SizeUnitConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.StringConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.StringListConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.StringSetConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.StringSortedSetConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.TimeUnitConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.TimeZoneConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.TrimmedStringListConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.TrimmedStringSetConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.TrimmedStringSortedSetConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.URIConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.URLConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.converters.UUIDConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.CacheBuilderSpecConverter
-
Returns a
CacheBuilderSpecinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.HashCodeConverter
-
Returns a
HashCodeinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.HostAndPortConverter
-
Returns a
HostAndPortinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.HostSpecifierConverter
-
Returns a
HostSpecifierinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.InternetDomainNameConverter
-
Returns a
InternetDomainNameinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.MediaTypeConverter
-
Returns a
MediaTypeinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.UnsignedIntegerConverter
-
Returns a
UnsignedIntegerinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.guava.converters.UnsignedLongConverter
-
Returns a
UnsignedLonginstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.DateTimeFormatterConverter
-
Returns a
DateTimeFormatterinstance representing the specified pattern. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.DateTimeZoneConverter
-
Returns a
DateTimeZoneinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.DaysConverter
-
Returns a
Daysinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.DurationConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.HoursConverter
-
Returns a
Hoursinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.IntervalConverter
-
Returns a
Intervalinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.MinutesConverter
-
Returns a
Minutesinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.MonthsConverter
-
Returns a
Monthsinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.PeriodConverter
- convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.SecondsConverter
-
Returns a
Secondsinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.WeeksConverter
-
Returns a
Weeksinstance representing the specifiedStringvalue. - convertFrom(String) - Method in class com.github.joschi.jadconfig.jodatime.converters.YearsConverter
-
Returns a
Yearsinstance representing the specifiedStringvalue. - convertTo(Duration) - Method in class com.github.joschi.jadconfig.converters.DurationConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Size) - Method in class com.github.joschi.jadconfig.converters.SizeConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(SizeUnit) - Method in class com.github.joschi.jadconfig.converters.SizeUnitConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(CacheBuilderSpec) - Method in class com.github.joschi.jadconfig.guava.converters.CacheBuilderSpecConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(HashCode) - Method in class com.github.joschi.jadconfig.guava.converters.HashCodeConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(HostAndPort) - Method in class com.github.joschi.jadconfig.guava.converters.HostAndPortConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(HostSpecifier) - Method in class com.github.joschi.jadconfig.guava.converters.HostSpecifierConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(InternetDomainName) - Method in class com.github.joschi.jadconfig.guava.converters.InternetDomainNameConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(MediaType) - Method in class com.github.joschi.jadconfig.guava.converters.MediaTypeConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(UnsignedInteger) - Method in class com.github.joschi.jadconfig.guava.converters.UnsignedIntegerConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(UnsignedLong) - Method in class com.github.joschi.jadconfig.guava.converters.UnsignedLongConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(File) - Method in class com.github.joschi.jadconfig.converters.FileConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Boolean) - Method in class com.github.joschi.jadconfig.converters.BooleanConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Byte) - Method in class com.github.joschi.jadconfig.converters.ByteConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Class) - Method in class com.github.joschi.jadconfig.converters.ClassConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Double) - Method in class com.github.joschi.jadconfig.converters.DoubleConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Float) - Method in class com.github.joschi.jadconfig.converters.FloatConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Integer) - Method in class com.github.joschi.jadconfig.converters.IntegerConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Long) - Method in class com.github.joschi.jadconfig.converters.LongConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Short) - Method in class com.github.joschi.jadconfig.converters.ShortConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(String) - Method in class com.github.joschi.jadconfig.converters.NoConverter
-
Default
Converter.convertTo(Object)implementation. - convertTo(String) - Method in class com.github.joschi.jadconfig.converters.StringConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(BigDecimal) - Method in class com.github.joschi.jadconfig.converters.BigDecimalConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(BigInteger) - Method in class com.github.joschi.jadconfig.converters.BigIntegerConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Inet4Address) - Method in class com.github.joschi.jadconfig.converters.Inet4AddressConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Inet6Address) - Method in class com.github.joschi.jadconfig.converters.Inet6AddressConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(InetAddress) - Method in class com.github.joschi.jadconfig.converters.InetAddressConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(InetSocketAddress) - Method in class com.github.joschi.jadconfig.converters.InetSocketAddressConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(URI) - Method in class com.github.joschi.jadconfig.converters.URIConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(URL) - Method in class com.github.joschi.jadconfig.converters.URLConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Charset) - Method in class com.github.joschi.jadconfig.converters.CharsetConverter
-
Returns a
Stringinstance representing the the configuration parameter's value. - convertTo(Path) - Method in class com.github.joschi.jadconfig.converters.PathConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(DecimalFormat) - Method in class com.github.joschi.jadconfig.converters.DecimalFormatConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(TimeUnit) - Method in class com.github.joschi.jadconfig.converters.TimeUnitConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Currency) - Method in class com.github.joschi.jadconfig.converters.CurrencyConverter
-
Returns a
Stringinstance representing the ISO 4217 code of the configuration parameter's value. - convertTo(List<String>) - Method in class com.github.joschi.jadconfig.converters.StringListConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Locale) - Method in class com.github.joschi.jadconfig.converters.LocaleConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Pattern) - Method in class com.github.joschi.jadconfig.converters.PatternConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Set<String>) - Method in class com.github.joschi.jadconfig.converters.StringSetConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(SortedSet<String>) - Method in class com.github.joschi.jadconfig.converters.StringSortedSetConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(TimeZone) - Method in class com.github.joschi.jadconfig.converters.TimeZoneConverter
-
Returns a
Stringinstance representing the the configuration parameter's value. - convertTo(UUID) - Method in class com.github.joschi.jadconfig.converters.UUIDConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(DateTimeZone) - Method in class com.github.joschi.jadconfig.jodatime.converters.DateTimeZoneConverter
-
Returns a
Stringinstance representing the the configuration parameter's value. - convertTo(Days) - Method in class com.github.joschi.jadconfig.jodatime.converters.DaysConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Duration) - Method in class com.github.joschi.jadconfig.jodatime.converters.DurationConverter
- convertTo(DateTimeFormatter) - Method in class com.github.joschi.jadconfig.jodatime.converters.DateTimeFormatterConverter
-
Returns an empty
Stringsince getting the original pattern from aDateTimeFormatterisn't supported by Joda-Time. - convertTo(Hours) - Method in class com.github.joschi.jadconfig.jodatime.converters.HoursConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Interval) - Method in class com.github.joschi.jadconfig.jodatime.converters.IntervalConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Minutes) - Method in class com.github.joschi.jadconfig.jodatime.converters.MinutesConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Months) - Method in class com.github.joschi.jadconfig.jodatime.converters.MonthsConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Period) - Method in class com.github.joschi.jadconfig.jodatime.converters.PeriodConverter
- convertTo(Seconds) - Method in class com.github.joschi.jadconfig.jodatime.converters.SecondsConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Weeks) - Method in class com.github.joschi.jadconfig.jodatime.converters.WeeksConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(Years) - Method in class com.github.joschi.jadconfig.jodatime.converters.YearsConverter
-
Returns a
Stringinstance representing the configuration parameter's value. - convertTo(T) - Method in interface com.github.joschi.jadconfig.Converter
-
Returns a
Stringinstance representing the configuration parameter's value. - CsvDocsPrinter - Class in com.github.joschi.jadconfig.documentation.printers
- CsvDocsPrinter(OutputStreamWriter) - Constructor for class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- CurrencyConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Currency - CurrencyConverter() - Constructor for class com.github.joschi.jadconfig.converters.CurrencyConverter
D
- DateTimeFormatterConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
DateTimeFormatter - DateTimeFormatterConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.DateTimeFormatterConverter
- DateTimeZoneConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
DateTimeZone - DateTimeZoneConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.DateTimeZoneConverter
- days(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- DaysConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Days - DaysConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.DaysConverter
- DecimalFormatConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
DecimalFormat - DecimalFormatConverter() - Constructor for class com.github.joschi.jadconfig.converters.DecimalFormatConverter
- DefaultConverterFactory - Class in com.github.joschi.jadconfig
-
ConverterFactoryfor holding the defaultConverterclasses. - DefaultConverterFactory() - Constructor for class com.github.joschi.jadconfig.DefaultConverterFactory
- defaultValue() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
defaultValuerecord component. - description() - Element in annotation interface com.github.joschi.jadconfig.documentation.DocumentationSection
- description() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Returns the value of the
descriptionrecord component. - DirectoryPathReadableValidator - Class in com.github.joschi.jadconfig.validators
- DirectoryPathReadableValidator() - Constructor for class com.github.joschi.jadconfig.validators.DirectoryPathReadableValidator
- DirectoryPathWritableValidator - Class in com.github.joschi.jadconfig.validators
- DirectoryPathWritableValidator() - Constructor for class com.github.joschi.jadconfig.validators.DirectoryPathWritableValidator
- DirectoryReadableValidator - Class in com.github.joschi.jadconfig.validators
- DirectoryReadableValidator() - Constructor for class com.github.joschi.jadconfig.validators.DirectoryReadableValidator
- DirectoryWritableValidator - Class in com.github.joschi.jadconfig.validators
- DirectoryWritableValidator() - Constructor for class com.github.joschi.jadconfig.validators.DirectoryWritableValidator
- DocsPrinter - Interface in com.github.joschi.jadconfig.documentation.printers
- documentation() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
documentationrecord component. - Documentation - Annotation Interface in com.github.joschi.jadconfig.documentation
-
This annotation is used to document configuration files.
- DocumentationFormat - Record Class in com.github.joschi.jadconfig.documentation
- DocumentationFormat(String, String) - Constructor for record class com.github.joschi.jadconfig.documentation.DocumentationFormat
-
Creates an instance of a
DocumentationFormatrecord class. - DocumentationSection - Annotation Interface in com.github.joschi.jadconfig.documentation
- DocumentedBeansService - Interface in com.github.joschi.jadconfig.documentation
- DoubleConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Double - DoubleConverter() - Constructor for class com.github.joschi.jadconfig.converters.DoubleConverter
- dump() - Method in class com.github.joschi.jadconfig.JadConfig
- Duration - Class in com.github.joschi.jadconfig.util
- DurationConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Duration - DurationConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Allow durations to be passed in as number + unit or as ISO8601 duration (standard seconds with millis).
- DurationConverter() - Constructor for class com.github.joschi.jadconfig.converters.DurationConverter
- DurationConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.DurationConverter
E
- entries() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Returns the value of the
entriesrecord component. - entry() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Returns the value of the
entryrecord component. - EnvironmentRepository - Class in com.github.joschi.jadconfig.repositories
-
Repositoryclass providing access to environment variables. - EnvironmentRepository() - Constructor for class com.github.joschi.jadconfig.repositories.EnvironmentRepository
-
Creates a new instance of
EnvironmentRepositorywith the default settings, i. e. no prefix and keys looked up in upper case. - EnvironmentRepository(boolean) - Constructor for class com.github.joschi.jadconfig.repositories.EnvironmentRepository
-
Creates a new instance of
EnvironmentRepositorywith an empty prefix. - EnvironmentRepository(String) - Constructor for class com.github.joschi.jadconfig.repositories.EnvironmentRepository
-
Creates a new instance of
EnvironmentRepositorywith the given prefix. - EnvironmentRepository(String, boolean) - Constructor for class com.github.joschi.jadconfig.repositories.EnvironmentRepository
-
Creates a new instance of
EnvironmentRepositorywith the given prefix. - equals(Object) - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.joschi.jadconfig.documentation.DocumentationFormat
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.github.joschi.jadconfig.TypeReference
- equals(Object) - Method in class com.github.joschi.jadconfig.util.Duration
- equals(Object) - Method in class com.github.joschi.jadconfig.util.Size
F
- fallbackPropertyName() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Optional fallback name of the configuration option in the
RepositoryUsed only when the original name inParameter.value()doesn't deliver any results in the repository. - fieldName() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
fieldNamerecord component. - FileConverter - Class in com.github.joschi.jadconfig.converters
-
Class to convertFrom a given file name to a
Fileobject - FileConverter() - Constructor for class com.github.joschi.jadconfig.converters.FileConverter
- FilePathExecutableValidator - Class in com.github.joschi.jadconfig.validators
- FilePathExecutableValidator() - Constructor for class com.github.joschi.jadconfig.validators.FilePathExecutableValidator
- FilePathReadableValidator - Class in com.github.joschi.jadconfig.validators
- FilePathReadableValidator() - Constructor for class com.github.joschi.jadconfig.validators.FilePathReadableValidator
- FilePathWritableValidator - Class in com.github.joschi.jadconfig.validators
- FilePathWritableValidator() - Constructor for class com.github.joschi.jadconfig.validators.FilePathWritableValidator
- FileReadableValidator - Class in com.github.joschi.jadconfig.validators
- FileReadableValidator() - Constructor for class com.github.joschi.jadconfig.validators.FileReadableValidator
- FileWritableValidator - Class in com.github.joschi.jadconfig.validators
- FileWritableValidator() - Constructor for class com.github.joschi.jadconfig.validators.FileWritableValidator
- FloatConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Float - FloatConverter() - Constructor for class com.github.joschi.jadconfig.converters.FloatConverter
- flush() - Method in class com.github.joschi.jadconfig.documentation.printers.ConfigFileDocsPrinter
- flush() - Method in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- format() - Method in record class com.github.joschi.jadconfig.documentation.DocumentationFormat
-
Returns the value of the
formatrecord component.
G
- generateDocumentation(DocumentationFormat, Supplier<List<Object>>) - Method in class com.github.joschi.jadconfig.documentation.ConfigurationDocsGenerator
- getAllFields(Class<?>) - Static method in class com.github.joschi.jadconfig.ReflectionUtils
- getAllMethods(Class<?>) - Static method in class com.github.joschi.jadconfig.ReflectionUtils
- getConfigurationBean() - Method in class com.github.joschi.jadconfig.response.ProcessingOutcome
- getConfigurationBeans() - Method in class com.github.joschi.jadconfig.JadConfig
-
Get an unmodifiable list of registered configuration beans.
- getConverter(Class<T>) - Method in interface com.github.joschi.jadconfig.ConverterFactory
-
Finds and returns a
Converterfor the provided class type. - getConverter(Class<T>) - Method in class com.github.joschi.jadconfig.DefaultConverterFactory
-
Finds and returns a
Converterfor the provided classType. - getConverter(Class<T>) - Method in class com.github.joschi.jadconfig.guava.GuavaConverterFactory
-
Finds and returns a
Converterfor the provided class type. - getConverter(Class<T>) - Method in class com.github.joschi.jadconfig.jodatime.JodaTimeConverterFactory
-
Finds and returns a
Converterfor the provided classType. - getConverterFactories() - Method in class com.github.joschi.jadconfig.JadConfig
-
Get an unmodifiable list of registered converter factories.
- getDocumentedConfigurationBeans() - Method in interface com.github.joschi.jadconfig.documentation.DocumentedBeansService
- getFieldProcessingProblems() - Method in class com.github.joschi.jadconfig.response.ProcessingOutcome
- getFieldValue(Object, Field) - Static method in class com.github.joschi.jadconfig.ReflectionUtils
- getOutcomes() - Method in class com.github.joschi.jadconfig.response.ProcessingResponse
- getProcessingResponse() - Method in exception class com.github.joschi.jadconfig.LazyValidationException
- getPropertiesFile() - Method in class com.github.joschi.jadconfig.repositories.PropertiesRepository
- getQuantity() - Method in class com.github.joschi.jadconfig.util.Duration
- getQuantity() - Method in class com.github.joschi.jadconfig.util.Size
- getRepositories() - Method in class com.github.joschi.jadconfig.JadConfig
-
Get an unmodifiable list of registered repositories.
- getType() - Method in class com.github.joschi.jadconfig.TypeReference
-
Gets the referenced type.
- getUnit() - Method in class com.github.joschi.jadconfig.util.Duration
- getUnit() - Method in class com.github.joschi.jadconfig.util.Size
- getValidationMethodsProblems() - Method in class com.github.joschi.jadconfig.response.ProcessingOutcome
- gigabytes(long) - Static method in class com.github.joschi.jadconfig.util.Size
- GIGABYTES - Enum constant in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Gigabytes.
- GuavaConverterFactory - Class in com.github.joschi.jadconfig.guava
-
ConverterFactoryfor holding theConverterclasses for Google Guava support. - GuavaConverterFactory() - Constructor for class com.github.joschi.jadconfig.guava.GuavaConverterFactory
H
- hashCode() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.joschi.jadconfig.documentation.DocumentationFormat
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Returns a hash code value for this object.
- hashCode() - Method in class com.github.joschi.jadconfig.TypeReference
- hashCode() - Method in class com.github.joschi.jadconfig.util.Duration
- hashCode() - Method in class com.github.joschi.jadconfig.util.Size
- HashCodeConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
HashCode. - HashCodeConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.HashCodeConverter
- hasPriority() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
- hasPriority() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
- hasProblems() - Method in class com.github.joschi.jadconfig.response.ProcessingOutcome
- hasSection() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
- HEADER_DEFAULT_VALUE - Static variable in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- HEADER_DESCRIPTION - Static variable in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- HEADER_PARAMETER - Static variable in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- HEADER_REQUIRED - Static variable in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- HEADER_TYPE - Static variable in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- HEADERS - Static variable in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- heading() - Element in annotation interface com.github.joschi.jadconfig.documentation.DocumentationSection
- heading() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Returns the value of the
headingrecord component. - HostAndPortConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
HostAndPort. - HostAndPortConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.HostAndPortConverter
- HostSpecifierConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
HostSpecifier. - HostSpecifierConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.HostSpecifierConverter
- hours(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- HoursConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Hours - HoursConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.HoursConverter
I
- Inet4AddressConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Inet4Address - Inet4AddressConverter() - Constructor for class com.github.joschi.jadconfig.converters.Inet4AddressConverter
- Inet6AddressConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Inet6Address - Inet6AddressConverter() - Constructor for class com.github.joschi.jadconfig.converters.Inet6AddressConverter
- InetAddressConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
InetAddress - InetAddressConverter() - Constructor for class com.github.joschi.jadconfig.converters.InetAddressConverter
- InetPortValidator - Class in com.github.joschi.jadconfig.validators
-
Validatorclass which checks if the named parameter is a valid UDP/TCP port (0-65535). - InetPortValidator() - Constructor for class com.github.joschi.jadconfig.validators.InetPortValidator
- InetSocketAddressConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
InetSocketAddress - InetSocketAddressConverter() - Constructor for class com.github.joschi.jadconfig.converters.InetSocketAddressConverter
- InMemoryRepository - Class in com.github.joschi.jadconfig.repositories
-
Repositoryclass providing access to a simple configuration repository backed byHashMap - InMemoryRepository() - Constructor for class com.github.joschi.jadconfig.repositories.InMemoryRepository
- InMemoryRepository(Map<String, String>) - Constructor for class com.github.joschi.jadconfig.repositories.InMemoryRepository
- IntegerConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Integer - IntegerConverter() - Constructor for class com.github.joschi.jadconfig.converters.IntegerConverter
- InternetDomainNameConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
InternetDomainName. - InternetDomainNameConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.InternetDomainNameConverter
- IntervalConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Interval - IntervalConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.IntervalConverter
- invokeMethodsWithAnnotation(Object, Class<? extends Annotation>, Method[]) - Static method in class com.github.joschi.jadconfig.ReflectionUtils
- isSuccess() - Method in class com.github.joschi.jadconfig.response.ProcessingResponse
J
- JadConfig - Class in com.github.joschi.jadconfig
-
The main class for JadConfig.
- JadConfig() - Constructor for class com.github.joschi.jadconfig.JadConfig
-
Creates a new (empty) instance of JadConfig.
- JadConfig(Repository, Object...) - Constructor for class com.github.joschi.jadconfig.JadConfig
-
Creates a new instance of JadConfig backed by the provided
Repositoryand filling the provided configurationBeans. - JadConfig(Collection<Repository>, Object...) - Constructor for class com.github.joschi.jadconfig.JadConfig
-
Creates a new instance of JadConfig backed by the provided
Repositorys and filling the provided configurationBeans. - JodaTimeConverterFactory - Class in com.github.joschi.jadconfig.jodatime
-
ConverterFactoryfor holding theConverterclasses for Joda-Time support. - JodaTimeConverterFactory() - Constructor for class com.github.joschi.jadconfig.jodatime.JodaTimeConverterFactory
K
- kilobytes(long) - Static method in class com.github.joschi.jadconfig.util.Size
- KILOBYTES - Enum constant in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Kilobytes.
L
- LazyValidationException - Exception Class in com.github.joschi.jadconfig
- LazyValidationException(ProcessingResponse) - Constructor for exception class com.github.joschi.jadconfig.LazyValidationException
- loadConfigurationBeans() - Static method in class com.github.joschi.jadconfig.documentation.ConfigurationBeansSPI
- LocaleConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Locale - LocaleConverter() - Constructor for class com.github.joschi.jadconfig.converters.LocaleConverter
- LongConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Long - LongConverter() - Constructor for class com.github.joschi.jadconfig.converters.LongConverter
M
- main(String[]) - Static method in class com.github.joschi.jadconfig.documentation.ConfigurationDocsGenerator
- MediaTypeConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
MediaType. - MediaTypeConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.MediaTypeConverter
- megabytes(long) - Static method in class com.github.joschi.jadconfig.util.Size
- MEGABYTES - Enum constant in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Megabytes.
- microseconds(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- milliseconds(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- minutes(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- MinutesConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Minutes - MinutesConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.MinutesConverter
- MonthsConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Months - MonthsConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.MonthsConverter
N
- NamedConfigParametersModule - Class in com.github.joschi.jadconfig.guice
-
A Guice module which registers all fields of the provided objects annotated with
Parameteras named bindings and optionally also adds bindings of the object instances themselves. - NamedConfigParametersModule(Collection) - Constructor for class com.github.joschi.jadconfig.guice.NamedConfigParametersModule
-
Create a new
NamedConfigParametersModuleinstance and add bindings for the instances inbeans. - NamedConfigParametersModule(Collection, boolean) - Constructor for class com.github.joschi.jadconfig.guice.NamedConfigParametersModule
-
Create a new
NamedConfigParametersModuleinstance. - nanoseconds(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- newInstance() - Method in class com.github.joschi.jadconfig.TypeReference
-
Instantiates a new instance of
Tusing the default, no-arg constructor. - NoConverter - Class in com.github.joschi.jadconfig.converters
-
No-operation converter being used as default for
Parameter.converter(). - NoConverter() - Constructor for class com.github.joschi.jadconfig.converters.NoConverter
- NoValidator - Class in com.github.joschi.jadconfig.validators
-
Validatorclass doing nothing being used as default validator - NoValidator() - Constructor for class com.github.joschi.jadconfig.validators.NoValidator
O
- open() - Method in class com.github.joschi.jadconfig.repositories.EnvironmentRepository
- open() - Method in class com.github.joschi.jadconfig.repositories.InMemoryRepository
- open() - Method in class com.github.joschi.jadconfig.repositories.PropertiesRepository
-
Opens the properties file and reads its
Properties - open() - Method in class com.github.joschi.jadconfig.repositories.SystemPropertiesRepository
- open() - Method in interface com.github.joschi.jadconfig.Repository
-
Opens the configuration repository, e. g. create a database connection, open a file on disk for reading
- outputFile() - Method in record class com.github.joschi.jadconfig.documentation.DocumentationFormat
-
Returns the value of the
outputFilerecord component.
P
- Parameter - Annotation Interface in com.github.joschi.jadconfig
-
Annotation to mark a configuration parameter in a configuration bean
- ParameterException - Exception Class in com.github.joschi.jadconfig
-
This exception indicates an error while processing a configuration parameter.
- ParameterException() - Constructor for exception class com.github.joschi.jadconfig.ParameterException
- ParameterException(String) - Constructor for exception class com.github.joschi.jadconfig.ParameterException
- ParameterException(String, Throwable) - Constructor for exception class com.github.joschi.jadconfig.ParameterException
- ParameterException(Throwable) - Constructor for exception class com.github.joschi.jadconfig.ParameterException
- parse(String) - Static method in class com.github.joschi.jadconfig.util.Duration
- parse(String) - Static method in class com.github.joschi.jadconfig.util.Size
- PathConverter - Class in com.github.joschi.jadconfig.converters
-
Class to convertFrom a given file name to a
Fileobject - PathConverter() - Constructor for class com.github.joschi.jadconfig.converters.PathConverter
- PathExecutableValidator - Class in com.github.joschi.jadconfig.validators
- PathExecutableValidator() - Constructor for class com.github.joschi.jadconfig.validators.PathExecutableValidator
- PathReadableValidator - Class in com.github.joschi.jadconfig.validators
- PathReadableValidator() - Constructor for class com.github.joschi.jadconfig.validators.PathReadableValidator
- PathWritableValidator - Class in com.github.joschi.jadconfig.validators
- PathWritableValidator() - Constructor for class com.github.joschi.jadconfig.validators.PathWritableValidator
- PatternConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Pattern - PatternConverter() - Constructor for class com.github.joschi.jadconfig.converters.PatternConverter
- PeriodConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Allow periods to be passed in as number + unit or as a
ISOPeriodFormat(standard, without millis). - PeriodConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.PeriodConverter
- petabytes(long) - Static method in class com.github.joschi.jadconfig.util.Size
- PETABYTES - Enum constant in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Petabytes.
- PositiveDurationValidator - Class in com.github.joschi.jadconfig.validators
- PositiveDurationValidator() - Constructor for class com.github.joschi.jadconfig.validators.PositiveDurationValidator
- PositiveIntegerValidator - Class in com.github.joschi.jadconfig.validators
-
Validatorclass which checks if the named parameter is a positive integer. - PositiveIntegerValidator() - Constructor for class com.github.joschi.jadconfig.validators.PositiveIntegerValidator
- PositiveLongValidator - Class in com.github.joschi.jadconfig.validators
-
Validatorclass which checks if the named parameter is a positive long. - PositiveLongValidator() - Constructor for class com.github.joschi.jadconfig.validators.PositiveLongValidator
- PositiveSizeValidator - Class in com.github.joschi.jadconfig.validators
- PositiveSizeValidator() - Constructor for class com.github.joschi.jadconfig.validators.PositiveSizeValidator
- process() - Method in class com.github.joschi.jadconfig.JadConfig
-
Processes the configuration provided by the configured
Repositoryand filling the provided configuration beans. - processFailingLazily() - Method in class com.github.joschi.jadconfig.JadConfig
-
Processes the configuration provided by the configured
Repositoryand filling the provided configuration beans. - ProcessingOutcome - Class in com.github.joschi.jadconfig.response
- ProcessingOutcome(Object, Map<String, Exception>, Map<String, Exception>) - Constructor for class com.github.joschi.jadconfig.response.ProcessingOutcome
- ProcessingResponse - Class in com.github.joschi.jadconfig.response
- ProcessingResponse(List<ProcessingOutcome>) - Constructor for class com.github.joschi.jadconfig.response.ProcessingResponse
- PropertiesRepository - Class in com.github.joschi.jadconfig.repositories
-
Repositoryclass providing access to a configuration repository backed byPropertiesfiles - PropertiesRepository(File) - Constructor for class com.github.joschi.jadconfig.repositories.PropertiesRepository
-
Creates a new
PropertiesRepositoryfrom the provided propertiesFile - PropertiesRepository(String) - Constructor for class com.github.joschi.jadconfig.repositories.PropertiesRepository
-
Creates a new
PropertiesRepositoryfrom the provided properties file filename
R
- read(String) - Method in class com.github.joschi.jadconfig.repositories.EnvironmentRepository
- read(String) - Method in class com.github.joschi.jadconfig.repositories.InMemoryRepository
- read(String) - Method in class com.github.joschi.jadconfig.repositories.PropertiesRepository
-
Returns the value for a property name or null
- read(String) - Method in class com.github.joschi.jadconfig.repositories.SystemPropertiesRepository
- read(String) - Method in interface com.github.joschi.jadconfig.Repository
-
Reads the configuration parameter name from the backing data source.
- ReflectionUtils - Class in com.github.joschi.jadconfig
-
Reflection related helper class.
- Repository - Interface in com.github.joschi.jadconfig
-
Interface for configuration repositories
- RepositoryException - Exception Class in com.github.joschi.jadconfig
-
This exception indicates that an error occurred while using a
Repository. - RepositoryException() - Constructor for exception class com.github.joschi.jadconfig.RepositoryException
- RepositoryException(String) - Constructor for exception class com.github.joschi.jadconfig.RepositoryException
- RepositoryException(String, Throwable) - Constructor for exception class com.github.joschi.jadconfig.RepositoryException
- RepositoryException(Throwable) - Constructor for exception class com.github.joschi.jadconfig.RepositoryException
- required() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
requiredrecord component. - required() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Whether this is a required parameter.
S
- seconds(long) - Static method in class com.github.joschi.jadconfig.util.Duration
- SecondsConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Seconds - SecondsConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.SecondsConverter
- sectionDescription() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Returns the value of the
sectionDescriptionrecord component. - sectionHeading() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Returns the value of the
sectionHeadingrecord component. - sections() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Returns the value of the
sectionsrecord component. - setPropertiesFile(File) - Method in class com.github.joschi.jadconfig.repositories.PropertiesRepository
- setRepositories(Repository...) - Method in class com.github.joschi.jadconfig.JadConfig
-
Set the (sorted) list of
Repositorys to load configuration data from. - setRepositories(Collection<Repository>) - Method in class com.github.joschi.jadconfig.JadConfig
-
Set the (sorted) list of
Repositorys to load configuration data from. - setRepository(Repository) - Method in class com.github.joschi.jadconfig.JadConfig
-
Set the
Repositoryto load configuration data from. - ShortConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Short - ShortConverter() - Constructor for class com.github.joschi.jadconfig.converters.ShortConverter
- size() - Method in class com.github.joschi.jadconfig.repositories.EnvironmentRepository
- size() - Method in class com.github.joschi.jadconfig.repositories.InMemoryRepository
- size() - Method in class com.github.joschi.jadconfig.repositories.SystemPropertiesRepository
- Size - Class in com.github.joschi.jadconfig.util
- SizeConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
Size - SizeConverter() - Constructor for class com.github.joschi.jadconfig.converters.SizeConverter
- SizeUnit - Enum Class in com.github.joschi.jadconfig.util
-
A unit of size.
- SizeUnitConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
SizeUnit - SizeUnitConverter() - Constructor for class com.github.joschi.jadconfig.converters.SizeUnitConverter
- StringConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
String - StringConverter() - Constructor for class com.github.joschi.jadconfig.converters.StringConverter
- StringListConverter - Class in com.github.joschi.jadconfig.converters
-
Class for converting a comma-separated list to
List<String> - StringListConverter() - Constructor for class com.github.joschi.jadconfig.converters.StringListConverter
- StringLowercaseValidator - Class in com.github.joschi.jadconfig.validators
- StringLowercaseValidator() - Constructor for class com.github.joschi.jadconfig.validators.StringLowercaseValidator
- StringNotBlankValidator - Class in com.github.joschi.jadconfig.validators
- StringNotBlankValidator() - Constructor for class com.github.joschi.jadconfig.validators.StringNotBlankValidator
- StringNotEmptyValidator - Class in com.github.joschi.jadconfig.validators
- StringNotEmptyValidator() - Constructor for class com.github.joschi.jadconfig.validators.StringNotEmptyValidator
- Strings - Class in com.github.joschi.jadconfig
-
Utility functions for
String - StringSetConverter - Class in com.github.joschi.jadconfig.converters
-
Class for converting a comma-separated list to
Set<String> - StringSetConverter() - Constructor for class com.github.joschi.jadconfig.converters.StringSetConverter
- StringSortedSetConverter - Class in com.github.joschi.jadconfig.converters
-
Class for converting a comma-separated list to
SortedSet<String> - StringSortedSetConverter() - Constructor for class com.github.joschi.jadconfig.converters.StringSortedSetConverter
- StringUppercaseValidator - Class in com.github.joschi.jadconfig.validators
- StringUppercaseValidator() - Constructor for class com.github.joschi.jadconfig.validators.StringUppercaseValidator
- SystemPropertiesRepository - Class in com.github.joschi.jadconfig.repositories
-
Repositoryclass providing access to System properties. - SystemPropertiesRepository() - Constructor for class com.github.joschi.jadconfig.repositories.SystemPropertiesRepository
-
Creates a new instance of
SystemPropertiesRepositorywith the default settings, i. e. no prefix. - SystemPropertiesRepository(String) - Constructor for class com.github.joschi.jadconfig.repositories.SystemPropertiesRepository
-
Creates a new instance of
SystemPropertiesRepositorywith the given prefix.
T
- terabytes(long) - Static method in class com.github.joschi.jadconfig.util.Size
- TERABYTES - Enum constant in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Terabytes.
- TimeUnitConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
TimeUnit - TimeUnitConverter() - Constructor for class com.github.joschi.jadconfig.converters.TimeUnitConverter
- TimeZoneConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
TimeZone - TimeZoneConverter() - Constructor for class com.github.joschi.jadconfig.converters.TimeZoneConverter
- toBytes() - Method in class com.github.joschi.jadconfig.util.Size
- toBytes(long) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts the given number of the current units into bytes.
- toDays() - Method in class com.github.joschi.jadconfig.util.Duration
- toGigabytes() - Method in class com.github.joschi.jadconfig.util.Size
- toGigabytes(long) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts the given number of the current units into gigabytes.
- toHours() - Method in class com.github.joschi.jadconfig.util.Duration
- toKilobytes() - Method in class com.github.joschi.jadconfig.util.Size
- toKilobytes(long) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts the given number of the current units into kilobytes.
- toMegabytes() - Method in class com.github.joschi.jadconfig.util.Size
- toMegabytes(long) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts the given number of the current units into megabytes.
- toMicroseconds() - Method in class com.github.joschi.jadconfig.util.Duration
- toMilliseconds() - Method in class com.github.joschi.jadconfig.util.Duration
- toMinutes() - Method in class com.github.joschi.jadconfig.util.Duration
- toNanoseconds() - Method in class com.github.joschi.jadconfig.util.Duration
- toPetabytes() - Method in class com.github.joschi.jadconfig.util.Size
- toPetabytes(long) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts the given number of the current units into petabytes.
- toSeconds() - Method in class com.github.joschi.jadconfig.util.Duration
- toString() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntryWithSection
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.joschi.jadconfig.documentation.DocumentationFormat
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.joschi.jadconfig.documentation.printers.ConfigurationSection
-
Returns a string representation of this record class.
- toString() - Method in class com.github.joschi.jadconfig.TypeReference
- toString() - Method in class com.github.joschi.jadconfig.util.Duration
- toString() - Method in class com.github.joschi.jadconfig.util.Size
- toTerabytes() - Method in class com.github.joschi.jadconfig.util.Size
- toTerabytes(long) - Method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Converts the given number of the current units into terabytes.
- trim() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Whether this parameter value should be trimmed before processing.
- trim(String) - Static method in class com.github.joschi.jadconfig.Strings
-
Returns a copy of the string, with leading and trailing whitespace omitted.
- TrimmedStringListConverter - Class in com.github.joschi.jadconfig.converters
-
Class for converting a comma-separated list to a
List<String>of trimmed strings. - TrimmedStringListConverter() - Constructor for class com.github.joschi.jadconfig.converters.TrimmedStringListConverter
- TrimmedStringSetConverter - Class in com.github.joschi.jadconfig.converters
-
Class for converting a comma-separated list to a
Set<String>of trimmed strings. - TrimmedStringSetConverter() - Constructor for class com.github.joschi.jadconfig.converters.TrimmedStringSetConverter
- TrimmedStringSortedSetConverter - Class in com.github.joschi.jadconfig.converters
-
Class for converting a comma-separated list to a
SortedSet<String>of trimmed strings. - TrimmedStringSortedSetConverter() - Constructor for class com.github.joschi.jadconfig.converters.TrimmedStringSortedSetConverter
- type() - Method in record class com.github.joschi.jadconfig.documentation.ConfigurationEntry
-
Returns the value of the
typerecord component. - TypeReference<T> - Class in com.github.joschi.jadconfig
-
References a generic type.
U
- UnsignedIntegerConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
UnsignedInteger. - UnsignedIntegerConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.UnsignedIntegerConverter
- UnsignedLongConverter - Class in com.github.joschi.jadconfig.guava.converters
-
Converter for type
UnsignedLong. - UnsignedLongConverter() - Constructor for class com.github.joschi.jadconfig.guava.converters.UnsignedLongConverter
- URIAbsoluteValidator - Class in com.github.joschi.jadconfig.validators
- URIAbsoluteValidator() - Constructor for class com.github.joschi.jadconfig.validators.URIAbsoluteValidator
- URIConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
URI - URIConverter() - Constructor for class com.github.joschi.jadconfig.converters.URIConverter
- URLConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
URL - URLConverter() - Constructor for class com.github.joschi.jadconfig.converters.URLConverter
- UUIDConverter - Class in com.github.joschi.jadconfig.converters
-
Converter for type
UUID - UUIDConverter() - Constructor for class com.github.joschi.jadconfig.converters.UUIDConverter
V
- validate(String, Duration) - Method in class com.github.joschi.jadconfig.validators.PositiveDurationValidator
-
Validates if the value value the of provided configuration parameter name is a positive
Duration - validate(String, Size) - Method in class com.github.joschi.jadconfig.validators.PositiveSizeValidator
-
Validates if the value value the of provided configuration parameter name is a positive
Size - validate(String, File) - Method in class com.github.joschi.jadconfig.validators.DirectoryReadableValidator
- validate(String, File) - Method in class com.github.joschi.jadconfig.validators.DirectoryWritableValidator
- validate(String, File) - Method in class com.github.joschi.jadconfig.validators.FileReadableValidator
- validate(String, File) - Method in class com.github.joschi.jadconfig.validators.FileWritableValidator
- validate(String, Integer) - Method in class com.github.joschi.jadconfig.validators.InetPortValidator
-
Validates if the value value the of provided configuration parameter name is a valid UDP/TCP port (0-65535)
- validate(String, Integer) - Method in class com.github.joschi.jadconfig.validators.PositiveIntegerValidator
-
Validates if the value value the of provided configuration parameter name is a positive integer
- validate(String, Long) - Method in class com.github.joschi.jadconfig.validators.PositiveLongValidator
-
Validates if the value value the of provided configuration parameter name is a positive long
- validate(String, Object) - Method in class com.github.joschi.jadconfig.validators.NoValidator
-
Does nothing and is being used as default
Validator.validate(String, Object)method - validate(String, String) - Method in class com.github.joschi.jadconfig.validators.StringLowercaseValidator
-
Validates if the value value the of provided configuration parameter name is an lowercase
String - validate(String, String) - Method in class com.github.joschi.jadconfig.validators.StringNotBlankValidator
-
Validates if the value value the of provided configuration parameter name is a non-blank
String - validate(String, String) - Method in class com.github.joschi.jadconfig.validators.StringNotEmptyValidator
-
Validates if the value value the of provided configuration parameter name is a non-empty
String - validate(String, String) - Method in class com.github.joschi.jadconfig.validators.StringUppercaseValidator
-
Validates if the value value the of provided configuration parameter name is an uppercase
String - validate(String, URI) - Method in class com.github.joschi.jadconfig.validators.URIAbsoluteValidator
-
Validates if the value value the of provided configuration parameter name is an absolute
URI. - validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.DirectoryPathReadableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.DirectoryPathWritableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.FilePathExecutableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.FilePathReadableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.FilePathWritableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.PathExecutableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.PathReadableValidator
- validate(String, Path) - Method in class com.github.joschi.jadconfig.validators.PathWritableValidator
- validate(String, T) - Method in interface com.github.joschi.jadconfig.Validator
-
Validates the value value the of provided configuration parameter name
- ValidationException - Exception Class in com.github.joschi.jadconfig
-
This exception indicates that a configuration parameter's value couldn't be validated successfully by a
Validator - ValidationException() - Constructor for exception class com.github.joschi.jadconfig.ValidationException
- ValidationException(String) - Constructor for exception class com.github.joschi.jadconfig.ValidationException
- ValidationException(String, Throwable) - Constructor for exception class com.github.joschi.jadconfig.ValidationException
- ValidationException(Throwable) - Constructor for exception class com.github.joschi.jadconfig.ValidationException
- validator() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Deprecated.
- Validator<T> - Interface in com.github.joschi.jadconfig
-
Interface for parameter validators
- ValidatorMethod - Annotation Interface in com.github.joschi.jadconfig
-
Annotation marking the validator methods in a configuration bean to facilitate more complex checks
- validators() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Specific
Validators to use for this parameter. - value() - Element in annotation interface com.github.joschi.jadconfig.documentation.Documentation
-
Description of this configuration property.
- value() - Element in annotation interface com.github.joschi.jadconfig.Parameter
-
Name of the configuration option in the
Repository - valueOf(String) - Static method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.joschi.jadconfig.util.SizeUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visible() - Element in annotation interface com.github.joschi.jadconfig.documentation.Documentation
-
We don't want to expose some configuration fields to users.
W
- WeeksConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Weeks - WeeksConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.WeeksConverter
- write(List<ConfigurationSection>) - Method in class com.github.joschi.jadconfig.documentation.printers.ConfigFileDocsPrinter
- write(List<ConfigurationSection>) - Method in class com.github.joschi.jadconfig.documentation.printers.CsvDocsPrinter
- write(List<ConfigurationSection>) - Method in interface com.github.joschi.jadconfig.documentation.printers.DocsPrinter
Y
- YearsConverter - Class in com.github.joschi.jadconfig.jodatime.converters
-
Converter for type
Years - YearsConverter() - Constructor for class com.github.joschi.jadconfig.jodatime.converters.YearsConverter
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
Parameter.validators()instead.