Module org.refcodes.properties.ext.runtime

Package org.refcodes.properties.ext.runtime

Interface RuntimeProperties

All Superinterfaces:

org.refcodes.mixin.AnnotatorAccessor, org.refcodes.cli.ArgsParser, org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>, ArgsParserProperties, ArgsParserPropertiesAccessor, org.refcodes.cli.ArgsSyntaxAccessor, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<RuntimeProperties>, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator, org.refcodes.cli.ArgumentEscapeCodeAccessor, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty, org.refcodes.struct.CanonicalMap, org.refcodes.cli.CliMetrics, org.refcodes.struct.Containable, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty, org.refcodes.struct.Dictionary<String,String>, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.Keys<String,String>, org.refcodes.cli.LongOptionPrefixAccessor, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty, org.refcodes.cli.Optionable, org.refcodes.cli.OptionEscapeCodeAccessor, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty, org.refcodes.struct.PathMap<String>, org.refcodes.properties.ProfileProperties, org.refcodes.properties.Properties, org.refcodes.mixin.Resetable, org.refcodes.mixin.ResetEscapeCodeAccessor, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty, org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>, org.refcodes.properties.ResourceProperties, org.refcodes.mixin.SecretAccessor.SecretBuilder<RuntimeProperties>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.cli.ShortOptionPrefixAccessor, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty, org.refcodes.cli.SyntaxMetricsAccessor, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty, org.refcodes.textual.TextBoxGridAccessor, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty, org.refcodes.mixin.TitleAccessor, org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ArgsParser>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty, org.refcodes.mixin.TypeAccessor<String>

All Known Implementing Classes:

RuntimePropertiesImpl

public interface RuntimeProperties
extends org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<RuntimeProperties>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.SecretAccessor.SecretBuilder<RuntimeProperties>, ArgsParserProperties, org.refcodes.properties.ResourceProperties, org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>, org.refcodes.properties.ProfileProperties, ArgsParserPropertiesAccessor

RuntimeProperties are composed of various Properties flavors such as ArgsParserProperties, SystemProperties, EnvironmentProperties and ResourceProperties with a precedence in this order, encapsulated by a ProfilePropertiesProjection in order for you, the developer, to conveniently harness the power of the Properties functionality. You may also add a Properties instance programmatically to manually provide properties (via withProperties(Properties)). The later you add Properties, the lower their precedence. After construction the use withFile(java.io.File), withUrl(java.net.URL) or the like to load the properties from external resources. After construction use withEvalArgs(String[]) or the like to parse the command line arguments (implementations might provide a constructor such as RuntimePropertiesImpl(String[]) for the command line arguments if you do not require a command syntax notation). RuntimeProperties represent a composition of the different Properties flavors, therefore providing functionality from the ArgsParserProperties as well as from the ResourceProperties types.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AnnotatorAccessor

org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B extends org.refcodes.mixin.AnnotatorAccessor.AnnotatorBuilder<B>>, org.refcodes.mixin.AnnotatorAccessor.AnnotatorMutator, org.refcodes.mixin.AnnotatorAccessor.AnnotatorProperty

Nested classes/interfaces inherited from interface org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor

ArgsParserPropertiesAccessor.ArgsParserPropertiesBuilder<B extends ArgsParserPropertiesAccessor.ArgsParserPropertiesBuilder<B>>, ArgsParserPropertiesAccessor.ArgsParserPropertiesMutator, ArgsParserPropertiesAccessor.ArgsParserPropertiesProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.ArgsSyntaxAccessor

org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<B extends org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<B>>, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.ArgumentEscapeCodeAccessor

org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B extends org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<B>>, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.CanonicalMap

org.refcodes.struct.CanonicalMap.CanonicalMapBuilder, org.refcodes.struct.CanonicalMap.MutableCanonicalMap

Nested classes/interfaces inherited from interface org.refcodes.mixin.DelimiterAccessor

org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B extends org.refcodes.mixin.DelimiterAccessor.DelimiterBuilder<B>>, org.refcodes.mixin.DelimiterAccessor.DelimiterMutator, org.refcodes.mixin.DelimiterAccessor.DelimiterProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.DescriptionAccessor

org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B extends org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<B>>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.Dictionary

org.refcodes.struct.Dictionary.MutableDictionary<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.mixin.EmptyAccessor

org.refcodes.mixin.EmptyAccessor.EmptyMutator, org.refcodes.mixin.EmptyAccessor.EmptyProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor

org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B extends org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<B>>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.InterOperableMap

org.refcodes.struct.InterOperableMap.InterOperableMapBuilder<T extends Object>, org.refcodes.struct.InterOperableMap.MutableInterOperableMap<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

org.refcodes.struct.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface org.refcodes.cli.LongOptionPrefixAccessor

org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<B extends org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<B>>, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.OptionEscapeCodeAccessor

org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B extends org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<B>>, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.struct.PathMap

org.refcodes.struct.PathMap.MutablePathMap<T extends Object>, org.refcodes.struct.PathMap.PathMapBuilder<T extends Object>

Nested classes/interfaces inherited from interface org.refcodes.properties.ProfileProperties

org.refcodes.properties.ProfileProperties.MutableProfileProperties, org.refcodes.properties.ProfileProperties.ProfilePropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.properties.Properties

org.refcodes.properties.Properties.MutableProperties, org.refcodes.properties.Properties.PropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor

org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B extends org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<B>>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty

Nested classes/interfaces inherited from interface org.refcodes.properties.ResourceProperties

org.refcodes.properties.ResourceProperties.MutableResoureProperties, org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder

Nested classes/interfaces inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor

org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B extends org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<B>>, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty

Nested classes/interfaces inherited from interface org.refcodes.cli.SyntaxMetricsAccessor

org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<B extends org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<B>>, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty

Nested classes/interfaces inherited from interface org.refcodes.textual.TextBoxGridAccessor

org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<B extends org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<?>>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TitleAccessor

org.refcodes.mixin.TitleAccessor.TitleBuilder<B extends org.refcodes.mixin.TitleAccessor.TitleBuilder<B>>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeBuilder<T extends Object,B extends org.refcodes.mixin.TypeAccessor.TypeBuilder<T,B>>, org.refcodes.mixin.TypeAccessor.TypeMutator<T extends Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final char[]	DELIMITERS

Fields inherited from interface org.refcodes.struct.PathMap

ANNOTATOR, DELIMITER

Fields inherited from interface org.refcodes.properties.Properties

DEFAULT_COMMENT

Method Summary

Modifier and Type	Method	Description
void	setObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)	Specifies the obfuscation mode to be used.
String	toSerialized()	The behavior of this method is implementation specific.
String	toSerialized(char aDelimiter)	The behavior of this method is implementation specific.
default RuntimeProperties	withArgsSyntax(org.refcodes.cli.Constituent aArgsSyntax)
default RuntimeProperties	withArgumentEscapeCode(String aParamEscCode)
default RuntimeProperties	withBannerBorderEscapeCode(String aBannerBorderEscCode)
default RuntimeProperties	withBannerEscapeCode(String aBannerEscCode)
default RuntimeProperties	withBannerFont(org.refcodes.textual.Font aBannerFont)
default RuntimeProperties	withBannerFontPalette(char[] aColorPalette)
default RuntimeProperties	withCommandEscapeCode(String aCommandEscCode)
default RuntimeProperties	withConsoleWidth(int aConsoleWidth)
default RuntimeProperties	withCopyrightNote(String aCopyrightNote)
default RuntimeProperties	withDescription(String aDescription)
default RuntimeProperties	withDescriptionEscapeCode(String aDescriptionEscCode)
default RuntimeProperties	withErrorOut(PrintStream aErrorOut)
default RuntimeProperties	withEscapeCodesEnabled(boolean isEscCodeEnabled)
default RuntimeProperties	withEvalArgs(String[] aArgs)
default RuntimeProperties	withEvalArgs(String aToPath, String[] aArgs)
default RuntimeProperties	withEvalArgs(String aToPath, List<String> aArgs)
default RuntimeProperties	withEvalArgs(List<String> aArgs)
default RuntimeProperties	withExample(String aDescription, org.refcodes.cli.Operand<?>... aOperands)
default RuntimeProperties	withExample(org.refcodes.cli.Example aExample)
default RuntimeProperties	withExamples(Collection<org.refcodes.cli.Example> aExample)
default RuntimeProperties	withExamples(org.refcodes.cli.Example[] aExample)
default RuntimeProperties	withFile(File aFile)
default RuntimeProperties	withFile(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator)
default RuntimeProperties	withFilePath(Class<?> aResourceClass, String aFilePath)
default RuntimeProperties	withFilePath(String aFilePath)
default RuntimeProperties	withInputStream(InputStream aInputStream)
default RuntimeProperties	withLicenseNote(String aLicenseNote)
default RuntimeProperties	withLineBreak(String aLineBreak)
default RuntimeProperties	withLineSeparatorEscapeCode(String aLineSeparatorEscCode)
default RuntimeProperties	withLongOptionPrefix(String aLongOptionPrefix)
default RuntimeProperties	withMaxConsoleWidth(int aMaxConsoleWidth)
default RuntimeProperties	withName(String aName)
default RuntimeProperties	withObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)	Builder method for the obfuscation mode property returning the builder for applying multiple build operations.
default RuntimeProperties	withOptionEscapeCode(String aOptionEscCode)
RuntimeProperties	withProperties(org.refcodes.properties.Properties aProperties)	A hook for you to provide Properties programmatically.
default RuntimeProperties	withResetEscapeCode(String aResetEscCode)
default RuntimeProperties	withSecret(String aSecret)
default RuntimeProperties	withSeparatorLnChar(char aSeparatorChar)
default RuntimeProperties	withShortOptionPrefix(Character aShortOptionPrefix)
default RuntimeProperties	withStandardOut(PrintStream aStandardOut)
default RuntimeProperties	withSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)
default RuntimeProperties	withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
default RuntimeProperties	withTitle(String aTitle)
default RuntimeProperties	withUrl(URL aUrl)

Methods inherited from interface org.refcodes.cli.ArgsParser

addExample, addExample, errorLn, evalArgs, evalArgs, evalArgs, evalArgs, getArgsSyntax, getArgumentEscapeCode, getBannerBorderEscapeCode, getBannerEscapeCode, getCommandEscapeCode, getCopyrightNote, getDescription, getDescriptionEscapeCode, getExamples, getLicenseNote, getLineSeparatorEscapeCode, getOptionEscapeCode, getSeparatorLnChar, printBanner, printBody, printCopyrightNote, printDescription, printExamples, printHeader, printHelp, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printSynopsis, setArgumentEscapeCode, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setCommandEscapeCode, setConsoleWidth, setCopyrightNote, setDescriptionEscapeCode, setErrorOut, setLicenseNote, setLineBreak, setLineSeparatorEscapeCode, setMaxConsoleWidth, setOptionEscapeCode, setSeparatorLnChar, setStandardOut, setSyntaxMetrics, toOptions

Methods inherited from interface org.refcodes.cli.ArgsParserMixin

withEvalArgs, withEvalArgs, withEvalArgs, withEvalArgs

Methods inherited from interface org.refcodes.properties.ext.cli.ArgsParserProperties

evalArgs, evalArgs, evalArgs, evalArgs

Methods inherited from interface org.refcodes.properties.ext.cli.ArgsParserPropertiesAccessor

getArgsParserProperties

Methods inherited from interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator

setArgsSyntax

Methods inherited from interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty

letArgumentEscapeCode

Methods inherited from interface org.refcodes.struct.CanonicalMap

asArray, asArray, asArray, asArray, asBooleanArray, asBooleanArray, asBooleanArray, asBooleanArray, asByteArray, asByteArray, asByteArray, asByteArray, asCharArray, asCharArray, asCharArray, asCharArray, asDoubleArray, asDoubleArray, asDoubleArray, asDoubleArray, asFloatArray, asFloatArray, asFloatArray, asFloatArray, asIntArray, asIntArray, asIntArray, asIntArray, asLongArray, asLongArray, asLongArray, asLongArray, asShortArray, asShortArray, asShortArray, asShortArray, queryBetween, toMap, toProperties

Methods inherited from interface org.refcodes.struct.Containable

size

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator

setDescription

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionProperty

letDescription

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface org.refcodes.mixin.EmptyAccessor

isEmpty

Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor

isEscapeCodesEnabled

Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator

setEscapeCodesEnabled

Methods inherited from interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty

letEscapeCodesEnabled

Methods inherited from interface org.refcodes.struct.InterOperableMap

getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getBooleanOr, getByte, getByte, getByte, getByte, getByte, getByteOr, getByteOr, getByteOr, getByteOr, getByteOr, getChar, getChar, getChar, getChar, getChar, getCharOr, getCharOr, getCharOr, getCharOr, getCharOr, getClass, getClass, getClass, getClass, getClass, getClassOr, getClassOr, getClassOr, getClassOr, getClassOr, getDouble, getDouble, getDouble, getDouble, getDouble, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getDoubleOr, getEnum, getEnum, getEnum, getEnum, getEnum, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getEnumOr, getFloat, getFloat, getFloat, getFloat, getFloat, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getFloatOr, getInt, getInt, getInt, getInt, getInt, getIntOr, getIntOr, getIntOr, getIntOr, getIntOr, getLong, getLong, getLong, getLong, getLong, getLongOr, getLongOr, getLongOr, getLongOr, getLongOr, getShort, getShort, getShort, getShort, getShort, getShortOr, getShortOr, getShortOr, getShortOr, getShortOr, getString, getString, getString, getString, getString, getStringOr, getStringOr, getStringOr, getStringOr, getStringOr

Methods inherited from interface org.refcodes.struct.Keys

containsKey, get, getOr, keySet, use, values

Methods inherited from interface org.refcodes.cli.LongOptionPrefixAccessor

getLongOptionPrefix

Methods inherited from interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator

setLongOptionPrefix

Methods inherited from interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty

letLongOptionPrefix

Methods inherited from interface org.refcodes.mixin.NameAccessor

getName

Methods inherited from interface org.refcodes.mixin.NameAccessor.NameMutator

setName

Methods inherited from interface org.refcodes.mixin.NameAccessor.NameProperty

letName

Methods inherited from interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty

letOptionEscapeCode

Methods inherited from interface org.refcodes.struct.PathMap

children, children, children, children, children, children, containsKey, containsKey, containsKey, dirs, dirs, dirs, dirs, dirs, dirs, findPaths, fromExternalPath, get, get, get, getArray, getArray, getArray, getArray, getArray, getArray, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getArrayOr, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getDirIndexes, getRootPath, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, getValueAt, hasChildren, hasChildren, hasChildren, hasChildren, hasChildren, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasDirAt, hasParentPath, hasPath, hasPath, hasPath, hasPath, hasPath, hasSubDirs, hasSubDirs, hasSubDirs, hasSubDirs, hasValue, hasValue, hasValue, hasValue, hasValue, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, hasValueAt, isArray, isArray, isArray, isArray, isArray, isArray, isChild, isChild, isChild, isChild, isDir, isDir, isDir, isDir, isDir, isEqualTo, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isIndexDir, isLeaf, isLeaf, isLeaf, isLeaf, isLeaf, isRootPath, keySet, keySet, keySet, keySet, keySet, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastArrayIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, lastDirIndex, leaves, leaves, leaves, leaves, leaves, leaves, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextArrayIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, nextDirIndex, paths, paths, paths, paths, paths, paths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, queryPaths, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, sortedKeys, toDataStructure, toDataStructure, toExternalPath, toInstance, toInstance, toLeaf, toMap, toNormalizedPath, toParentPath, toPath, toPath, toPath, toPath, toPathElements, toPathList, toPathStack, toPrintable, toPropertyPath, toType, toType, toType, toType, toType, toType, toType, toType

Methods inherited from interface org.refcodes.properties.ProfileProperties

getRuntimeProfiles, getRuntimeProfilesPath, toRuntimeProfile, toRuntimeProfile

Methods inherited from interface org.refcodes.properties.Properties

containsValue, getAnnotator, getDelimiter, getDir, getDir, getDir, getDir, getDir, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirAt, getDirs, getDirs, getDirs, getDirs, getDirs, getType, query, query, query, query, query, queryBetween, queryBetween, queryBetween, queryBetween, queryBetween, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryFrom, queryTo, queryTo, queryTo, queryTo, queryTo, queryTo, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveBetween, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveFrom, retrieveTo, retrieveTo, retrieveTo, retrieveTo, retrieveTo

Methods inherited from interface org.refcodes.mixin.Resetable

reset

Methods inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor

getResetEscapeCode

Methods inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator

setResetEscapeCode

Methods inherited from interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty

letResetEscapeCode

Methods inherited from interface org.refcodes.properties.ResourceLoaderMixin

withFile, withFile, withFilePath, withFilePath, withFilePath, withFilePath, withInputStream, withUrl

Methods inherited from interface org.refcodes.properties.ResourceProperties

reload, reload, toSerialized, toSerialized

Methods inherited from interface org.refcodes.mixin.SecretAccessor.SecretMutator

setSecret

Methods inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor

getShortOptionPrefix

Methods inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator

setShortOptionPrefix

Methods inherited from interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty

letShortOptionPrefix

Methods inherited from interface org.refcodes.cli.SyntaxMetricsAccessor

getSyntaxMetrics

Methods inherited from interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty

letSyntaxMetrics

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor

getTextBoxGrid

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator

setTextBoxGrid

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty

letTextBoxGrid

Methods inherited from interface org.refcodes.mixin.TitleAccessor

getTitle

Methods inherited from interface org.refcodes.mixin.TitleAccessor.TitleMutator

setTitle

Methods inherited from interface org.refcodes.mixin.TitleAccessor.TitleProperty

letTitle

Field Details

DELIMITERS

static final char[] DELIMITERS

Method Details

setObfuscationMode

void setObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)

Specifies the obfuscation mode to be used.

Parameters:

aObfuscationMode - The SystemContext specifies which level of obfuscation is to be used when encountering upon obfuscated properties: E.g. obfuscation may be bound to the host, the "secret" used for obfuscation being the same for all applications on the same host or obfuscation may be bound to the application, being different for different applications on the same host.

toSerialized

String toSerialized()

The behavior of this method is implementation specific. See the javadoc of the implementation in question (such as RuntimePropertiesImpl.toSerialized()) for implementation details.

Specified by:

toSerialized in interface org.refcodes.properties.ResourceProperties

toSerialized

String toSerialized(char aDelimiter)

The behavior of this method is implementation specific. See the javadoc of the implementation in question (such as RuntimePropertiesImpl.toSerialized()) for implementation details.

Specified by:

toSerialized in interface org.refcodes.properties.ResourceProperties

withArgsSyntax

default RuntimeProperties withArgsSyntax(org.refcodes.cli.Constituent aArgsSyntax)

Specified by:

withArgsSyntax in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<RuntimeProperties>

withBannerBorderEscapeCode

default RuntimeProperties withBannerBorderEscapeCode(String aBannerBorderEscCode)

Specified by:

withBannerBorderEscapeCode in interface org.refcodes.cli.ArgsParser

withBannerEscapeCode

default RuntimeProperties withBannerEscapeCode(String aBannerEscCode)

Specified by:

withBannerEscapeCode in interface org.refcodes.cli.ArgsParser

withBannerFont

default RuntimeProperties withBannerFont(org.refcodes.textual.Font aBannerFont)

Specified by:

withBannerFont in interface org.refcodes.cli.ArgsParser

withBannerFontPalette

default RuntimeProperties withBannerFontPalette(char[] aColorPalette)

Specified by:

withBannerFontPalette in interface org.refcodes.cli.ArgsParser

withCommandEscapeCode

default RuntimeProperties withCommandEscapeCode(String aCommandEscCode)

Specified by:

withCommandEscapeCode in interface org.refcodes.cli.ArgsParser

withConsoleWidth

default RuntimeProperties withConsoleWidth(int aConsoleWidth)

Specified by:

withConsoleWidth in interface org.refcodes.cli.ArgsParser

withCopyrightNote

default RuntimeProperties withCopyrightNote(String aCopyrightNote)

Specified by:

withCopyrightNote in interface org.refcodes.cli.ArgsParser

withDescription

default RuntimeProperties withDescription(String aDescription)

Specified by:

withDescription in interface org.refcodes.cli.ArgsParser

Specified by:

withDescription in interface org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ArgsParser>

withDescriptionEscapeCode

default RuntimeProperties withDescriptionEscapeCode(String aDescriptionEscCode)

Specified by:

withDescriptionEscapeCode in interface org.refcodes.cli.ArgsParser

withErrorOut

default RuntimeProperties withErrorOut(PrintStream aErrorOut)

Specified by:

withErrorOut in interface org.refcodes.cli.ArgsParser

withEscapeCodesEnabled

default RuntimeProperties withEscapeCodesEnabled(boolean isEscCodeEnabled)

Specified by:

withEscapeCodesEnabled in interface org.refcodes.cli.ArgsParser

Specified by:

withEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ArgsParser>

withEvalArgs

default RuntimeProperties withEvalArgs(List<String> aArgs)
                                throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParser

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>

Specified by:

withEvalArgs in interface ArgsParserProperties

Throws:

org.refcodes.cli.ArgsSyntaxException

withEvalArgs

default RuntimeProperties withEvalArgs(String aToPath,
 List<String> aArgs)
                                throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface ArgsParserProperties

Throws:

org.refcodes.cli.ArgsSyntaxException

withEvalArgs

default RuntimeProperties withEvalArgs(String aToPath,
 String[] aArgs)
                                throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface ArgsParserProperties

Throws:

org.refcodes.cli.ArgsSyntaxException

withEvalArgs

default RuntimeProperties withEvalArgs(String[] aArgs)
                                throws org.refcodes.cli.ArgsSyntaxException

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParser

Specified by:

withEvalArgs in interface org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>

Specified by:

withEvalArgs in interface ArgsParserProperties

Throws:

org.refcodes.cli.ArgsSyntaxException

withExample

default RuntimeProperties withExample(org.refcodes.cli.Example aExample)

Specified by:

withExample in interface org.refcodes.cli.ArgsParser

withExample

default RuntimeProperties withExample(String aDescription,
 org.refcodes.cli.Operand<?>... aOperands)

Specified by:

withExample in interface org.refcodes.cli.ArgsParser

withExamples

default RuntimeProperties withExamples(Collection<org.refcodes.cli.Example> aExample)

Specified by:

withExamples in interface org.refcodes.cli.ArgsParser

withExamples

default RuntimeProperties withExamples(org.refcodes.cli.Example[] aExample)

Specified by:

withExamples in interface org.refcodes.cli.ArgsParser

withFile

default RuntimeProperties withFile(File aFile)
                            throws IOException,
ParseException

Specified by:

withFile in interface org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>

Throws:

IOException

ParseException

withFile

default RuntimeProperties withFile(File aFile,
 org.refcodes.runtime.ConfigLocator aConfigLocator)
                            throws IOException,
ParseException

Specified by:

withFile in interface org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>

Throws:

IOException

ParseException

withFilePath

default RuntimeProperties withFilePath(Class<?> aResourceClass,
 String aFilePath)
                                throws IOException,
ParseException

Specified by:

withFilePath in interface org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>

Throws:

IOException

ParseException

withFilePath

default RuntimeProperties withFilePath(String aFilePath)
                                throws IOException,
ParseException

Specified by:

withFilePath in interface org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>

Throws:

IOException

ParseException

withInputStream

default RuntimeProperties withInputStream(InputStream aInputStream)
                                   throws IOException,
ParseException

Specified by:

withInputStream in interface org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>

Throws:

IOException

ParseException

withLicenseNote

default RuntimeProperties withLicenseNote(String aLicenseNote)

Specified by:

withLicenseNote in interface org.refcodes.cli.ArgsParser

withLineBreak

default RuntimeProperties withLineBreak(String aLineBreak)

Specified by:

withLineBreak in interface org.refcodes.cli.ArgsParser

withLineSeparatorEscapeCode

default RuntimeProperties withLineSeparatorEscapeCode(String aLineSeparatorEscCode)

Specified by:

withLineSeparatorEscapeCode in interface org.refcodes.cli.ArgsParser

withLongOptionPrefix

default RuntimeProperties withLongOptionPrefix(String aLongOptionPrefix)

Specified by:

withLongOptionPrefix in interface org.refcodes.cli.ArgsParser

Specified by:

withLongOptionPrefix in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<org.refcodes.cli.ArgsParser>

withMaxConsoleWidth

default RuntimeProperties withMaxConsoleWidth(int aMaxConsoleWidth)

Specified by:

withMaxConsoleWidth in interface org.refcodes.cli.ArgsParser

withName

default RuntimeProperties withName(String aName)

Specified by:

withName in interface org.refcodes.cli.ArgsParser

Specified by:

withName in interface org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ArgsParser>

withObfuscationMode

default RuntimeProperties withObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)

Builder method for the obfuscation mode property returning the builder for applying multiple build operations.

Parameters:

aObfuscationMode - The obfuscation mode as of setObfuscationMode(SystemContext).

Returns:

The builder for applying multiple build operations.

withOptionEscapeCode

default RuntimeProperties withOptionEscapeCode(String aOptionEscCode)

Specified by:

withOptionEscapeCode in interface org.refcodes.cli.ArgsParser

Specified by:

withOptionEscapeCode in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<org.refcodes.cli.ArgsParser>

withArgumentEscapeCode

default RuntimeProperties withArgumentEscapeCode(String aParamEscCode)

Specified by:

withArgumentEscapeCode in interface org.refcodes.cli.ArgsParser

Specified by:

withArgumentEscapeCode in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<org.refcodes.cli.ArgsParser>

withProperties

RuntimeProperties withProperties(org.refcodes.properties.Properties aProperties)

A hook for you to provide Properties programmatically. The later you add Properties, the lower their precedence.

Parameters:

aProperties - The Properties to be added.

Returns:

This instance as of the builder pattern to apply method chaining.

withResetEscapeCode

default RuntimeProperties withResetEscapeCode(String aResetEscCode)

Specified by:

withResetEscapeCode in interface org.refcodes.cli.ArgsParser

Specified by:

withResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ArgsParser>

withSecret

default RuntimeProperties withSecret(String aSecret)

Specified by:

withSecret in interface org.refcodes.mixin.SecretAccessor.SecretBuilder<RuntimeProperties>

withSeparatorLnChar

default RuntimeProperties withSeparatorLnChar(char aSeparatorChar)

Specified by:

withSeparatorLnChar in interface org.refcodes.cli.ArgsParser

withShortOptionPrefix

default RuntimeProperties withShortOptionPrefix(Character aShortOptionPrefix)

Specified by:

withShortOptionPrefix in interface org.refcodes.cli.ArgsParser

Specified by:

withShortOptionPrefix in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<org.refcodes.cli.ArgsParser>

withStandardOut

default RuntimeProperties withStandardOut(PrintStream aStandardOut)

Specified by:

withStandardOut in interface org.refcodes.cli.ArgsParser

withSyntaxMetrics

default RuntimeProperties withSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)

Specified by:

withSyntaxMetrics in interface org.refcodes.cli.ArgsParser

Specified by:

withSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ArgsParser>

withTextBoxGrid

default RuntimeProperties withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)

Specified by:

withTextBoxGrid in interface org.refcodes.cli.ArgsParser

Specified by:

withTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ArgsParser>

withTitle

default RuntimeProperties withTitle(String aTitle)

Specified by:

withTitle in interface org.refcodes.cli.ArgsParser

Specified by:

withTitle in interface org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ArgsParser>

withUrl

default RuntimeProperties withUrl(URL aUrl)
                           throws IOException,
ParseException

Specified by:

withUrl in interface org.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>

Throws:

IOException

ParseException