Package org.refcodes.console

Interface Flag

All Superinterfaces:

org.refcodes.mixin.AliasAccessor, ArgsAccessor, java.lang.Comparable<java.lang.Boolean>, org.refcodes.mixin.DescriptionAccessor, Operand<java.lang.Boolean>, Option<java.lang.Boolean>, org.refcodes.component.Resetable, Syntaxable, SyntaxUsage, org.refcodes.mixin.TypeAccessor<java.lang.Boolean>, org.refcodes.mixin.ValueAccessor<java.lang.Boolean>

All Known Implementing Classes:

FlagImpl, ForceFlagImpl, HelpFlagImpl, QuietFlagImpl, SysInfoFlagImpl, VerboseFlagImpl

public interface Flag
extends Option<java.lang.Boolean>

A Flag is an Option with a Boolean state. Usually switches are just set or omitted in the command line arguments with no value provided; former representing a true status and latter representing a false status.

Nested Class Summary

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

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.console.ArgsAccessor

ArgsAccessor.ArgsMutator, ArgsAccessor.ArgsProperty

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.mixin.TypeAccessor

org.refcodes.mixin.TypeAccessor.TypeMutator<T extends java.lang.Object>, org.refcodes.mixin.TypeAccessor.TypeProperty<T extends java.lang.Object>

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

org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends java.lang.Object,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends java.lang.Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
default boolean	isEnabled()	Returns true if the switch has been provided.

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.refcodes.mixin.DescriptionAccessor

getDescription

Methods inherited from interface org.refcodes.console.Operand

get, getAlias, getArgs, getValue, hasValue

Methods inherited from interface org.refcodes.console.Option

getLongOption, getShortOption

Methods inherited from interface org.refcodes.component.Resetable

reset

Methods inherited from interface org.refcodes.console.Syntaxable

parseArgs, toState, toSyntax

Methods inherited from interface org.refcodes.console.SyntaxUsage

toUsage, toUsage

Methods inherited from interface org.refcodes.mixin.TypeAccessor

getType

Method Detail

isEnabled

default boolean isEnabled()

Returns true if the switch has been provided. Same as testing if Operand.getValue() is true.

Returns:

True in case the Flag has been provided (set), else false.