DefaultNCmdLine (Nuts Community Core Runtime 1.1.0.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.cmdline.DefaultNCmdLine

All Implemented Interfaces:: Iterable<NArg>, NCmdLine, NBlankable

public class DefaultNCmdLine
extends Object
implements NCmdLine

 NCmdLine args=new DefaultNCmdLine(Arrays.asList("--!deleteLog","--deploy","/deploy/path","--deploy=/other-deploy/path","some-param"));
 Argument a;
 while (args.hasNext()) {
 if ((a = args.nextBoolean("--deleteLog").orNull()) != null) {
 deleteLog = a.getBooleanValue().get(session);
 } else if ((a = args.nextString("--deploy").orNull()) != null) {
 apps.add(a.getStringValue().get(session));
 } else if ((a = args.next()) != null) {
 name = a.getString();
 } else {
 args.throwUnexpectedArgument();
 }
 }

Field Summary

Fields
Modifier and Type	Field and Description
`protected LinkedList<String>`	`args`
`protected String`	`commandName`
`protected boolean`	`expandArgumentsFile`
`protected boolean`	`expandSimpleOptions`
`protected List<NArg>`	`lookahead`
`protected Set<String>`	`specialSimpleOptions`

Constructor Summary

Constructors
Constructor and Description
`DefaultNCmdLine()` Default n cmd line.
`DefaultNCmdLine(List<String> args)` Default n cmd line.
`DefaultNCmdLine(String[] args, NShellFamily shellFamily)` Default n cmd line.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(int index, String... values)`
`boolean`	`accept(String... values)`
`NCmdLine`	`add(String argument)`
`NCmdLine`	`addAll(List<String> arguments)`
`NCmdLine`	`append(String... args)` Append.
`String`	`commandName()`
`NCmdLine`	`commandName(String commandName)`
`NArgCompletePosition`	`completePosition()` Complete position.
`NCmdLine`	`completePosition(NArgCompletePosition completePosition)`
`NArgCompleteResult`	`completeResult()`
`NCmdLineConfigurable`	`configurable()`
`NCmdLine`	`configurable(NCmdLineConfigurable configurable)` Configurable.
`boolean`	`contains(String name)`
`NCmdLine`	`copy()` Copy.
`NCmdLine`	`expandArgumentsFile(boolean expandArgumentsFile)`
`NCmdLine`	`expandSimpleOptions(boolean expand)`
`NOptional<NArg>`	`find(String name)`
`NOptional<NArg>`	`get(int index)`
`boolean`	`hasNext()`
`boolean`	`hasNextNonOption()`
`boolean`	`hasNextOption()`
`int`	`indexOf(String name)`
`boolean`	`isBlank()`
`boolean`	`isCompleteMode()`
`boolean`	`isEmpty()`
`boolean`	`isExecMode()`
`boolean`	`isExpandArgumentsFile()`
`boolean`	`isExpandSimpleOptions()`
`boolean`	`isNextNonOption()`
`boolean`	`isNextOption()`
`boolean`	`isNonOption(int index)`
`boolean`	`isOption(int index)`
`boolean`	`isSpecialSimpleOption(String option)`
`Iterator<NArg>`	`iterator()`
`int`	`length()`
`NCmdLineMatcher`	`matcher()` Matcher.
`NOptional<NArg>`	`next()`
`NOptional<NArg>`	`next(boolean expandSimpleOptions, boolean expandArgumentsFile)` Next.
`NOptional<NArg>`	`next(NArgType expectedArgType, String... names)`
`NOptional<NArg>`	`next(NArgType expectedArgType, String argDisplay, NArgValueComplete valueComplete, String... names)` Next.
`NOptional<NArg>`	`next(String... names)`
`NArg[]`	`nextAllAsArgumentArray()`
`String[]`	`nextAllAsStringArray()`
`List<String>`	`nextAllAsStringList()`
`NOptional<NArg>`	`nextAttachedEntry()`
`NOptional<NArg>`	`nextAttachedEntry(String... names)`
`NOptional<NArg>`	`nextEntry()`
`NOptional<NArg>`	`nextEntry(String... names)`
`NOptional<NArg>`	`nextFlag()`
`NOptional<NArg>`	`nextFlag(String... names)`
`NOptional<NArg>`	`nextNonOption()`
`NOptional<NArg>`	`nextNonOption(String display)`
`NOptional<NArg>`	`nextNonOption(String display, NArgValueComplete complete)`
`NOptional<NArg>`	`nextRequiredEntry()`
`NOptional<NArg>`	`nextRequiredEntry(String... names)`
`static NOptional<String[]>`	`parseDefaultList(String commandLineString)` Parse default list.
`NOptional<NArg>`	`peek()`
`NOptional<NArg>`	`peekNonOption()`
`NOptional<NArg>`	`peekOption()`
`NArgCompleteResult`	`printCompleteResult()`
`NCmdLine`	`pushBack(NArg... args)` Push back.
`NCmdLine`	`pushBack(NArg arg)`
`NCmdLine`	`pushBack(String... args)` Push back.
`NCmdLine`	`registerSpecialSimpleOption(String option)`
`NCmdLine`	`setArguments(List<String> arguments)` Sets the arguments.
`NCmdLine`	`setArguments(String[] arguments)` Sets the arguments.
`NShellFamily`	`shellFamily()` Shell family.
`NCmdLine`	`shellFamily(NShellFamily shellFamily)` Shell family.
`int`	`skip()`
`int`	`skip(int count)`
`int`	`skipAll()`
`Object`	`source()`
`NCmdLine`	`source(Object source)`
`String[]`	`specialSimpleOptions()`
`void`	`throwError(NMsg message)`
`void`	`throwError(NText message)`
`NCmdLine`	`throwMissingArgument()`
`NCmdLine`	`throwMissingArgument(NMsg errorMessage)`
`NCmdLine`	`throwMissingArgument(String argumentName)`
`NCmdLine`	`throwUnexpectedArgument()`
`NCmdLine`	`throwUnexpectedArgument(NMsg errorMessage)`
`NCmdLine`	`throwUnexpectedArgument(NText errorMessage)`
`NArg[]`	`toArgumentArray()`
`String`	`toString()`
`String[]`	`toStringArray()`
`List<String>`	`toStringList()`
`NCmdLine`	`unregisterSpecialSimpleOption(String option)`
`int`	`wordIndex()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLine
forEach, of, of, of, of, ofArgs, ofArgs, ofDefault, parse, parse, parse, parseDefault

Methods inherited from interface java.lang.Iterable
spliterator

Methods inherited from interface net.thevpc.nuts.util.NBlankable
firstNonBlank, firstNonBlank, firstNonBlank, firstNonBlankLazy, firstNonBlankLazy, isBlank, isBlank, isBlank, isBlank, isBlank, isNonBlank

- Field Detail
  - args
```
protected LinkedList<String> args
```
  - lookahead
```
protected List<NArg> lookahead
```
  - expandSimpleOptions
```
protected boolean expandSimpleOptions
```
  - expandArgumentsFile
```
protected boolean expandArgumentsFile
```
  - specialSimpleOptions
```
protected Set<String> specialSimpleOptions
```
  - commandName
```
protected String commandName
```
- Constructor Detail
  - DefaultNCmdLine
```
public DefaultNCmdLine()
```
    Default n cmd line.
  - DefaultNCmdLine
```
public DefaultNCmdLine(String[] args,
                       NShellFamily shellFamily)
```
    Default n cmd line.
    
    Parameters:
    
    args - args
    
    shellFamily - shell family
  - DefaultNCmdLine
```
public DefaultNCmdLine(List<String> args)
```
    Default n cmd line.
    
    Parameters:
    
    args - args
- Method Detail
  - shellFamily
```
public NShellFamily shellFamily()
```
    Shell family.
    
    Specified by:
    
    shellFamily in interface NCmdLine
    
    Returns:
    
    shell family result
  - shellFamily
```
public NCmdLine shellFamily(NShellFamily shellFamily)
```
    Shell family.
    
    Specified by:
    
    shellFamily in interface NCmdLine
    
    Parameters:
    
    shellFamily - shell family
    
    Returns:
    
    shell family result
  - source
```
public Object source()
```
    Specified by:
    
    source in interface NCmdLine
  - source
```
public NCmdLine source(Object source)
```
    Specified by:
    
    source in interface NCmdLine
  - configurable
```
public NCmdLineConfigurable configurable()
```
    Specified by:
    
    configurable in interface NCmdLine
  - configurable
```
public NCmdLine configurable(NCmdLineConfigurable configurable)
```
    Configurable.
    
    Specified by:
    
    configurable in interface NCmdLine
    
    Parameters:
    
    configurable - configurable
    
    Returns:
    
    configurable result
  - isExpandArgumentsFile
```
public boolean isExpandArgumentsFile()
```
    Specified by:
    
    isExpandArgumentsFile in interface NCmdLine
  - expandArgumentsFile
```
public NCmdLine expandArgumentsFile(boolean expandArgumentsFile)
```
    Specified by:
    
    expandArgumentsFile in interface NCmdLine
  - completeResult
```
public NArgCompleteResult completeResult()
```
    Specified by:
    
    completeResult in interface NCmdLine
  - printCompleteResult
```
public NArgCompleteResult printCompleteResult()
```
    Specified by:
    
    printCompleteResult in interface NCmdLine
  - completePosition
```
public NCmdLine completePosition(NArgCompletePosition completePosition)
```
    Specified by:
    
    completePosition in interface NCmdLine
  - unregisterSpecialSimpleOption
```
public NCmdLine unregisterSpecialSimpleOption(String option)
```
    Specified by:
    
    unregisterSpecialSimpleOption in interface NCmdLine
  - specialSimpleOptions
```
public String[] specialSimpleOptions()
```
    Specified by:
    
    specialSimpleOptions in interface NCmdLine
  - registerSpecialSimpleOption
```
public NCmdLine registerSpecialSimpleOption(String option)
```
    Specified by:
    
    registerSpecialSimpleOption in interface NCmdLine
  - isSpecialSimpleOption
```
public boolean isSpecialSimpleOption(String option)
```
    Specified by:
    
    isSpecialSimpleOption in interface NCmdLine
  - wordIndex
```
public int wordIndex()
```
    Specified by:
    
    wordIndex in interface NCmdLine
  - isExecMode
```
public boolean isExecMode()
```
    Specified by:
    
    isExecMode in interface NCmdLine
  - isCompleteMode
```
public boolean isCompleteMode()
```
    Specified by:
    
    isCompleteMode in interface NCmdLine
  - commandName
```
public String commandName()
```
    Specified by:
    
    commandName in interface NCmdLine
  - commandName
```
public NCmdLine commandName(String commandName)
```
    Specified by:
    
    commandName in interface NCmdLine
  - isExpandSimpleOptions
```
public boolean isExpandSimpleOptions()
```
    Specified by:
    
    isExpandSimpleOptions in interface NCmdLine
  - expandSimpleOptions
```
public NCmdLine expandSimpleOptions(boolean expand)
```
    Specified by:
    
    expandSimpleOptions in interface NCmdLine
  - throwUnexpectedArgument
```
public NCmdLine throwUnexpectedArgument(NText errorMessage)
```
    Specified by:
    
    throwUnexpectedArgument in interface NCmdLine
  - throwUnexpectedArgument
```
public NCmdLine throwUnexpectedArgument(NMsg errorMessage)
```
    Specified by:
    
    throwUnexpectedArgument in interface NCmdLine
  - throwMissingArgument
```
public NCmdLine throwMissingArgument()
```
    Specified by:
    
    throwMissingArgument in interface NCmdLine
  - throwMissingArgument
```
public NCmdLine throwMissingArgument(String argumentName)
```
    Specified by:
    
    throwMissingArgument in interface NCmdLine
  - throwMissingArgument
```
public NCmdLine throwMissingArgument(NMsg errorMessage)
```
    Specified by:
    
    throwMissingArgument in interface NCmdLine
  - throwUnexpectedArgument
```
public NCmdLine throwUnexpectedArgument()
```
    Specified by:
    
    throwUnexpectedArgument in interface NCmdLine
  - pushBack
```
public NCmdLine pushBack(NArg arg)
```
    Specified by:
    
    pushBack in interface NCmdLine
  - next
```
public NOptional<NArg> next()
```
    Specified by:
    
    next in interface NCmdLine
  - isNextOption
```
public boolean isNextOption()
```
    Specified by:
    
    isNextOption in interface NCmdLine
  - isNextNonOption
```
public boolean isNextNonOption()
```
    Specified by:
    
    isNextNonOption in interface NCmdLine
  - peek
```
public NOptional<NArg> peek()
```
    Specified by:
    
    peek in interface NCmdLine
  - peekNonOption
```
public NOptional<NArg> peekNonOption()
```
    Specified by:
    
    peekNonOption in interface NCmdLine
  - peekOption
```
public NOptional<NArg> peekOption()
```
    Specified by:
    
    peekOption in interface NCmdLine
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface NCmdLine
  - hasNextOption
```
public boolean hasNextOption()
```
    Specified by:
    
    hasNextOption in interface NCmdLine
  - hasNextNonOption
```
public boolean hasNextNonOption()
```
    Specified by:
    
    hasNextNonOption in interface NCmdLine
  - nextFlag
```
public NOptional<NArg> nextFlag(String... names)
```
    Specified by:
    
    nextFlag in interface NCmdLine
  - nextEntry
```
public NOptional<NArg> nextEntry(String... names)
```
    Specified by:
    
    nextEntry in interface NCmdLine
  - nextAttachedEntry
```
public NOptional<NArg> nextAttachedEntry(String... names)
```
    Specified by:
    
    nextAttachedEntry in interface NCmdLine
  - nextRequiredEntry
```
public NOptional<NArg> nextRequiredEntry(String... names)
```
    Specified by:
    
    nextRequiredEntry in interface NCmdLine
  - nextAttachedEntry
```
public NOptional<NArg> nextAttachedEntry()
```
    Specified by:
    
    nextAttachedEntry in interface NCmdLine
  - nextRequiredEntry
```
public NOptional<NArg> nextRequiredEntry()
```
    Specified by:
    
    nextRequiredEntry in interface NCmdLine
  - nextEntry
```
public NOptional<NArg> nextEntry()
```
    Specified by:
    
    nextEntry in interface NCmdLine
  - nextFlag
```
public NOptional<NArg> nextFlag()
```
    Specified by:
    
    nextFlag in interface NCmdLine
  - matcher
```
public NCmdLineMatcher matcher()
```
    Matcher.
    
    Specified by:
    
    matcher in interface NCmdLine
    
    Returns:
    
    matcher result
  - next
```
public NOptional<NArg> next(String... names)
```
    Specified by:
    
    next in interface NCmdLine
  - next
```
public NOptional<NArg> next(NArgType expectedArgType,
                            String... names)
```
    Specified by:
    
    next in interface NCmdLine
  - completePosition
```
public NArgCompletePosition completePosition()
```
    Complete position.
    
    Specified by:
    
    completePosition in interface NCmdLine
    
    Returns:
    
    complete position result
  - next
```
public NOptional<NArg> next(NArgType expectedArgType,
                            String argDisplay,
                            NArgValueComplete valueComplete,
                            String... names)
```
    Next.
    
    Specified by:
    
    next in interface NCmdLine
    
    Parameters:
    
    expectedArgType - expected arg type
    
    argDisplay - arg display
    
    valueComplete - value complete
    
    names - names
    
    Returns:
    
    next result
  - nextNonOption
```
public NOptional<NArg> nextNonOption(String display)
```
    Specified by:
    
    nextNonOption in interface NCmdLine
  - nextNonOption
```
public NOptional<NArg> nextNonOption(String display,
                                     NArgValueComplete complete)
```
    Specified by:
    
    nextNonOption in interface NCmdLine
  - nextNonOption
```
public NOptional<NArg> nextNonOption()
```
    Specified by:
    
    nextNonOption in interface NCmdLine
  - skipAll
```
public int skipAll()
```
    Specified by:
    
    skipAll in interface NCmdLine
  - skip
```
public int skip()
```
    Specified by:
    
    skip in interface NCmdLine
  - skip
```
public int skip(int count)
```
    Specified by:
    
    skip in interface NCmdLine
  - accept
```
public boolean accept(String... values)
```
    Specified by:
    
    accept in interface NCmdLine
  - accept
```
public boolean accept(int index,
                      String... values)
```
    Specified by:
    
    accept in interface NCmdLine
  - find
```
public NOptional<NArg> find(String name)
```
    Specified by:
    
    find in interface NCmdLine
  - get
```
public NOptional<NArg> get(int index)
```
    Specified by:
    
    get in interface NCmdLine
  - contains
```
public boolean contains(String name)
```
    Specified by:
    
    contains in interface NCmdLine
  - indexOf
```
public int indexOf(String name)
```
    Specified by:
    
    indexOf in interface NCmdLine
  - length
```
public int length()
```
    Specified by:
    
    length in interface NCmdLine
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface NCmdLine
  - toStringArray
```
public String[] toStringArray()
```
    Specified by:
    
    toStringArray in interface NCmdLine
  - nextAllAsStringArray
```
public String[] nextAllAsStringArray()
```
    Specified by:
    
    nextAllAsStringArray in interface NCmdLine
  - nextAllAsStringList
```
public List<String> nextAllAsStringList()
```
    Specified by:
    
    nextAllAsStringList in interface NCmdLine
  - nextAllAsArgumentArray
```
public NArg[] nextAllAsArgumentArray()
```
    Specified by:
    
    nextAllAsArgumentArray in interface NCmdLine
  - toStringList
```
public List<String> toStringList()
```
    Specified by:
    
    toStringList in interface NCmdLine
  - toArgumentArray
```
public NArg[] toArgumentArray()
```
    Specified by:
    
    toArgumentArray in interface NCmdLine
  - isOption
```
public boolean isOption(int index)
```
    Specified by:
    
    isOption in interface NCmdLine
  - isNonOption
```
public boolean isNonOption(int index)
```
    Specified by:
    
    isNonOption in interface NCmdLine
  - setArguments
```
public NCmdLine setArguments(List<String> arguments)
```
    Sets the arguments.
    
    Specified by:
    
    setArguments in interface NCmdLine
    
    Parameters:
    
    arguments - arguments
    
    Returns:
    
    set arguments result
  - setArguments
```
public NCmdLine setArguments(String[] arguments)
```
    Sets the arguments.
    
    Specified by:
    
    setArguments in interface NCmdLine
    
    Parameters:
    
    arguments - arguments
    
    Returns:
    
    set arguments result
  - throwError
```
public void throwError(NMsg message)
```
    Specified by:
    
    throwError in interface NCmdLine
  - throwError
```
public void throwError(NText message)
```
    Specified by:
    
    throwError in interface NCmdLine
  - next
```
public NOptional<NArg> next(boolean expandSimpleOptions,
                            boolean expandArgumentsFile)
```
    Next.
    
    Parameters:
    
    expandSimpleOptions - expand simple options
    
    expandArgumentsFile - expand arguments file
    
    Returns:
    
    next result
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - copy
```
public NCmdLine copy()
```
    Copy.
    
    Specified by:
    
    copy in interface NCmdLine
    
    Returns:
    
    copy result
  - iterator
```
public Iterator<NArg> iterator()
```
    Specified by:
    
    iterator in interface Iterable<NArg>
    
    Specified by:
    
    iterator in interface NCmdLine
  - parseDefaultList
```
public static NOptional<String[]> parseDefaultList(String commandLineString)
```
    Parse default list.
    
    Parameters:
    
    commandLineString - command line string
    
    Returns:
    
    parse default list result
  - add
```
public NCmdLine add(String argument)
```
    Specified by:
    
    add in interface NCmdLine
  - addAll
```
public NCmdLine addAll(List<String> arguments)
```
    Specified by:
    
    addAll in interface NCmdLine
  - isBlank
```
public boolean isBlank()
```
    Specified by:
    
    isBlank in interface NBlankable
  - pushBack
```
public NCmdLine pushBack(NArg... args)
```
    Push back.
    
    Specified by:
    
    pushBack in interface NCmdLine
    
    Parameters:
    
    args - args
    
    Returns:
    
    push back result
  - pushBack
```
public NCmdLine pushBack(String... args)
```
    Push back.
    
    Specified by:
    
    pushBack in interface NCmdLine
    
    Parameters:
    
    args - args
    
    Returns:
    
    push back result
  - append
```
public NCmdLine append(String... args)
```
    Append.
    
    Specified by:
    
    append in interface NCmdLine
    
    Parameters:
    
    args - args
    
    Returns:
    
    append result

Class DefaultNCmdLine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.cmdline.NCmdLine

Methods inherited from interface java.lang.Iterable

Methods inherited from interface net.thevpc.nuts.util.NBlankable

Field Detail

args

lookahead

expandSimpleOptions

expandArgumentsFile

specialSimpleOptions

commandName

Constructor Detail

DefaultNCmdLine

DefaultNCmdLine

DefaultNCmdLine

Method Detail

shellFamily

shellFamily

source

source

configurable

configurable

isExpandArgumentsFile

expandArgumentsFile

completeResult

printCompleteResult

completePosition

unregisterSpecialSimpleOption

specialSimpleOptions

registerSpecialSimpleOption

isSpecialSimpleOption

wordIndex

isExecMode

isCompleteMode

commandName

commandName

isExpandSimpleOptions

expandSimpleOptions

throwUnexpectedArgument

throwUnexpectedArgument

throwMissingArgument

throwMissingArgument

throwMissingArgument

throwUnexpectedArgument

pushBack

next

isNextOption

isNextNonOption

peek

peekNonOption

peekOption

hasNext

hasNextOption

hasNextNonOption

nextFlag

nextEntry

nextAttachedEntry

nextRequiredEntry

nextAttachedEntry

nextRequiredEntry

nextEntry

nextFlag

matcher

next

next

completePosition

next

nextNonOption

nextNonOption

nextNonOption

skipAll

skip

skip

accept

accept

find