Module org.refcodes.properties.ext.application
Package org.refcodes.properties.ext.application

Class ApplicationProperties

java.lang.Object
org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>
org.refcodes.properties.ext.application.ApplicationProperties
All Implemented Interfaces:
org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.ArgsSyntaxAccessor, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator, org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxProperty, org.refcodes.cli.ArgumentEscapeCodeAccessor, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator, org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeProperty, org.refcodes.cli.BannerBorderEscapeCodeAccessor, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty, org.refcodes.cli.BannerEscapeCodeAccessor, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeMutator, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeProperty, org.refcodes.cli.BannerFontAccessor, org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.BannerFontAccessor.BannerFontMutator, org.refcodes.cli.BannerFontAccessor.BannerFontProperty, org.refcodes.cli.BannerFontPaletteAccessor, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteProperty, org.refcodes.cli.CliMetrics, org.refcodes.cli.CommandEscapeCodeAccessor, org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeMutator, org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeProperty, org.refcodes.cli.CopyrightAccessor, org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.CopyrightAccessor.CopyrightMutator, org.refcodes.cli.CopyrightAccessor.CopyrightProperty, org.refcodes.cli.DescriptionEscapeCodeAccessor, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty, org.refcodes.cli.ExamplesAccessor, org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.ExamplesAccessor.ExamplesMutator, org.refcodes.cli.ExamplesAccessor.ExamplesProperty, org.refcodes.cli.LicenseAccessor, org.refcodes.cli.LicenseAccessor.LicenseBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.LicenseAccessor.LicenseMutator, org.refcodes.cli.LicenseAccessor.LicenseProperty, org.refcodes.cli.LineSeparatorEscapeCodeAccessor, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty, org.refcodes.cli.LongOptionPrefixAccessor, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator, org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixProperty, org.refcodes.cli.Optionable, org.refcodes.cli.OptionEscapeCodeAccessor, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator, org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeProperty, org.refcodes.cli.ParseArgs, org.refcodes.cli.ShortOptionPrefixAccessor, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator, org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixProperty, org.refcodes.cli.SyntaxMetricsAccessor, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator, org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsProperty, org.refcodes.mixin.AnnotatorAccessor, org.refcodes.mixin.ConsoleWidthAccessor, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthMutator, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthProperty, org.refcodes.mixin.DelimiterAccessor, org.refcodes.mixin.DescriptionAccessor, org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.DescriptionAccessor.DescriptionMutator, org.refcodes.mixin.DescriptionAccessor.DescriptionProperty, org.refcodes.mixin.Dumpable, org.refcodes.mixin.EmptyAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator, org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusProperty, org.refcodes.mixin.LineBreakAccessor, org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.LineBreakAccessor.LineBreakMutator, org.refcodes.mixin.LineBreakAccessor.LineBreakProperty, org.refcodes.mixin.MaxConsoleWidthAccessor, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthMutator, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthProperty, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty, org.refcodes.mixin.Resetable, org.refcodes.mixin.ResetEscapeCodeAccessor, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator, org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeProperty, org.refcodes.mixin.Schemable, org.refcodes.mixin.SecretAccessor.SecretBuilder<ApplicationProperties>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.TitleAccessor, org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.mixin.TitleAccessor.TitleMutator, org.refcodes.mixin.TitleAccessor.TitleProperty, org.refcodes.mixin.TypeAccessor<String>, ArgsParserPropertiesAccessor, ParseArgsProperties, org.refcodes.properties.ProfileProperties, org.refcodes.properties.Properties, org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>, org.refcodes.properties.ResourceProperties, org.refcodes.struct.CanonicalMap, org.refcodes.struct.Containable, org.refcodes.struct.InterOperableMap<String>, org.refcodes.struct.Keys<String,String>, org.refcodes.struct.PathMap<String>, org.refcodes.struct.Table<String,String>, org.refcodes.textual.TextBoxGridAccessor, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ParseArgs>, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator, org.refcodes.textual.TextBoxGridAccessor.TextBoxGridProperty
public class ApplicationProperties extends org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties> implements org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.SecretAccessor.SecretBuilder<ApplicationProperties>, ParseArgsProperties, org.refcodes.properties.ResourceProperties, org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>, org.refcodes.properties.ProfileProperties, ArgsParserPropertiesAccessor
ApplicationProperties are composed of various Properties flavors such as ParseArgsProperties, 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 ApplicationProperties(String[]) for the command line arguments if you do not require a command syntax notation). ApplicationProperties represent a composition of the different Properties flavors, therefore providing functionality from the ParseArgsProperties 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.cli.BannerBorderEscapeCodeAccessor

    org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B extends org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<B>>, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator, org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

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

    org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B extends org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<B>>, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeMutator, org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeProperty

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

    org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<B extends org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<B>>, org.refcodes.cli.BannerFontAccessor.BannerFontMutator, org.refcodes.cli.BannerFontAccessor.BannerFontProperty

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

    org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<B extends org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<B>>, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator, org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteProperty

    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.cli.CommandEscapeCodeAccessor

    org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B extends org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<B>>, org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeMutator, org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeProperty

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

    org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<B extends org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<B>>, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthMutator, org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthProperty

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

    org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<B extends org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<B>>, org.refcodes.cli.CopyrightAccessor.CopyrightMutator, org.refcodes.cli.CopyrightAccessor.CopyrightProperty

    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.cli.DescriptionEscapeCodeAccessor

    org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B extends org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<B>>, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator, org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

    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.cli.ExamplesAccessor

    org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<B extends org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<B>>, org.refcodes.cli.ExamplesAccessor.ExamplesMutator, org.refcodes.cli.ExamplesAccessor.ExamplesProperty

    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.LicenseAccessor

    org.refcodes.cli.LicenseAccessor.LicenseBuilder<B extends org.refcodes.cli.LicenseAccessor.LicenseBuilder<B>>, org.refcodes.cli.LicenseAccessor.LicenseMutator, org.refcodes.cli.LicenseAccessor.LicenseProperty

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

    org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<B extends org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<B>>, org.refcodes.mixin.LineBreakAccessor.LineBreakMutator, org.refcodes.mixin.LineBreakAccessor.LineBreakProperty

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

    org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B extends org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<B>>, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator, org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

    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.MaxConsoleWidthAccessor

    org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B extends org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<B>>, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthMutator, org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthProperty

    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.struct.Table

    org.refcodes.struct.Table.TableDictionary<K extends Object,V extends Object>

    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 inherited from interface org.refcodes.struct.PathMap

    ANNOTATOR, DELIMITER

    Fields inherited from interface org.refcodes.properties.Properties

    DEFAULT_COMMENT

  • Constructor Summary

    Constructors
    Constructor
    Description
    ApplicationProperties()
    Constructs a ApplicationProperties instance with no Condition for parsing command line arguments.
    ApplicationProperties(String aSecret)
    Constructs a ApplicationProperties instance with a custom secret for obfuscation.
    ApplicationProperties(String[] aArgs)
    Constructs a ApplicationProperties instance with no Condition for parsing command line arguments: As no syntax notation is required by the constructor (no root Condition), no syntax validation is done.
    ApplicationProperties(String[] aArgs, String aSecret)
    Constructs a ApplicationProperties instance with no Condition for parsing command line arguments: As no syntax notation is required by the constructor (no root Condition), no syntax validation is done.
    ApplicationProperties(String[] aArgs, org.refcodes.runtime.SystemContext aObfuscationMode)
    Constructs a ApplicationProperties instance with no Condition for parsing command line arguments: As no syntax notation is required by the constructor (no root Condition), no syntax validation is done.
    ApplicationProperties(org.refcodes.cli.Term aArgsSyntax)
    Constructs a ApplicationProperties instance with the given Condition used to parse command line arguments.
    ApplicationProperties(org.refcodes.cli.Term aArgsSyntax, String aSecret)
    Constructs a ApplicationProperties instance with the given Condition used to parse command line arguments.
    ApplicationProperties(org.refcodes.cli.Term aArgsSyntax, org.refcodes.runtime.SystemContext aObfuscationMode)
    Constructs a ApplicationProperties instance with the given Condition used to parse command line arguments.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory)
    Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aSecret)
    Constructs a ApplicationProperties instance with a custom secret for obfuscation.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs)
    Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments: As no syntax notation is required by the constructor (no root args syntax Term node), no syntax validation is done.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs, String aSecret)
    Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments: As no syntax notation is required by the constructor (no root args syntax Term node), no syntax validation is done.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs, org.refcodes.runtime.SystemContext aObfuscationMode)
    Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments: As no syntax notation is required by the constructor (no args syntax Term node), no syntax validation is done.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Term aArgsSyntax)
    Constructs a ApplicationProperties instance with the given args syntax Term node used to parse command line arguments.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Term aArgsSyntax, String aSecret)
    Constructs a ApplicationProperties instance with the given args syntax Term node used to parse command line arguments.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Term aArgsSyntax, org.refcodes.runtime.SystemContext aObfuscationMode)
    Constructs a ApplicationProperties instance with the given args syntax Term node used to parse command line arguments.
    ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.runtime.SystemContext aObfuscationMode)
    Constructs the ApplicationProperties with the given obfuscation mode.
    ApplicationProperties(org.refcodes.runtime.SystemContext aObfuscationMode)
    Constructs the ApplicationProperties with the given obfuscation mode.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addExample(org.refcodes.cli.Example aExampleUsage)
    protected void
    addProperties(org.refcodes.properties.Properties aProperties)
    Adds the properties.
    org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder
    addResourceProperties(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
    Reads the ResourceProperties.ResourcePropertiesBuilder from the given data sink.
    org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder
    addResourceProperties(InputStream aInputStream, char[] aDelimiters)
    Reads the ResourceProperties from the given data sink.
    org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder
    addResourceProperties(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
    Reads the ResourceProperties.ResourcePropertiesBuilder from the given data sink.
    org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder
    addResourceProperties(URL aUrl, char... aDelimiters)
    Reads the ResourceProperties from the given data sink.
    boolean
    containsKey(Object aKey)
    void
    errorLn(String aLine)
    org.refcodes.cli.Operand<?>[]
    evalArgs(String[] aArgs)
    org.refcodes.cli.Operand<?>[]
    evalArgs(String aToPath, String[] aArgs)
    org.refcodes.cli.Operand<?>[]
    evalArgs(String aToPath, List<String> aArgs)
    org.refcodes.cli.Operand<?>[]
    evalArgs(List<String> aArgs)
    String
    get(Object aKey)
    ParseArgsProperties
    getArgsParserProperties()
    The ParseArgsProperties are those properties derived from the command line arguments (as of the getArgsSyntax()).
    org.refcodes.cli.Term
    getArgsSyntax()
    String
    getArgumentEscapeCode()
    String
    getBannerBorderEscapeCode()
    String
    getBannerEscapeCode()
    org.refcodes.textual.Font
    getBannerFont()
    char[]
    getBannerFontPalette()
    String
    getCommandEscapeCode()
    int
    getConsoleWidth()
    String
    getCopyright()
    char
    getDelimiter()
    String
    getDescription()
    String
    getDescriptionEscapeCode()
    org.refcodes.cli.Example[]
    getExamples()
    String
    getLicense()
    String
    getLineBreak()
    String
    getLineSeparatorEscapeCode()
    String
    getLongOptionPrefix()
    int
    getMaxConsoleWidth()
    String
    getName()
    String
    getOptionEscapeCode()
    protected org.refcodes.properties.Properties
    getProperties()
    String
    getResetEscapeCode()
    char
    getSeparatorLnChar()
    Character
    getShortOptionPrefix()
    org.refcodes.cli.SyntaxMetrics
    getSyntaxMetrics()
    org.refcodes.textual.TextBoxGrid
    getTextBoxGrid()
    String
    getTitle()
    boolean
    isEmpty()
    boolean
    isEscapeCodesEnabled()
    Set<String>
    keySet()
    void
    printBanner()
    void
    printCopyright()
    void
    printDescription()
    void
    printExamples()
    void
    printHeader()
    void
    printHelp()
    void
    printLicense()
    void
    printLn()
    void
    printLn(String aLine)
    void
    printOptions()
    void
    printSeparatorLn()
    void
    printSynopsis()
    org.refcodes.properties.Properties
    reload()
    org.refcodes.properties.Properties
    reload(org.refcodes.properties.ReloadMode aReloadMode)
    void
    reset()
    org.refcodes.properties.Properties
    retrieveFrom(String aFromPath)
    org.refcodes.properties.Properties
    retrieveTo(String aToPath)
    void
    setArgsSyntax(org.refcodes.cli.Term aArgsSyntax)
    void
    setArgumentEscapeCode(String aParamEscCode)
    void
    setBannerBorderEscapeCode(String aBannerBorderEscCode)
    void
    setBannerEscapeCode(String aBannerEscCode)
    void
    setBannerFont(org.refcodes.textual.Font aBannerFont)
    void
    setBannerFontPalette(char[] aColorPalette)
    void
    setBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)
    void
    setCommandEscapeCode(String aCommandEscCode)
    void
    setConsoleWidth(int aConsoleWidth)
    void
    setCopyright(String aCopyrightNote)
    void
    setDescription(String aDescription)
    void
    setDescriptionEscapeCode(String aParamDescriptionEscCode)
    void
    setErrorOut(PrintStream aErrorOut)
    void
    setEscapeCodesEnabled(boolean isEscCodeEnabled)
    void
    setExamples(org.refcodes.cli.Example[] aExamples)
    void
    setLicense(String aLicenseNote)
    void
    setLineBreak(String aLineBreak)
    void
    setLineSeparatorEscapeCode(String aLineSeparatorEscCode)
    void
    setLongOptionPrefix(String aLongOptionPrefix)
    void
    setMaxConsoleWidth(int aMaxConsoleWidth)
    void
    setName(String aName)
    void
    setObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)
    Specifies the obfuscation mode to be used.
    void
    setOptionEscapeCode(String aOptEscCode)
    void
    setResetEscapeCode(String aResetEscCode)
    void
    setSecret(String aSecret)
    void
    setSeparatorLnChar(char aSeparatorChar)
    void
    setShortOptionPrefix(Character aShortOptionPrefix)
    void
    setStandardOut(PrintStream aStandardOut)
    void
    setSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)
    void
    setTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
    void
    setTitle(String aTitle)
    int
    size()
    Object
    toDataStructure(String aFromPath)
    org.refcodes.properties.Properties
    toRuntimeProfile(String... aProfiles)
    String
    toSerialized()
    Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
    String
    toSerialized(char aDelimiter)
    Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
    String
    toSerialized(String aComment, char aDelimiter)
    Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
    Collection<String>
    values()
    ApplicationProperties
    withAddExample(String aDescription, org.refcodes.cli.Operand<?>... aOperands)
    ApplicationProperties
    withAddExample(org.refcodes.cli.Example aExample)
    ApplicationProperties
    withArgsSyntax(org.refcodes.cli.Term aArgsSyntax)
    ApplicationProperties
    withArgumentEscapeCode(String aParamEscCode)
    ApplicationProperties
    withBannerBorderEscapeCode(String aBannerBorderEscCode)
    ApplicationProperties
    withBannerEscapeCode(String aBannerEscCode)
    ApplicationProperties
    withBannerFont(org.refcodes.textual.Font aBannerFont)
    ApplicationProperties
    withBannerFontPalette(char[] aColorPalette)
    ApplicationProperties
    withBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)
    ApplicationProperties
    withCommandEscapeCode(String aCommandEscCode)
    ApplicationProperties
    withConsoleWidth(int aConsoleWidth)
    ApplicationProperties
    withCopyright(String aCopyrightNote)
    ApplicationProperties
    withDescription(String aDescription)
    ApplicationProperties
    withDescriptionEscapeCode(String aDescriptionEscCode)
    ApplicationProperties
    withErrorOut(PrintStream aErrorOut)
    ApplicationProperties
    withEscapeCodesEnabled(boolean isEscCodeEnabled)
    ApplicationProperties
    withEvalArgs(String[] aArgs)
    ApplicationProperties
    withEvalArgs(String[] aArgs, Pattern aFilterExp)
    ApplicationProperties
    withEvalArgs(String[] aArgs, org.refcodes.cli.ArgsFilter aArgsFilter)
    ApplicationProperties
    withEvalArgs(String aToPath, String[] aArgs)
    ApplicationProperties
    withEvalArgs(String aToPath, List<String> aArgs)
    ApplicationProperties
    withEvalArgs(List<String> aArgs)
    ApplicationProperties
    withEvalArgs(List<String> aArgs, Pattern aFilterExp)
    ApplicationProperties
    withEvalArgs(List<String> aArgs, org.refcodes.cli.ArgsFilter aArgsFilter)
    ApplicationProperties
    withExamples(Collection<org.refcodes.cli.Example> aExample)
    ApplicationProperties
    withExamples(org.refcodes.cli.Example[] aExample)
    ApplicationProperties
    withFile(File aFile)
    ApplicationProperties
    withFile(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator)
    ApplicationProperties
    withFile(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
    ApplicationProperties
    withInputStream(InputStream aInputStream)
    ApplicationProperties
    withInputStream(InputStream aInputStream, char... aDelimiters)
    ApplicationProperties
    withLicense(String aLicenseNote)
    ApplicationProperties
    withLineBreak(String aLineBreak)
    ApplicationProperties
    withLineSeparatorEscapeCode(String aLineSeparatorEscCode)
    ApplicationProperties
    withLongOptionPrefix(String aLongOptionPrefix)
    ApplicationProperties
    withMaxConsoleWidth(int aMaxConsoleWidth)
    ApplicationProperties
    withName(String aName)
    ApplicationProperties
    withObfuscationMode(org.refcodes.runtime.SystemContext aObfuscationMode)
    Builder method for the obfuscation mode property returning the builder for applying multiple build operations.
    ApplicationProperties
    withOptionEscapeCode(String aOptionEscCode)
    ApplicationProperties
    withProperties(org.refcodes.properties.Properties aProperties)
    A hook for you to provide Properties programmatically.
    ApplicationProperties
    withResetEscapeCode(String aResetEscCode)
    ApplicationProperties
    withResourceClass(Class<?> aResourceClass, String aFilePath)
    ApplicationProperties
    withResourceClass(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters)
    ApplicationProperties
    withResourceClass(String aFilePath)
    ApplicationProperties
    withSecret(String aSecret)
    ApplicationProperties
    withSeparatorLnChar(char aSeparatorChar)
    ApplicationProperties
    withShortOptionPrefix(Character aShortOptionPrefix)
    ApplicationProperties
    withStandardOut(PrintStream aStandardOut)
    ApplicationProperties
    withSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)
    org.refcodes.cli.ParseArgs
    withSyntaxMetrics(org.refcodes.cli.SyntaxNotation aSyntaxNotation)
    ApplicationProperties
    withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
    ApplicationProperties
    withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)
    ApplicationProperties
    withTitle(String aTitle)
    ApplicationProperties
    withUrl(URL aUrl)
    ApplicationProperties
    withUrl(URL aUrl, char... aDelimiters)

    Methods inherited from class org.refcodes.properties.AbstractPropertiesDecorator

    getAnnotator, setProperties, toDump, toDump, toPrintable

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

    letArgsSyntax

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

    letArgumentEscapeCode

    Methods inherited from interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeProperty

    letBannerBorderEscapeCode

    Methods inherited from interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeProperty

    letBannerEscapeCode

    Methods inherited from interface org.refcodes.cli.BannerFontAccessor.BannerFontProperty

    letBannerFont

    Methods inherited from interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteProperty

    letBannerFontPalette

    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.cli.CommandEscapeCodeAccessor.CommandEscapeCodeProperty

    letCommandEscapeCode

    Methods inherited from interface org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthProperty

    letConsoleWidth

    Methods inherited from interface org.refcodes.cli.CopyrightAccessor.CopyrightProperty

    letCopyright

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

    letDescription

    Methods inherited from interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeProperty

    letDescriptionEscapeCode

    Methods inherited from interface org.refcodes.mixin.Dumpable

    toDump, toDump

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

    letEscapeCodesEnabled

    Methods inherited from interface org.refcodes.cli.ExamplesAccessor.ExamplesMutator

    setExamples

    Methods inherited from interface org.refcodes.cli.ExamplesAccessor.ExamplesProperty

    letExamples

    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

    getOr, use

    Methods inherited from interface org.refcodes.cli.LicenseAccessor.LicenseProperty

    letLicense

    Methods inherited from interface org.refcodes.mixin.LineBreakAccessor.LineBreakProperty

    letLineBreak

    Methods inherited from interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeProperty

    letLineSeparatorEscapeCode

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

    letLongOptionPrefix

    Methods inherited from interface org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthProperty

    letMaxConsoleWidth

    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.cli.ParseArgs

    addExample, evalArgs, evalArgs, evalArgs, evalArgs, printBody, toOptions, toSchema

    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, 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

    Methods inherited from interface org.refcodes.properties.Properties

    containsValue, getAnnotator, 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, retrieveTo, retrieveTo, retrieveTo, retrieveTo

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

    letResetEscapeCode

    Methods inherited from interface org.refcodes.properties.ResourceLoaderBuilder

    withFile, withResourceClass, withResourceClass, withResourceClass

    Methods inherited from interface org.refcodes.properties.ResourceProperties

    toSerialized

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

    letShortOptionPrefix

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

    setSyntaxMetrics

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

    letSyntaxMetrics, letSyntaxMetrics

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

    setTextBoxGrid

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

    letTextBoxGrid, letTextBoxGrid

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

    letTitle

  • Constructor Details

    • ApplicationProperties

      public ApplicationProperties()
      Constructs a ApplicationProperties instance with no Condition for parsing command line arguments. As no syntax notation is required by the constructor (no root Condition), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments when invoking withEvalArgs(String[]).

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.cli.Term aArgsSyntax)
      Constructs a ApplicationProperties instance with the given Condition used to parse command line arguments.
      Parameters:
      aArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.cli.Term aArgsSyntax, String aSecret)
      Constructs a ApplicationProperties instance with the given Condition used to parse command line arguments. Also constructs a ApplicationProperties instance with a custom secret for obfuscation.
      Parameters:
      aArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
      aSecret - The secret to be used when encountering upon obfuscated properties.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.cli.Term aArgsSyntax, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a ApplicationProperties instance with the given Condition used to parse command line arguments. Also constructs the ApplicationProperties with the given obfuscation mode.
      Parameters:
      aArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
      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.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory)
      Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments. As no syntax notation is required by the constructor (no root args syntax Term node), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments when invoking withEvalArgs(String[]).
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Term aArgsSyntax)
      Constructs a ApplicationProperties instance with the given args syntax Term node used to parse command line arguments.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Term aArgsSyntax, String aSecret)
      Constructs a ApplicationProperties instance with the given args syntax Term node used to parse command line arguments. Also constructs a ApplicationProperties instance with a custom secret for obfuscation.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
      aSecret - The secret to be used when encountering upon obfuscated properties.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.cli.Term aArgsSyntax, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a ApplicationProperties instance with the given args syntax Term node used to parse command line arguments. Also constructs the ApplicationProperties with the given obfuscation mode.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aArgsSyntax - The root condition being the node from which parsing the command line arguments starts. Parse the command line arguments via evalArgs(String[]).
      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.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String aSecret)
      Constructs a ApplicationProperties instance with a custom secret for obfuscation.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aSecret - The secret to be used when encountering upon obfuscated properties.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs)
      Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments: As no syntax notation is required by the constructor (no root args syntax Term node), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aArgs - The command line arguments to be evaluated.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs, String aSecret)
      Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments: As no syntax notation is required by the constructor (no root args syntax Term node), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs a ApplicationProperties instance with a custom secret for obfuscation.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aArgs - The command line arguments to be evaluated.
      aSecret - The secret to be used when encountering upon obfuscated properties.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, String[] aArgs, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a ApplicationProperties instance with no args syntax Term node for parsing command line arguments: As no syntax notation is required by the constructor (no args syntax Term node), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs the ApplicationProperties with the given obfuscation mode
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      aArgs - The command line arguments to be evaluated.
      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.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.properties.PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory aPropertiesBuilderFactory, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs the ApplicationProperties with the given obfuscation mode.
      Parameters:
      aPropertiesBuilderFactory - The factory to use when constructing ResourceProperties instances.
      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.

    • ApplicationProperties

      public ApplicationProperties(String aSecret)
      Constructs a ApplicationProperties instance with a custom secret for obfuscation.
      Parameters:
      aSecret - The secret to be used when encountering upon obfuscated properties.

    • ApplicationProperties

      public ApplicationProperties(String[] aArgs)
      Constructs a ApplicationProperties instance with no Condition for parsing command line arguments: As no syntax notation is required by the constructor (no root Condition), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments.
      Parameters:
      aArgs - The command line arguments to be evaluated.

    • ApplicationProperties

      public ApplicationProperties(String[] aArgs, String aSecret)
      Constructs a ApplicationProperties instance with no Condition for parsing command line arguments: As no syntax notation is required by the constructor (no root Condition), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs a ApplicationProperties instance with a custom secret for obfuscation.
      Parameters:
      aArgs - The command line arguments to be evaluated.
      aSecret - The secret to be used when encountering upon obfuscated properties.

    • ApplicationProperties

      public ApplicationProperties(String[] aArgs, org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs a ApplicationProperties instance with no Condition for parsing command line arguments: As no syntax notation is required by the constructor (no root Condition), no syntax validation is done. Therefore the properties are heuristically determined from the provided command line arguments. Also constructs the ApplicationProperties with the given obfuscation mode
      Parameters:
      aArgs - The command line arguments to be evaluated.
      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.

    • ApplicationProperties

      public ApplicationProperties(org.refcodes.runtime.SystemContext aObfuscationMode)
      Constructs the ApplicationProperties with the given obfuscation mode.
      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.

  • Method Details

    • addExample

      public void addExample(org.refcodes.cli.Example aExampleUsage)
      Specified by:
      addExample in interface org.refcodes.cli.ParseArgs

    • containsKey

      public boolean containsKey(Object aKey)
      Specified by:
      containsKey in interface org.refcodes.struct.Keys<String,String>
      Overrides:
      containsKey in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • errorLn

      public void errorLn(String aLine)
      Specified by:
      errorLn in interface org.refcodes.cli.ParseArgs

    • evalArgs

      public org.refcodes.cli.Operand<?>[] evalArgs(List<String> aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      evalArgs in interface org.refcodes.cli.ParseArgs
      Specified by:
      evalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • evalArgs

      public org.refcodes.cli.Operand<?>[] evalArgs(String aToPath, List<String> aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      evalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • evalArgs

      public org.refcodes.cli.Operand<?>[] evalArgs(String aToPath, String[] aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      evalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • evalArgs

      public org.refcodes.cli.Operand<?>[] evalArgs(String[] aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      evalArgs in interface org.refcodes.cli.ParseArgs
      Specified by:
      evalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • get

      public String get(Object aKey)
      Specified by:
      get in interface org.refcodes.struct.Keys<String,String>
      Overrides:
      get in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • getArgsParserProperties

      public ParseArgsProperties getArgsParserProperties()
      The ParseArgsProperties are those properties derived from the command line arguments (as of the getArgsSyntax()).
      Specified by:
      getArgsParserProperties in interface ArgsParserPropertiesAccessor

    • getArgsSyntax

      public org.refcodes.cli.Term getArgsSyntax()
      Specified by:
      getArgsSyntax in interface org.refcodes.cli.ArgsSyntaxAccessor
      Specified by:
      getArgsSyntax in interface org.refcodes.cli.ParseArgs

    • getArgumentEscapeCode

      public String getArgumentEscapeCode()
      Specified by:
      getArgumentEscapeCode in interface org.refcodes.cli.ArgumentEscapeCodeAccessor
      Specified by:
      getArgumentEscapeCode in interface org.refcodes.cli.ParseArgs

    • getBannerBorderEscapeCode

      public String getBannerBorderEscapeCode()
      Specified by:
      getBannerBorderEscapeCode in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor
      Specified by:
      getBannerBorderEscapeCode in interface org.refcodes.cli.ParseArgs

    • getBannerEscapeCode

      public String getBannerEscapeCode()
      Specified by:
      getBannerEscapeCode in interface org.refcodes.cli.BannerEscapeCodeAccessor
      Specified by:
      getBannerEscapeCode in interface org.refcodes.cli.ParseArgs

    • getBannerFont

      public org.refcodes.textual.Font getBannerFont()
      Specified by:
      getBannerFont in interface org.refcodes.cli.BannerFontAccessor

    • getBannerFontPalette

      public char[] getBannerFontPalette()
      Specified by:
      getBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor

    • getCommandEscapeCode

      public String getCommandEscapeCode()
      Specified by:
      getCommandEscapeCode in interface org.refcodes.cli.CommandEscapeCodeAccessor
      Specified by:
      getCommandEscapeCode in interface org.refcodes.cli.ParseArgs

    • getConsoleWidth

      public int getConsoleWidth()
      Specified by:
      getConsoleWidth in interface org.refcodes.mixin.ConsoleWidthAccessor

    • getCopyright

      public String getCopyright()
      Specified by:
      getCopyright in interface org.refcodes.cli.CopyrightAccessor
      Specified by:
      getCopyright in interface org.refcodes.cli.ParseArgs

    • getDelimiter

      public char getDelimiter()
      Specified by:
      getDelimiter in interface org.refcodes.mixin.DelimiterAccessor
      Specified by:
      getDelimiter in interface org.refcodes.properties.Properties
      Overrides:
      getDelimiter in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in interface org.refcodes.mixin.DescriptionAccessor
      Specified by:
      getDescription in interface org.refcodes.cli.ParseArgs

    • getDescriptionEscapeCode

      public String getDescriptionEscapeCode()
      Specified by:
      getDescriptionEscapeCode in interface org.refcodes.cli.DescriptionEscapeCodeAccessor
      Specified by:
      getDescriptionEscapeCode in interface org.refcodes.cli.ParseArgs

    • getExamples

      public org.refcodes.cli.Example[] getExamples()
      Specified by:
      getExamples in interface org.refcodes.cli.ExamplesAccessor
      Specified by:
      getExamples in interface org.refcodes.cli.ParseArgs

    • getLicense

      public String getLicense()
      Specified by:
      getLicense in interface org.refcodes.cli.LicenseAccessor
      Specified by:
      getLicense in interface org.refcodes.cli.ParseArgs

    • getLineBreak

      public String getLineBreak()
      Specified by:
      getLineBreak in interface org.refcodes.mixin.LineBreakAccessor

    • getLineSeparatorEscapeCode

      public String getLineSeparatorEscapeCode()
      Specified by:
      getLineSeparatorEscapeCode in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor
      Specified by:
      getLineSeparatorEscapeCode in interface org.refcodes.cli.ParseArgs

    • getLongOptionPrefix

      public String getLongOptionPrefix()
      Specified by:
      getLongOptionPrefix in interface org.refcodes.cli.LongOptionPrefixAccessor

    • getMaxConsoleWidth

      public int getMaxConsoleWidth()
      Specified by:
      getMaxConsoleWidth in interface org.refcodes.mixin.MaxConsoleWidthAccessor

    • getName

      public String getName()
      Specified by:
      getName in interface org.refcodes.mixin.NameAccessor

    • getOptionEscapeCode

      public String getOptionEscapeCode()
      Specified by:
      getOptionEscapeCode in interface org.refcodes.cli.OptionEscapeCodeAccessor
      Specified by:
      getOptionEscapeCode in interface org.refcodes.cli.ParseArgs

    • getResetEscapeCode

      public String getResetEscapeCode()
      Specified by:
      getResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor

    • getSeparatorLnChar

      public char getSeparatorLnChar()
      Specified by:
      getSeparatorLnChar in interface org.refcodes.cli.ParseArgs

    • getShortOptionPrefix

      public Character getShortOptionPrefix()
      Specified by:
      getShortOptionPrefix in interface org.refcodes.cli.ShortOptionPrefixAccessor

    • getSyntaxMetrics

      public org.refcodes.cli.SyntaxMetrics getSyntaxMetrics()
      Specified by:
      getSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor

    • getTextBoxGrid

      public org.refcodes.textual.TextBoxGrid getTextBoxGrid()
      Specified by:
      getTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface org.refcodes.mixin.TitleAccessor

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.refcodes.mixin.EmptyAccessor
      Overrides:
      isEmpty in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • isEscapeCodesEnabled

      public boolean isEscapeCodesEnabled()
      Specified by:
      isEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor

    • keySet

      public Set<String> keySet()
      Specified by:
      keySet in interface org.refcodes.struct.Keys<String,String>
      Overrides:
      keySet in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • printBanner

      public void printBanner()
      Specified by:
      printBanner in interface org.refcodes.cli.ParseArgs

    • printCopyright

      public void printCopyright()
      Specified by:
      printCopyright in interface org.refcodes.cli.ParseArgs

    • printDescription

      public void printDescription()
      Specified by:
      printDescription in interface org.refcodes.cli.ParseArgs

    • printExamples

      public void printExamples()
      Specified by:
      printExamples in interface org.refcodes.cli.ParseArgs

    • printHeader

      public void printHeader()
      Specified by:
      printHeader in interface org.refcodes.cli.ParseArgs

    • printHelp

      public void printHelp()
      Specified by:
      printHelp in interface org.refcodes.cli.ParseArgs

    • printLicense

      public void printLicense()
      Specified by:
      printLicense in interface org.refcodes.cli.ParseArgs

    • printLn

      public void printLn()
      Specified by:
      printLn in interface org.refcodes.cli.ParseArgs

    • printLn

      public void printLn(String aLine)
      Specified by:
      printLn in interface org.refcodes.cli.ParseArgs

    • printOptions

      public void printOptions()
      Specified by:
      printOptions in interface org.refcodes.cli.ParseArgs

    • printSeparatorLn

      public void printSeparatorLn()
      Specified by:
      printSeparatorLn in interface org.refcodes.cli.ParseArgs

    • printSynopsis

      public void printSynopsis()
      Specified by:
      printSynopsis in interface org.refcodes.cli.ParseArgs

    • reload

      public org.refcodes.properties.Properties reload() throws IOException, ParseException
      Specified by:
      reload in interface org.refcodes.properties.ResourceProperties
      Throws:
      IOException
      ParseException

    • reload

      public org.refcodes.properties.Properties reload(org.refcodes.properties.ReloadMode aReloadMode) throws IOException, ParseException
      Specified by:
      reload in interface org.refcodes.properties.ResourceProperties
      Throws:
      IOException
      ParseException

    • reset

      public void reset()
      Specified by:
      reset in interface org.refcodes.mixin.Resetable

    • retrieveFrom

      public org.refcodes.properties.Properties retrieveFrom(String aFromPath)
      Specified by:
      retrieveFrom in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveFrom in interface org.refcodes.struct.PathMap<String>
      Specified by:
      retrieveFrom in interface org.refcodes.properties.Properties
      Overrides:
      retrieveFrom in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • retrieveTo

      public org.refcodes.properties.Properties retrieveTo(String aToPath)
      Specified by:
      retrieveTo in interface org.refcodes.struct.CanonicalMap
      Specified by:
      retrieveTo in interface org.refcodes.struct.PathMap<String>
      Specified by:
      retrieveTo in interface org.refcodes.properties.Properties
      Overrides:
      retrieveTo in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • setArgsSyntax

      public void setArgsSyntax(org.refcodes.cli.Term aArgsSyntax)
      Specified by:
      setArgsSyntax in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxMutator

    • setArgumentEscapeCode

      public void setArgumentEscapeCode(String aParamEscCode)
      Specified by:
      setArgumentEscapeCode in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeMutator

    • setBannerBorderEscapeCode

      public void setBannerBorderEscapeCode(String aBannerBorderEscCode)
      Specified by:
      setBannerBorderEscapeCode in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeMutator

    • setBannerEscapeCode

      public void setBannerEscapeCode(String aBannerEscCode)
      Specified by:
      setBannerEscapeCode in interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeMutator

    • setBannerFont

      public void setBannerFont(org.refcodes.textual.Font aBannerFont)
      Specified by:
      setBannerFont in interface org.refcodes.cli.BannerFontAccessor.BannerFontMutator

    • setBannerFontPalette

      public void setBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)
      Specified by:
      setBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator

    • setBannerFontPalette

      public void setBannerFontPalette(char[] aColorPalette)
      Specified by:
      setBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteMutator

    • setCommandEscapeCode

      public void setCommandEscapeCode(String aCommandEscCode)
      Specified by:
      setCommandEscapeCode in interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeMutator

    • setConsoleWidth

      public void setConsoleWidth(int aConsoleWidth)
      Specified by:
      setConsoleWidth in interface org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthMutator

    • setCopyright

      public void setCopyright(String aCopyrightNote)
      Specified by:
      setCopyright in interface org.refcodes.cli.CopyrightAccessor.CopyrightMutator

    • setDescription

      public void setDescription(String aDescription)
      Specified by:
      setDescription in interface org.refcodes.mixin.DescriptionAccessor.DescriptionMutator

    • setDescriptionEscapeCode

      public void setDescriptionEscapeCode(String aParamDescriptionEscCode)
      Specified by:
      setDescriptionEscapeCode in interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeMutator

    • setErrorOut

      public void setErrorOut(PrintStream aErrorOut)
      Specified by:
      setErrorOut in interface org.refcodes.cli.ParseArgs

    • setEscapeCodesEnabled

      public void setEscapeCodesEnabled(boolean isEscCodeEnabled)
      Specified by:
      setEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusMutator

    • setExamples

      public void setExamples(org.refcodes.cli.Example[] aExamples)
      Specified by:
      setExamples in interface org.refcodes.cli.ExamplesAccessor.ExamplesMutator

    • setLicense

      public void setLicense(String aLicenseNote)
      Specified by:
      setLicense in interface org.refcodes.cli.LicenseAccessor.LicenseMutator

    • setLineBreak

      public void setLineBreak(String aLineBreak)
      Specified by:
      setLineBreak in interface org.refcodes.mixin.LineBreakAccessor.LineBreakMutator

    • setLineSeparatorEscapeCode

      public void setLineSeparatorEscapeCode(String aLineSeparatorEscCode)
      Specified by:
      setLineSeparatorEscapeCode in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeMutator
      Specified by:
      setLineSeparatorEscapeCode in interface org.refcodes.cli.ParseArgs

    • setLongOptionPrefix

      public void setLongOptionPrefix(String aLongOptionPrefix)
      Specified by:
      setLongOptionPrefix in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixMutator

    • setMaxConsoleWidth

      public void setMaxConsoleWidth(int aMaxConsoleWidth)
      Specified by:
      setMaxConsoleWidth in interface org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthMutator

    • setName

      public void setName(String aName)
      Specified by:
      setName in interface org.refcodes.mixin.NameAccessor.NameMutator

    • setObfuscationMode

      public 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.

    • setOptionEscapeCode

      public void setOptionEscapeCode(String aOptEscCode)
      Specified by:
      setOptionEscapeCode in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeMutator

    • setResetEscapeCode

      public void setResetEscapeCode(String aResetEscCode)
      Specified by:
      setResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeMutator

    • setSecret

      public void setSecret(String aSecret)
      Specified by:
      setSecret in interface org.refcodes.mixin.SecretAccessor.SecretMutator

    • setSeparatorLnChar

      public void setSeparatorLnChar(char aSeparatorChar)
      Specified by:
      setSeparatorLnChar in interface org.refcodes.cli.ParseArgs

    • setShortOptionPrefix

      public void setShortOptionPrefix(Character aShortOptionPrefix)
      Specified by:
      setShortOptionPrefix in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixMutator

    • setStandardOut

      public void setStandardOut(PrintStream aStandardOut)
      Specified by:
      setStandardOut in interface org.refcodes.cli.ParseArgs

    • setSyntaxMetrics

      public void setSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)
      Specified by:
      setSyntaxMetrics in interface org.refcodes.cli.ParseArgs
      Specified by:
      setSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsMutator

    • setTextBoxGrid

      public void setTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
      Specified by:
      setTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator

    • setTitle

      public void setTitle(String aTitle)
      Specified by:
      setTitle in interface org.refcodes.mixin.TitleAccessor.TitleMutator

    • size

      public int size()
      Specified by:
      size in interface org.refcodes.struct.Containable
      Overrides:
      size in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • toDataStructure

      public Object toDataStructure(String aFromPath)
      Specified by:
      toDataStructure in interface org.refcodes.struct.PathMap<String>
      Overrides:
      toDataStructure in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • toRuntimeProfile

      public org.refcodes.properties.Properties toRuntimeProfile(String... aProfiles)
      Specified by:
      toRuntimeProfile in interface org.refcodes.properties.ProfileProperties

    • toSerialized

      public String toSerialized()
      Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
      Specified by:
      toSerialized in interface org.refcodes.properties.ResourceProperties

    • toSerialized

      public String toSerialized(char aDelimiter)
      Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
      Specified by:
      toSerialized in interface org.refcodes.properties.ResourceProperties

    • toSerialized

      public String toSerialized(String aComment, char aDelimiter)
      Returns the serialized format as of the ResourceProperties.ResourcePropertiesBuilder instance being produced upon invocation of the PolyglotPropertiesBuilder.PolyglotPropertiesBuilderFactory.toProperties(Properties) method.
      Specified by:
      toSerialized in interface org.refcodes.properties.ResourceProperties

    • values

      public Collection<String> values()
      Specified by:
      values in interface org.refcodes.struct.Keys<String,String>
      Overrides:
      values in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>

    • withArgsSyntax

      public ApplicationProperties withArgsSyntax(org.refcodes.cli.Term aArgsSyntax)
      Specified by:
      withArgsSyntax in interface org.refcodes.cli.ArgsSyntaxAccessor.ArgsSyntaxBuilder<org.refcodes.cli.ParseArgs>

    • withArgumentEscapeCode

      public ApplicationProperties withArgumentEscapeCode(String aParamEscCode)
      Specified by:
      withArgumentEscapeCode in interface org.refcodes.cli.ArgumentEscapeCodeAccessor.ArgumentEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withArgumentEscapeCode in interface org.refcodes.cli.ParseArgs

    • withBannerBorderEscapeCode

      public ApplicationProperties withBannerBorderEscapeCode(String aBannerBorderEscCode)
      Specified by:
      withBannerBorderEscapeCode in interface org.refcodes.cli.BannerBorderEscapeCodeAccessor.BannerBorderEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withBannerBorderEscapeCode in interface org.refcodes.cli.ParseArgs

    • withBannerEscapeCode

      public ApplicationProperties withBannerEscapeCode(String aBannerEscCode)
      Specified by:
      withBannerEscapeCode in interface org.refcodes.cli.BannerEscapeCodeAccessor.BannerEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withBannerEscapeCode in interface org.refcodes.cli.ParseArgs

    • withBannerFont

      public ApplicationProperties withBannerFont(org.refcodes.textual.Font aBannerFont)
      Specified by:
      withBannerFont in interface org.refcodes.cli.BannerFontAccessor.BannerFontBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withBannerFont in interface org.refcodes.cli.ParseArgs

    • withBannerFontPalette

      public ApplicationProperties withBannerFontPalette(org.refcodes.data.AsciiColorPalette aBannerFontPalette)
      Specified by:
      withBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<org.refcodes.cli.ParseArgs>

    • withBannerFontPalette

      public ApplicationProperties withBannerFontPalette(char[] aColorPalette)
      Specified by:
      withBannerFontPalette in interface org.refcodes.cli.BannerFontPaletteAccessor.BannerFontPaletteBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withBannerFontPalette in interface org.refcodes.cli.ParseArgs

    • withCommandEscapeCode

      public ApplicationProperties withCommandEscapeCode(String aCommandEscCode)
      Specified by:
      withCommandEscapeCode in interface org.refcodes.cli.CommandEscapeCodeAccessor.CommandEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withCommandEscapeCode in interface org.refcodes.cli.ParseArgs

    • withConsoleWidth

      public ApplicationProperties withConsoleWidth(int aConsoleWidth)
      Specified by:
      withConsoleWidth in interface org.refcodes.mixin.ConsoleWidthAccessor.ConsoleWidthBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withConsoleWidth in interface org.refcodes.cli.ParseArgs

    • withCopyright

      public ApplicationProperties withCopyright(String aCopyrightNote)
      Specified by:
      withCopyright in interface org.refcodes.cli.CopyrightAccessor.CopyrightBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withCopyright in interface org.refcodes.cli.ParseArgs

    • withDescription

      public ApplicationProperties withDescription(String aDescription)
      Specified by:
      withDescription in interface org.refcodes.mixin.DescriptionAccessor.DescriptionBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withDescription in interface org.refcodes.cli.ParseArgs

    • withDescriptionEscapeCode

      public ApplicationProperties withDescriptionEscapeCode(String aDescriptionEscCode)
      Specified by:
      withDescriptionEscapeCode in interface org.refcodes.cli.DescriptionEscapeCodeAccessor.DescriptionEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withDescriptionEscapeCode in interface org.refcodes.cli.ParseArgs

    • withErrorOut

      public ApplicationProperties withErrorOut(PrintStream aErrorOut)
      Specified by:
      withErrorOut in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withErrorOut in interface org.refcodes.cli.ParseArgs

    • withEscapeCodesEnabled

      public ApplicationProperties withEscapeCodesEnabled(boolean isEscCodeEnabled)
      Specified by:
      withEscapeCodesEnabled in interface org.refcodes.mixin.EscapeCodesStatusAccessor.EscapeCodeStatusBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withEscapeCodesEnabled in interface org.refcodes.cli.ParseArgs

    • withEvalArgs

      public ApplicationProperties withEvalArgs(List<String> aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ParseArgs
      Specified by:
      withEvalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(List<String> aArgs, org.refcodes.cli.ArgsFilter aArgsFilter) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(List<String> aArgs, Pattern aFilterExp) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(String aToPath, List<String> aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(String aToPath, String[] aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(String[] aArgs) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ParseArgs
      Specified by:
      withEvalArgs in interface ParseArgsProperties
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(String[] aArgs, org.refcodes.cli.ArgsFilter aArgsFilter) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withEvalArgs

      public ApplicationProperties withEvalArgs(String[] aArgs, Pattern aFilterExp) throws org.refcodes.cli.ArgsSyntaxException
      Specified by:
      withEvalArgs in interface org.refcodes.cli.ArgsParserBuilder<org.refcodes.cli.ParseArgs>
      Throws:
      org.refcodes.cli.ArgsSyntaxException

    • withAddExample

      public ApplicationProperties withAddExample(org.refcodes.cli.Example aExample)
      Specified by:
      withAddExample in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withAddExample in interface org.refcodes.cli.ParseArgs

    • withAddExample

      public ApplicationProperties withAddExample(String aDescription, org.refcodes.cli.Operand<?>... aOperands)
      Specified by:
      withAddExample in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withAddExample in interface org.refcodes.cli.ParseArgs

    • withExamples

      public ApplicationProperties withExamples(Collection<org.refcodes.cli.Example> aExample)
      Specified by:
      withExamples in interface org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withExamples in interface org.refcodes.cli.ParseArgs

    • withExamples

      public ApplicationProperties withExamples(org.refcodes.cli.Example[] aExample)
      Specified by:
      withExamples in interface org.refcodes.cli.ExamplesAccessor.ExamplesBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withExamples in interface org.refcodes.cli.ParseArgs

    • withFile

      public ApplicationProperties withFile(File aFile) throws IOException, ParseException
      Specified by:
      withFile in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withFile

      public ApplicationProperties withFile(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator) throws IOException, ParseException
      Specified by:
      withFile in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withFile

      public ApplicationProperties withFile(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
      Specified by:
      withFile in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withResourceClass

      public ApplicationProperties withResourceClass(Class<?> aResourceClass, String aFilePath) throws IOException, ParseException
      Specified by:
      withResourceClass in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withResourceClass

      public ApplicationProperties withResourceClass(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
      Specified by:
      withResourceClass in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withResourceClass

      public ApplicationProperties withResourceClass(String aFilePath) throws IOException, ParseException
      Specified by:
      withResourceClass in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withInputStream

      public ApplicationProperties withInputStream(InputStream aInputStream) throws IOException, ParseException
      Specified by:
      withInputStream in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withInputStream

      public ApplicationProperties withInputStream(InputStream aInputStream, char... aDelimiters) throws IOException, ParseException
      Specified by:
      withInputStream in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withLicense

      public ApplicationProperties withLicense(String aLicenseNote)
      Specified by:
      withLicense in interface org.refcodes.cli.LicenseAccessor.LicenseBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withLicense in interface org.refcodes.cli.ParseArgs

    • withLineBreak

      public ApplicationProperties withLineBreak(String aLineBreak)
      Specified by:
      withLineBreak in interface org.refcodes.mixin.LineBreakAccessor.LineBreakBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withLineBreak in interface org.refcodes.cli.ParseArgs

    • withLineSeparatorEscapeCode

      public ApplicationProperties withLineSeparatorEscapeCode(String aLineSeparatorEscCode)
      Specified by:
      withLineSeparatorEscapeCode in interface org.refcodes.cli.LineSeparatorEscapeCodeAccessor.LineSeparatorEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withLineSeparatorEscapeCode in interface org.refcodes.cli.ParseArgs

    • withLongOptionPrefix

      public ApplicationProperties withLongOptionPrefix(String aLongOptionPrefix)
      Specified by:
      withLongOptionPrefix in interface org.refcodes.cli.LongOptionPrefixAccessor.LongOptionPrefixBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withLongOptionPrefix in interface org.refcodes.cli.ParseArgs

    • withMaxConsoleWidth

      public ApplicationProperties withMaxConsoleWidth(int aMaxConsoleWidth)
      Specified by:
      withMaxConsoleWidth in interface org.refcodes.mixin.MaxConsoleWidthAccessor.MaxConsoleWidthBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withMaxConsoleWidth in interface org.refcodes.cli.ParseArgs

    • withName

      public ApplicationProperties withName(String aName)
      Specified by:
      withName in interface org.refcodes.mixin.NameAccessor.NameBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withName in interface org.refcodes.cli.ParseArgs

    • withObfuscationMode

      public ApplicationProperties 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

      public ApplicationProperties withOptionEscapeCode(String aOptionEscCode)
      Specified by:
      withOptionEscapeCode in interface org.refcodes.cli.OptionEscapeCodeAccessor.OptionEscapeCodeBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withOptionEscapeCode in interface org.refcodes.cli.ParseArgs

    • withProperties

      public ApplicationProperties 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

      public ApplicationProperties withResetEscapeCode(String aResetEscCode)
      Specified by:
      withResetEscapeCode in interface org.refcodes.cli.ParseArgs
      Specified by:
      withResetEscapeCode in interface org.refcodes.mixin.ResetEscapeCodeAccessor.ResetEscapeCodeBuilder<org.refcodes.cli.ParseArgs>

    • withSecret

      public ApplicationProperties withSecret(String aSecret)
      Specified by:
      withSecret in interface org.refcodes.mixin.SecretAccessor.SecretBuilder<ApplicationProperties>

    • withSeparatorLnChar

      public ApplicationProperties withSeparatorLnChar(char aSeparatorChar)
      Specified by:
      withSeparatorLnChar in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withSeparatorLnChar in interface org.refcodes.cli.ParseArgs

    • withShortOptionPrefix

      public ApplicationProperties withShortOptionPrefix(Character aShortOptionPrefix)
      Specified by:
      withShortOptionPrefix in interface org.refcodes.cli.ParseArgs
      Specified by:
      withShortOptionPrefix in interface org.refcodes.cli.ShortOptionPrefixAccessor.ShortOptionPrefixBuilder<org.refcodes.cli.ParseArgs>

    • withStandardOut

      public ApplicationProperties withStandardOut(PrintStream aStandardOut)
      Specified by:
      withStandardOut in interface org.refcodes.cli.ArgsProcessorBuilder<org.refcodes.cli.ParseArgs>
      Specified by:
      withStandardOut in interface org.refcodes.cli.ParseArgs

    • withSyntaxMetrics

      public ApplicationProperties withSyntaxMetrics(org.refcodes.cli.SyntaxMetrics aSyntaxMetrics)
      Specified by:
      withSyntaxMetrics in interface org.refcodes.cli.ParseArgs
      Specified by:
      withSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ParseArgs>

    • withSyntaxMetrics

      public org.refcodes.cli.ParseArgs withSyntaxMetrics(org.refcodes.cli.SyntaxNotation aSyntaxNotation)
      Specified by:
      withSyntaxMetrics in interface org.refcodes.cli.SyntaxMetricsAccessor.SyntaxMetricsBuilder<org.refcodes.cli.ParseArgs>

    • withTextBoxGrid

      public ApplicationProperties withTextBoxGrid(org.refcodes.textual.TextBoxGrid aTextBoxGrid)
      Specified by:
      withTextBoxGrid in interface org.refcodes.cli.ParseArgs
      Specified by:
      withTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ParseArgs>

    • withTextBoxGrid

      public ApplicationProperties withTextBoxGrid(org.refcodes.textual.TextBoxStyle aTextBoxStyle)
      Specified by:
      withTextBoxGrid in interface org.refcodes.cli.ParseArgs
      Specified by:
      withTextBoxGrid in interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder<org.refcodes.cli.ParseArgs>

    • withTitle

      public ApplicationProperties withTitle(String aTitle)
      Specified by:
      withTitle in interface org.refcodes.cli.ParseArgs
      Specified by:
      withTitle in interface org.refcodes.mixin.TitleAccessor.TitleBuilder<org.refcodes.cli.ParseArgs>

    • withUrl

      public ApplicationProperties withUrl(URL aUrl) throws IOException, ParseException
      Specified by:
      withUrl in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • withUrl

      public ApplicationProperties withUrl(URL aUrl, char... aDelimiters) throws IOException, ParseException
      Specified by:
      withUrl in interface org.refcodes.properties.ResourceLoaderBuilder<ApplicationProperties>
      Throws:
      IOException
      ParseException

    • addResourceProperties

      public org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder addResourceProperties(URL aUrl, char... aDelimiters) throws IOException, ParseException
      Reads the ResourceProperties from the given data sink.
      Parameters:
      aUrl - The data sink from which to read the ResourceProperties.
      aDelimiters - The delimiters in the properties file to identity a path delimiter.
      Returns:
      the according ResourceProperties.ResourcePropertiesBuilder instance.
      Throws:
      IOException - Thrown in case there were problems reading the data sink.
      ParseException - Thrown in case there were problems parsing the data from the data sink.

    • addResourceProperties

      public org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder addResourceProperties(Class<?> aResourceClass, String aFilePath, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
      Reads the ResourceProperties.ResourcePropertiesBuilder from the given data sink.
      Parameters:
      aResourceClass - The class which's class loader is to take care of loading the properties (from inside a JAR).
      aFilePath - The data sink from which to read the ResourceProperties.ResourcePropertiesBuilder.
      aConfigLocator - The ConfigLocator specifying where to seek for properties.
      aDelimiters - The delimiters in the properties file to identity a path delimiter.
      Returns:
      the according ResourceProperties.ResourcePropertiesBuilder instance.
      Throws:
      IOException - Thrown in case there were problems reading the data sink.
      ParseException - Thrown in case there were problems parsing the data from the data sink.

    • addResourceProperties

      public org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder addResourceProperties(File aFile, org.refcodes.runtime.ConfigLocator aConfigLocator, char... aDelimiters) throws IOException, ParseException
      Reads the ResourceProperties.ResourcePropertiesBuilder from the given data sink.
      Parameters:
      aFile - The data sink from which to read the ResourceProperties.ResourcePropertiesBuilder.
      aConfigLocator - The ConfigLocator specifying where to seek for properties.
      aDelimiters - The delimiters in the properties file to identity a path delimiter.
      Returns:
      the according ResourceProperties.ResourcePropertiesBuilder instance.
      Throws:
      IOException - Thrown in case there were problems reading the data sink.
      ParseException - Thrown in case there were problems parsing the data from the data sink.

    • addResourceProperties

      public org.refcodes.properties.ResourceProperties.ResourcePropertiesBuilder addResourceProperties(InputStream aInputStream, char[] aDelimiters) throws IOException, ParseException
      Reads the ResourceProperties from the given data sink.
      Parameters:
      aInputStream - The data sink from which to read the ResourceProperties.
      aDelimiters - The delimiters in the properties file to identity a path delimiter.
      Returns:
      the according ResourceProperties.ResourcePropertiesBuilder instance.
      Throws:
      IOException - Thrown in case there were problems reading the data sink.
      ParseException - Thrown in case there were problems parsing the data from the data sink.

    • addProperties

      protected void addProperties(org.refcodes.properties.Properties aProperties)
      Adds the properties.
      Parameters:
      aProperties - the properties

    • getProperties

      protected org.refcodes.properties.Properties getProperties()
      Overrides:
      getProperties in class org.refcodes.properties.AbstractPropertiesDecorator<org.refcodes.properties.Properties>