Interface RuntimeProperties
-
- All Superinterfaces:
org.refcodes.mixin.AnnotatorAccessor
,org.refcodes.cli.ArgsParser
,org.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>
,ArgsParserProperties
,org.refcodes.struct.CanonicalMap
,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.mixin.NameAccessor
,org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ArgsParser>
,org.refcodes.mixin.NameAccessor.NameMutator
,org.refcodes.mixin.NameAccessor.NameProperty
,org.refcodes.struct.PathMap<String>
,org.refcodes.properties.ProfileProperties
,org.refcodes.properties.Properties
,org.refcodes.component.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.cli.RootConditionAccessor
,org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<RuntimeProperties>
,org.refcodes.cli.RootConditionAccessor.RootConditionMutator
,org.refcodes.mixin.SecretAccessor.SecretBuilder<RuntimeProperties>
,org.refcodes.mixin.SecretAccessor.SecretMutator
,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.RootConditionAccessor.RootConditionMutator, org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<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
RuntimeProperties
are composed of variousProperties
flavors such asArgsParserProperties
,SystemProperties
,EnvironmentProperties
andResourceProperties
with a precedence in this order, encapsulated by aProfilePropertiesProjection
in order for you, the developer, to conveniently harness the power of theProperties
functionality. You may also add aProperties
instance programmatically to manually provide properties (viawithProperties(Properties)
). The later you addProperties
, the lower their precedence. After construction the usewithFile(java.io.File)
,withUrl(java.net.URL)
or the like to load the properties from external resources. After construction usewithEvalArgs(String[])
or the like to parse the command line arguments (implementations might provide a constructor such asRuntimePropertiesImpl(String[])
for the command line arguments if you do not require a command syntax notation).RuntimeProperties
represent a composition of the differentProperties
flavors, therefore providing functionality from theArgsParserProperties
as well as from theResourceProperties
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.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.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.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.RootConditionAccessor
org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<B extends org.refcodes.cli.RootConditionAccessor.RootConditionBuilder<B>>, org.refcodes.cli.RootConditionAccessor.RootConditionMutator, org.refcodes.cli.RootConditionAccessor.RootConditionProperty
-
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 char[]
DELIMITERS
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods 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
withBannerFont(org.refcodes.textual.Font aBannerFont)
default RuntimeProperties
withBannerFontPalette(char[] aColorPalette)
default RuntimeProperties
withConsoleWidth(int aConsoleWidth)
default RuntimeProperties
withCopyrightNote(String aCopyrightNote)
default RuntimeProperties
withDescription(String aDescription)
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
withExampleUsage(String aDescription, org.refcodes.cli.Operand<?>... aOperands)
default RuntimeProperties
withExampleUsages(Collection<org.refcodes.cli.ExampleUsage> aExampleUsages)
default RuntimeProperties
withExampleUsages(org.refcodes.cli.ExampleUsage[] aExampleUsages)
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
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
withParameterEscapeCode(String aParamEscCode)
RuntimeProperties
withProperties(org.refcodes.properties.Properties aProperties)
A hook for you to provideProperties
programmatically.default RuntimeProperties
withResetEscapeCode(String aResetEscCode)
default RuntimeProperties
withRootArgsSyntax(org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
default RuntimeProperties
withRootOption(org.refcodes.cli.Option<?> aRootCondition)
default RuntimeProperties
withSecret(String aSecret)
default RuntimeProperties
withSeparatorLnChar(char aSeparatorChar)
default RuntimeProperties
withStandardOut(PrintStream aStandardOut)
default RuntimeProperties
withSyntaxNotation(org.refcodes.cli.SyntaxNotation aSyntaxNotation)
default RuntimeProperties
withTitle(String aTitle)
default RuntimeProperties
withUrl(URL aUrl)
default org.refcodes.cli.ArgsParser
withUsageLabel(String aUsageLabel)
-
Methods inherited from interface org.refcodes.cli.ArgsParser
addExampleUsage, addExampleUsage, errorLn, getBannerBorderEscapeCode, getBannerEscapeCode, getCopyrightNote, getDescription, getDescriptionEscapeCode, getExampleUsages, getLicenseNote, getLineSeparatorEscapeCode, getParameterEscapeCode, getRootArgsSyntax, getSeparatorLnChar, printBanner, printBody, printCopyrightNote, printDescription, printExampleUsages, printHelp, printLicenseNote, printLn, printLn, printOptions, printSeparatorLn, printUsage, setBannerBorderEscapeCode, setBannerEscapeCode, setBannerFont, setBannerFontPalette, setConsoleWidth, setCopyrightNote, setDescriptionEscapeCode, setErrorOut, setLicenseNote, setLineBreak, setLineSeparatorEscapeCode, setMaxConsoleWidth, setParameterEscapeCode, setSeparatorLnChar, setStandardOut, setSyntaxNotation, setUsageLabel, withBannerBorderEscapeCode, withBannerEscapeCode, withDescriptionEscapeCode, withExampleUsage, withLineSeparatorEscapeCode, withTextBoxGrid
-
Methods inherited from interface org.refcodes.properties.ext.cli.ArgsParserProperties
evalArgs, evalArgs, evalArgs, evalArgs
-
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.mixin.DescriptionAccessor.DescriptionMutator
setDescription
-
Methods inherited from interface org.refcodes.mixin.DescriptionAccessor.DescriptionProperty
letDescription
-
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.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, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, getArrayIndexes, 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, 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, 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, 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.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.cli.RootConditionAccessor.RootConditionMutator
setRootArgsSyntax, setRootOption
-
Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator
setTextBoxGrid
-
-
-
-
Method Detail
-
setObfuscationMode
void setObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)
Specifies the obfuscation mode to be used.- Parameters:
aObfuscationMode
- TheSystemContext
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.
-
withEscapeCodesEnabled
default RuntimeProperties withEscapeCodesEnabled(boolean isEscCodeEnabled)
- Specified by:
withEscapeCodesEnabled
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withEscapeCodesEnabled
in interfaceorg.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ArgsParser>
-
withResetEscapeCode
default RuntimeProperties withResetEscapeCode(String aResetEscCode)
- Specified by:
withResetEscapeCode
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withResetEscapeCode
in interfaceorg.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ArgsParser>
-
withParameterEscapeCode
default RuntimeProperties withParameterEscapeCode(String aParamEscCode)
- Specified by:
withParameterEscapeCode
in interfaceorg.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 ofsetObfuscationMode(SystemContext)
.- Returns:
- The builder for applying multiple build operations.
-
withRootArgsSyntax
default RuntimeProperties withRootArgsSyntax(org.refcodes.cli.ArgsSyntax aRootArgsSyntax)
- Specified by:
withRootArgsSyntax
in interfaceorg.refcodes.cli.RootConditionAccessor.RootConditionBuilder<RuntimeProperties>
-
withRootOption
default RuntimeProperties withRootOption(org.refcodes.cli.Option<?> aRootCondition)
- Specified by:
withRootOption
in interfaceorg.refcodes.cli.RootConditionAccessor.RootConditionBuilder<RuntimeProperties>
-
withSecret
default RuntimeProperties withSecret(String aSecret)
- Specified by:
withSecret
in interfaceorg.refcodes.mixin.SecretAccessor.SecretBuilder<RuntimeProperties>
-
withProperties
RuntimeProperties withProperties(org.refcodes.properties.Properties aProperties)
A hook for you to provideProperties
programmatically. The later you addProperties
, the lower their precedence.- Parameters:
aProperties
- TheProperties
to be added.- Returns:
- This instance as of the builder pattern to apply method chaining.
-
withFile
default RuntimeProperties withFile(File aFile) throws IOException, ParseException
- Specified by:
withFile
in interfaceorg.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>
- Throws:
IOException
ParseException
-
withFilePath
default RuntimeProperties withFilePath(String aFilePath) throws IOException, ParseException
- Specified by:
withFilePath
in interfaceorg.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>
- Throws:
IOException
ParseException
-
withFilePath
default RuntimeProperties withFilePath(Class<?> aResourceClass, String aFilePath) throws IOException, ParseException
- Specified by:
withFilePath
in interfaceorg.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>
- Throws:
IOException
ParseException
-
withUrl
default RuntimeProperties withUrl(URL aUrl) throws IOException, ParseException
- Specified by:
withUrl
in interfaceorg.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 interfaceorg.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>
- Throws:
IOException
ParseException
-
withInputStream
default RuntimeProperties withInputStream(InputStream aInputStream) throws IOException, ParseException
- Specified by:
withInputStream
in interfaceorg.refcodes.properties.ResourceLoaderMixin<RuntimeProperties>
- Throws:
IOException
ParseException
-
withTitle
default RuntimeProperties withTitle(String aTitle)
- Specified by:
withTitle
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withTitle
in interfaceorg.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ArgsParser>
-
withUsageLabel
default org.refcodes.cli.ArgsParser withUsageLabel(String aUsageLabel)
- Specified by:
withUsageLabel
in interfaceorg.refcodes.cli.ArgsParser
-
withBannerFont
default RuntimeProperties withBannerFont(org.refcodes.textual.Font aBannerFont)
- Specified by:
withBannerFont
in interfaceorg.refcodes.cli.ArgsParser
-
withExampleUsage
default RuntimeProperties withExampleUsage(String aDescription, org.refcodes.cli.Operand<?>... aOperands)
- Specified by:
withExampleUsage
in interfaceorg.refcodes.cli.ArgsParser
-
withExampleUsages
default RuntimeProperties withExampleUsages(Collection<org.refcodes.cli.ExampleUsage> aExampleUsages)
- Specified by:
withExampleUsages
in interfaceorg.refcodes.cli.ArgsParser
-
withExampleUsages
default RuntimeProperties withExampleUsages(org.refcodes.cli.ExampleUsage[] aExampleUsages)
- Specified by:
withExampleUsages
in interfaceorg.refcodes.cli.ArgsParser
-
withBannerFontPalette
default RuntimeProperties withBannerFontPalette(char[] aColorPalette)
- Specified by:
withBannerFontPalette
in interfaceorg.refcodes.cli.ArgsParser
-
withConsoleWidth
default RuntimeProperties withConsoleWidth(int aConsoleWidth)
- Specified by:
withConsoleWidth
in interfaceorg.refcodes.cli.ArgsParser
-
withCopyrightNote
default RuntimeProperties withCopyrightNote(String aCopyrightNote)
- Specified by:
withCopyrightNote
in interfaceorg.refcodes.cli.ArgsParser
-
withDescription
default RuntimeProperties withDescription(String aDescription)
- Specified by:
withDescription
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withDescription
in interfaceorg.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ArgsParser>
-
withErrorOut
default RuntimeProperties withErrorOut(PrintStream aErrorOut)
- Specified by:
withErrorOut
in interfaceorg.refcodes.cli.ArgsParser
-
withEvalArgs
default RuntimeProperties withEvalArgs(List<String> aArgs) throws org.refcodes.cli.UnknownArgsException, org.refcodes.cli.AmbiguousArgsException, org.refcodes.cli.SuperfluousArgsException, org.refcodes.cli.ParseArgsException
- Specified by:
withEvalArgs
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withEvalArgs
in interfaceorg.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>
- Specified by:
withEvalArgs
in interfaceArgsParserProperties
- Throws:
org.refcodes.cli.UnknownArgsException
org.refcodes.cli.AmbiguousArgsException
org.refcodes.cli.SuperfluousArgsException
org.refcodes.cli.ParseArgsException
-
withEvalArgs
default RuntimeProperties withEvalArgs(String aToPath, List<String> aArgs) throws org.refcodes.cli.UnknownArgsException, org.refcodes.cli.AmbiguousArgsException, org.refcodes.cli.SuperfluousArgsException, org.refcodes.cli.ParseArgsException
- Specified by:
withEvalArgs
in interfaceArgsParserProperties
- Throws:
org.refcodes.cli.UnknownArgsException
org.refcodes.cli.AmbiguousArgsException
org.refcodes.cli.SuperfluousArgsException
org.refcodes.cli.ParseArgsException
-
withEvalArgs
default RuntimeProperties withEvalArgs(String aToPath, String[] aArgs) throws org.refcodes.cli.UnknownArgsException, org.refcodes.cli.AmbiguousArgsException, org.refcodes.cli.SuperfluousArgsException, org.refcodes.cli.ParseArgsException
- Specified by:
withEvalArgs
in interfaceArgsParserProperties
- Throws:
org.refcodes.cli.UnknownArgsException
org.refcodes.cli.AmbiguousArgsException
org.refcodes.cli.SuperfluousArgsException
org.refcodes.cli.ParseArgsException
-
withEvalArgs
default RuntimeProperties withEvalArgs(String[] aArgs) throws org.refcodes.cli.UnknownArgsException, org.refcodes.cli.AmbiguousArgsException, org.refcodes.cli.SuperfluousArgsException, org.refcodes.cli.ParseArgsException
- Specified by:
withEvalArgs
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withEvalArgs
in interfaceorg.refcodes.cli.ArgsParserMixin<org.refcodes.cli.ArgsParser>
- Specified by:
withEvalArgs
in interfaceArgsParserProperties
- Throws:
org.refcodes.cli.UnknownArgsException
org.refcodes.cli.AmbiguousArgsException
org.refcodes.cli.SuperfluousArgsException
org.refcodes.cli.ParseArgsException
-
withLicenseNote
default RuntimeProperties withLicenseNote(String aLicenseNote)
- Specified by:
withLicenseNote
in interfaceorg.refcodes.cli.ArgsParser
-
withLineBreak
default RuntimeProperties withLineBreak(String aLineBreak)
- Specified by:
withLineBreak
in interfaceorg.refcodes.cli.ArgsParser
-
withMaxConsoleWidth
default RuntimeProperties withMaxConsoleWidth(int aMaxConsoleWidth)
- Specified by:
withMaxConsoleWidth
in interfaceorg.refcodes.cli.ArgsParser
-
withName
default RuntimeProperties withName(String aName)
- Specified by:
withName
in interfaceorg.refcodes.cli.ArgsParser
- Specified by:
withName
in interfaceorg.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ArgsParser>
-
withSeparatorLnChar
default RuntimeProperties withSeparatorLnChar(char aSeparatorChar)
- Specified by:
withSeparatorLnChar
in interfaceorg.refcodes.cli.ArgsParser
-
withStandardOut
default RuntimeProperties withStandardOut(PrintStream aStandardOut)
- Specified by:
withStandardOut
in interfaceorg.refcodes.cli.ArgsParser
-
withSyntaxNotation
default RuntimeProperties withSyntaxNotation(org.refcodes.cli.SyntaxNotation aSyntaxNotation)
- Specified by:
withSyntaxNotation
in interfaceorg.refcodes.cli.ArgsParser
-
toSerialized
String toSerialized()
The behavior of this method is implementation specific. See the javadoc of the implementation in question (such asRuntimePropertiesImpl.toSerialized()
) for implementation details.- Specified by:
toSerialized
in interfaceorg.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 asRuntimePropertiesImpl.toSerialized()
) for implementation details.- Specified by:
toSerialized
in interfaceorg.refcodes.properties.ResourceProperties
-
-