DefaultNutsCommandLine (Nuts Community Runtime 0.8.3.0 API)

java.lang.Object
- net.thevpc.nuts.runtime.standalone.app.cmdline.DefaultNutsCommandLine

All Implemented Interfaces:: Iterable<net.thevpc.nuts.NutsArgument>, net.thevpc.nuts.NutsCommandLine, net.thevpc.nuts.NutsFormattable

public class DefaultNutsCommandLine
extends Object
implements net.thevpc.nuts.NutsCommandLine

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

Created by vpc on 12/7/16.

Field Summary

Fields
Modifier and Type	Field and Description
`protected LinkedList<String>`	`args`
`protected String`	`commandName`
`protected boolean`	`expandSimpleOptions`
`protected List<net.thevpc.nuts.NutsArgument>`	`lookahead`
`protected net.thevpc.nuts.NutsSession`	`session`
`protected Set<String>`	`specialSimpleOptions`

Constructor Summary

Constructors
Constructor and Description
`DefaultNutsCommandLine(List<String> args)`
`DefaultNutsCommandLine(net.thevpc.nuts.NutsApplicationContext context)`
`DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session)`
`DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session, List<String> args, net.thevpc.nuts.NutsCommandAutoComplete autoComplete)`
`DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session, String[] args)`
`DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session, String[] args, net.thevpc.nuts.NutsCommandAutoComplete autoComplete)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(int index, String... values)`
`boolean`	`accept(String... values)`
`boolean`	`contains(String name)`
`net.thevpc.nuts.NutsCommandLine`	`copy()`
`net.thevpc.nuts.NutsArgument`	`find(String name)`
`net.thevpc.nuts.NutsCommandLineFormat`	`formatter()`
`net.thevpc.nuts.NutsArgument`	`get(int index)`
`net.thevpc.nuts.NutsCommandAutoComplete`	`getAutoComplete()`
`String`	`getCommandName()`
`net.thevpc.nuts.NutsSession`	`getSession()`
`String[]`	`getSpecialSimpleOptions()`
`int`	`getWordIndex()`
`boolean`	`hasNext()`
`int`	`indexOf(String name)`
`boolean`	`isAutoCompleteMode()`
`boolean`	`isEmpty()`
`boolean`	`isExecMode()`
`boolean`	`isExpandSimpleOptions()`
`boolean`	`isNonOption(int index)`
`boolean`	`isOption(int index)`
`boolean`	`isSpecialSimpleOption(String option)`
`Iterator<net.thevpc.nuts.NutsArgument>`	`iterator()`
`int`	`length()`
`net.thevpc.nuts.NutsArgument`	`next()`
`net.thevpc.nuts.NutsArgument`	`next(boolean required, boolean expandSimpleOptions)`
`net.thevpc.nuts.NutsArgument`	`next(net.thevpc.nuts.NutsArgumentName name)`
`net.thevpc.nuts.NutsArgument`	`next(net.thevpc.nuts.NutsArgumentName name, boolean forceNonOption, boolean error)`
`net.thevpc.nuts.NutsArgument`	`next(net.thevpc.nuts.NutsArgumentType expectValue, String... names)`
`net.thevpc.nuts.NutsArgument`	`next(String... names)`
`net.thevpc.nuts.NutsArgument`	`nextBoolean(String... names)`
`net.thevpc.nuts.NutsArgument`	`nextNonOption()`
`net.thevpc.nuts.NutsArgument`	`nextNonOption(net.thevpc.nuts.NutsArgumentName name)`
`net.thevpc.nuts.NutsArgument`	`nextRequiredNonOption(net.thevpc.nuts.NutsArgumentName name)`
`net.thevpc.nuts.NutsArgument`	`nextString(String... names)`
`net.thevpc.nuts.NutsCommandLine`	`parseLine(String commandLine)`
`net.thevpc.nuts.NutsArgument`	`peek()`
`net.thevpc.nuts.NutsCommandLine`	`pushBack(net.thevpc.nuts.NutsArgument arg)`
`net.thevpc.nuts.NutsCommandLine`	`registerSpecialSimpleOption(String option)`
`net.thevpc.nuts.NutsCommandLine`	`required()`
`net.thevpc.nuts.NutsCommandLine`	`required(net.thevpc.nuts.NutsMessage errorMessage)`
`net.thevpc.nuts.NutsCommandLine`	`required(net.thevpc.nuts.NutsString errorMessage)`
`net.thevpc.nuts.NutsCommandLine`	`requiredNonOptions(String... nonOptions)`
`net.thevpc.nuts.NutsCommandLine`	`requiredOptions(String... options)`
`net.thevpc.nuts.NutsCommandLine`	`requireNonOption()`
`net.thevpc.nuts.NutsCommandLine`	`setArguments(List<String> arguments)`
`net.thevpc.nuts.NutsCommandLine`	`setArguments(String[] arguments)`
`net.thevpc.nuts.NutsCommandLine`	`setAutoComplete(net.thevpc.nuts.NutsCommandAutoComplete autoComplete)`
`net.thevpc.nuts.NutsCommandLine`	`setCommandName(String commandName)`
`net.thevpc.nuts.NutsCommandLine`	`setExpandSimpleOptions(boolean expand)`
`int`	`skip()`
`int`	`skip(int count)`
`int`	`skipAll()`
`void`	`throwError(net.thevpc.nuts.NutsMessage message)`
`void`	`throwError(net.thevpc.nuts.NutsString message)`
`net.thevpc.nuts.NutsArgument[]`	`toArgumentArray()`
`String`	`toString()`
`String[]`	`toStringArray()`
`net.thevpc.nuts.NutsCommandLine`	`unexpectedArgument()`
`net.thevpc.nuts.NutsCommandLine`	`unexpectedArgument(net.thevpc.nuts.NutsMessage errorMessage)`
`net.thevpc.nuts.NutsCommandLine`	`unexpectedArgument(net.thevpc.nuts.NutsString errorMessage)`
`net.thevpc.nuts.NutsCommandLine`	`unregisterSpecialSimpleOption(String option)`

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

Methods inherited from interface net.thevpc.nuts.NutsCommandLine
of, of, of, of

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface net.thevpc.nuts.NutsFormattable
format

Field Detail

args
```
protected LinkedList<String> args
```

lookahead

protected List<net.thevpc.nuts.NutsArgument> lookahead

expandSimpleOptions
```
protected boolean expandSimpleOptions
```

specialSimpleOptions

protected Set<String> specialSimpleOptions

commandName
```
protected String commandName
```

session

protected net.thevpc.nuts.NutsSession session

Constructor Detail

DefaultNutsCommandLine

public DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session)

DefaultNutsCommandLine

public DefaultNutsCommandLine(net.thevpc.nuts.NutsApplicationContext context)

DefaultNutsCommandLine

public DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session,
                              String[] args,
                              net.thevpc.nuts.NutsCommandAutoComplete autoComplete)

DefaultNutsCommandLine

public DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session,
                              String[] args)

DefaultNutsCommandLine

public DefaultNutsCommandLine(net.thevpc.nuts.NutsSession session,
                              List<String> args,
                              net.thevpc.nuts.NutsCommandAutoComplete autoComplete)

DefaultNutsCommandLine

public DefaultNutsCommandLine(List<String> args)

Method Detail
- getSession
```
public net.thevpc.nuts.NutsSession getSession()
```
- getAutoComplete
```
public net.thevpc.nuts.NutsCommandAutoComplete getAutoComplete()
```
  Specified by:
  
  getAutoComplete in interface net.thevpc.nuts.NutsCommandLine
- setAutoComplete
```
public net.thevpc.nuts.NutsCommandLine setAutoComplete(net.thevpc.nuts.NutsCommandAutoComplete autoComplete)
```
  Specified by:
  
  setAutoComplete in interface net.thevpc.nuts.NutsCommandLine
- unregisterSpecialSimpleOption
```
public net.thevpc.nuts.NutsCommandLine unregisterSpecialSimpleOption(String option)
```
  Specified by:
  
  unregisterSpecialSimpleOption in interface net.thevpc.nuts.NutsCommandLine
- getSpecialSimpleOptions
```
public String[] getSpecialSimpleOptions()
```
  Specified by:
  
  getSpecialSimpleOptions in interface net.thevpc.nuts.NutsCommandLine
- registerSpecialSimpleOption
```
public net.thevpc.nuts.NutsCommandLine registerSpecialSimpleOption(String option)
```
  Specified by:
  
  registerSpecialSimpleOption in interface net.thevpc.nuts.NutsCommandLine
- isSpecialSimpleOption
```
public boolean isSpecialSimpleOption(String option)
```
  Specified by:
  
  isSpecialSimpleOption in interface net.thevpc.nuts.NutsCommandLine
- getWordIndex
```
public int getWordIndex()
```
  Specified by:
  
  getWordIndex in interface net.thevpc.nuts.NutsCommandLine
- isExecMode
```
public boolean isExecMode()
```
  Specified by:
  
  isExecMode in interface net.thevpc.nuts.NutsCommandLine
- isAutoCompleteMode
```
public boolean isAutoCompleteMode()
```
  Specified by:
  
  isAutoCompleteMode in interface net.thevpc.nuts.NutsCommandLine
- getCommandName
```
public String getCommandName()
```
  Specified by:
  
  getCommandName in interface net.thevpc.nuts.NutsCommandLine
- setCommandName
```
public net.thevpc.nuts.NutsCommandLine setCommandName(String commandName)
```
  Specified by:
  
  setCommandName in interface net.thevpc.nuts.NutsCommandLine
- isExpandSimpleOptions
```
public boolean isExpandSimpleOptions()
```
  Specified by:
  
  isExpandSimpleOptions in interface net.thevpc.nuts.NutsCommandLine
- setExpandSimpleOptions
```
public net.thevpc.nuts.NutsCommandLine setExpandSimpleOptions(boolean expand)
```
  Specified by:
  
  setExpandSimpleOptions in interface net.thevpc.nuts.NutsCommandLine
- requireNonOption
```
public net.thevpc.nuts.NutsCommandLine requireNonOption()
```
  Specified by:
  
  requireNonOption in interface net.thevpc.nuts.NutsCommandLine
- unexpectedArgument
```
public net.thevpc.nuts.NutsCommandLine unexpectedArgument(net.thevpc.nuts.NutsString errorMessage)
```
  Specified by:
  
  unexpectedArgument in interface net.thevpc.nuts.NutsCommandLine
- unexpectedArgument
```
public net.thevpc.nuts.NutsCommandLine unexpectedArgument(net.thevpc.nuts.NutsMessage errorMessage)
```
  Specified by:
  
  unexpectedArgument in interface net.thevpc.nuts.NutsCommandLine
- unexpectedArgument
```
public net.thevpc.nuts.NutsCommandLine unexpectedArgument()
```
  Specified by:
  
  unexpectedArgument in interface net.thevpc.nuts.NutsCommandLine
- required
```
public net.thevpc.nuts.NutsCommandLine required()
```
  Specified by:
  
  required in interface net.thevpc.nuts.NutsCommandLine
- requiredOptions
```
public net.thevpc.nuts.NutsCommandLine requiredOptions(String... options)
```
  Specified by:
  
  requiredOptions in interface net.thevpc.nuts.NutsCommandLine
- requiredNonOptions
```
public net.thevpc.nuts.NutsCommandLine requiredNonOptions(String... nonOptions)
```
  Specified by:
  
  requiredNonOptions in interface net.thevpc.nuts.NutsCommandLine
- required
```
public net.thevpc.nuts.NutsCommandLine required(net.thevpc.nuts.NutsString errorMessage)
```
  Specified by:
  
  required in interface net.thevpc.nuts.NutsCommandLine
- required
```
public net.thevpc.nuts.NutsCommandLine required(net.thevpc.nuts.NutsMessage errorMessage)
```
  Specified by:
  
  required in interface net.thevpc.nuts.NutsCommandLine
- pushBack
```
public net.thevpc.nuts.NutsCommandLine pushBack(net.thevpc.nuts.NutsArgument arg)
```
  Specified by:
  
  pushBack in interface net.thevpc.nuts.NutsCommandLine
- next
```
public net.thevpc.nuts.NutsArgument next()
```
  Specified by:
  
  next in interface net.thevpc.nuts.NutsCommandLine
- next
```
public net.thevpc.nuts.NutsArgument next(net.thevpc.nuts.NutsArgumentName name)
```
  Specified by:
  
  next in interface net.thevpc.nuts.NutsCommandLine
- peek
```
public net.thevpc.nuts.NutsArgument peek()
```
  Specified by:
  
  peek in interface net.thevpc.nuts.NutsCommandLine
- hasNext
```
public boolean hasNext()
```
  Specified by:
  
  hasNext in interface net.thevpc.nuts.NutsCommandLine
- nextBoolean
```
public net.thevpc.nuts.NutsArgument nextBoolean(String... names)
```
  Specified by:
  
  nextBoolean in interface net.thevpc.nuts.NutsCommandLine
- nextString
```
public net.thevpc.nuts.NutsArgument nextString(String... names)
```
  Specified by:
  
  nextString in interface net.thevpc.nuts.NutsCommandLine
- next
```
public net.thevpc.nuts.NutsArgument next(String... names)
```
  Specified by:
  
  next in interface net.thevpc.nuts.NutsCommandLine
- next
```
public net.thevpc.nuts.NutsArgument next(net.thevpc.nuts.NutsArgumentType expectValue,
                                         String... names)
```
  Specified by:
  
  next in interface net.thevpc.nuts.NutsCommandLine
- nextRequiredNonOption
```
public net.thevpc.nuts.NutsArgument nextRequiredNonOption(net.thevpc.nuts.NutsArgumentName name)
```
  Specified by:
  
  nextRequiredNonOption in interface net.thevpc.nuts.NutsCommandLine
- nextNonOption
```
public net.thevpc.nuts.NutsArgument nextNonOption()
```
  Specified by:
  
  nextNonOption in interface net.thevpc.nuts.NutsCommandLine
- nextNonOption
```
public net.thevpc.nuts.NutsArgument nextNonOption(net.thevpc.nuts.NutsArgumentName name)
```
  Specified by:
  
  nextNonOption in interface net.thevpc.nuts.NutsCommandLine
- skipAll
```
public int skipAll()
```
  Specified by:
  
  skipAll in interface net.thevpc.nuts.NutsCommandLine
- skip
```
public int skip()
```
  Specified by:
  
  skip in interface net.thevpc.nuts.NutsCommandLine
- skip
```
public int skip(int count)
```
  Specified by:
  
  skip in interface net.thevpc.nuts.NutsCommandLine
- accept
```
public boolean accept(String... values)
```
  Specified by:
  
  accept in interface net.thevpc.nuts.NutsCommandLine
- accept
```
public boolean accept(int index,
                      String... values)
```
  Specified by:
  
  accept in interface net.thevpc.nuts.NutsCommandLine
- find
```
public net.thevpc.nuts.NutsArgument find(String name)
```
  Specified by:
  
  find in interface net.thevpc.nuts.NutsCommandLine
- get
```
public net.thevpc.nuts.NutsArgument get(int index)
```
  Specified by:
  
  get in interface net.thevpc.nuts.NutsCommandLine
- contains
```
public boolean contains(String name)
```
  Specified by:
  
  contains in interface net.thevpc.nuts.NutsCommandLine
- indexOf
```
public int indexOf(String name)
```
  Specified by:
  
  indexOf in interface net.thevpc.nuts.NutsCommandLine
- length
```
public int length()
```
  Specified by:
  
  length in interface net.thevpc.nuts.NutsCommandLine
- isEmpty
```
public boolean isEmpty()
```
  Specified by:
  
  isEmpty in interface net.thevpc.nuts.NutsCommandLine
- toStringArray
```
public String[] toStringArray()
```
  Specified by:
  
  toStringArray in interface net.thevpc.nuts.NutsCommandLine
- toArgumentArray
```
public net.thevpc.nuts.NutsArgument[] toArgumentArray()
```
  Specified by:
  
  toArgumentArray in interface net.thevpc.nuts.NutsCommandLine
- isOption
```
public boolean isOption(int index)
```
  Specified by:
  
  isOption in interface net.thevpc.nuts.NutsCommandLine
- isNonOption
```
public boolean isNonOption(int index)
```
  Specified by:
  
  isNonOption in interface net.thevpc.nuts.NutsCommandLine
- parseLine
```
public net.thevpc.nuts.NutsCommandLine parseLine(String commandLine)
```
  Specified by:
  
  parseLine in interface net.thevpc.nuts.NutsCommandLine
- setArguments
```
public net.thevpc.nuts.NutsCommandLine setArguments(List<String> arguments)
```
  Specified by:
  
  setArguments in interface net.thevpc.nuts.NutsCommandLine
- setArguments
```
public net.thevpc.nuts.NutsCommandLine setArguments(String[] arguments)
```
  Specified by:
  
  setArguments in interface net.thevpc.nuts.NutsCommandLine
- throwError
```
public void throwError(net.thevpc.nuts.NutsMessage message)
```
  Specified by:
  
  throwError in interface net.thevpc.nuts.NutsCommandLine
- throwError
```
public void throwError(net.thevpc.nuts.NutsString message)
```
  Specified by:
  
  throwError in interface net.thevpc.nuts.NutsCommandLine
- formatter
```
public net.thevpc.nuts.NutsCommandLineFormat formatter()
```
  Specified by:
  
  formatter in interface net.thevpc.nuts.NutsCommandLine
  
  Specified by:
  
  formatter in interface net.thevpc.nuts.NutsFormattable
- next
```
public net.thevpc.nuts.NutsArgument next(net.thevpc.nuts.NutsArgumentName name,
                                         boolean forceNonOption,
                                         boolean error)
```
- next
```
public net.thevpc.nuts.NutsArgument next(boolean required,
                                         boolean expandSimpleOptions)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- copy
```
public net.thevpc.nuts.NutsCommandLine copy()
```
- iterator
```
public Iterator<net.thevpc.nuts.NutsArgument> iterator()
```
  Specified by:
  
  iterator in interface Iterable<net.thevpc.nuts.NutsArgument>

Class DefaultNutsCommandLine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.thevpc.nuts.NutsCommandLine

Methods inherited from interface java.lang.Iterable

Methods inherited from interface net.thevpc.nuts.NutsFormattable

Field Detail

args

lookahead

expandSimpleOptions

specialSimpleOptions

commandName

session

Constructor Detail

DefaultNutsCommandLine

DefaultNutsCommandLine

DefaultNutsCommandLine

DefaultNutsCommandLine

DefaultNutsCommandLine

DefaultNutsCommandLine

Method Detail

getSession

getAutoComplete

setAutoComplete

unregisterSpecialSimpleOption

getSpecialSimpleOptions

registerSpecialSimpleOption

isSpecialSimpleOption

getWordIndex

isExecMode

isAutoCompleteMode

getCommandName

setCommandName

isExpandSimpleOptions

setExpandSimpleOptions

requireNonOption

unexpectedArgument

unexpectedArgument

unexpectedArgument

required

requiredOptions

requiredNonOptions

required

required

pushBack

next

next

peek

hasNext

nextBoolean

nextString

next

next

nextRequiredNonOption

nextNonOption

nextNonOption

skipAll

skip

skip

accept

accept

find

get

contains

indexOf

length

isEmpty

toStringArray

toArgumentArray

isOption

isNonOption

parseLine

setArguments

setArguments

throwError

throwError

formatter

next