NBootCmdLine (Nuts Community Core Bootstrap 0.8.5 API)

java.lang.Object
- net.thevpc.nuts.boot.reserved.cmdline.NBootCmdLine

public class NBootCmdLine
extends Object

 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`	`expandSimpleOptions`
`protected List<NBootArg>`	`lookahead`
`protected Set<String>`	`specialSimpleOptions`

Constructor Summary

Constructors
Constructor and Description

NBootCmdLine()

NBootCmdLine(List<String> args)

NBootCmdLine(String[] args)

Constructors
Constructor and Description
`NBootCmdLine()`
`NBootCmdLine(List<String> args)`
`NBootCmdLine(String[] args)`

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)`
`NBootCmdLine`	`add(String argument)`
`NBootCmdLine`	`addAll(List<String> arguments)`
`NBootCmdLine`	`append(String... args)`
`boolean`	`contains(String name)`
`NBootCmdLine`	`copy()`
`NBootArg`	`find(String name)`
`NBootArg`	`get(int index)`
`String`	`getCommandName()`
`String[]`	`getSpecialSimpleOptions()`
`int`	`getWordIndex()`
`boolean`	`hasNext()`
`boolean`	`hasNextNonOption()`
`boolean`	`hasNextOption()`
`int`	`indexOf(String name)`
`boolean`	`isBlank()`
`boolean`	`isEmpty()`
`boolean`	`isExpandSimpleOptions()`
`boolean`	`isNextNonOption()`
`boolean`	`isNextOption()`
`boolean`	`isNonOption(int index)`
`boolean`	`isOption(int index)`
`boolean`	`isSpecialSimpleOption(String option)`
`Iterator<NBootArg>`	`iterator()`
`int`	`length()`
`NBootArg`	`next()`
`NBootArg`	`next(boolean expandSimpleOptions)`
`NBootArg`	`next(String... names)`
`NBootArg`	`next(String name, boolean forceNonOption)`
`NBootArg`	`nextEntry()`
`NBootArg`	`nextEntry(String... names)`
`NBootArg`	`nextFlag()`
`NBootArg`	`nextFlag(String... names)`
`NBootArg`	`nextNonOption()`
`NBootArg`	`nextNonOption(String name)`
`NBootArg`	`nextOption(String option)`
`String`	`nextString()`
`static String[]`	`parseDefault(String commandLineString)`
`NBootArg`	`peek()`
`NBootCmdLine`	`pushBack(NBootArg... args)`
`NBootCmdLine`	`pushBack(NBootArg arg)`
`NBootCmdLine`	`pushBack(String... args)`
`NBootCmdLine`	`registerSpecialSimpleOption(String option)`
`NBootCmdLine`	`setArguments(List<String> arguments)`
`NBootCmdLine`	`setArguments(String[] arguments)`
`NBootCmdLine`	`setCommandName(String commandName)`
`NBootCmdLine`	`setExpandSimpleOptions(boolean expand)`
`int`	`skip()`
`int`	`skip(int count)`
`int`	`skipAll()`
`void`	`throwError(NBootMsg message)`
`NBootCmdLine`	`throwMissingArgument()`
`NBootCmdLine`	`throwMissingArgument(NBootMsg errorMessage)`
`NBootCmdLine`	`throwMissingArgument(String argumentName)`
`NBootCmdLine`	`throwUnexpectedArgument()`
`NBootCmdLine`	`throwUnexpectedArgument(NBootMsg errorMessage)`
`NBootArg[]`	`toArgumentArray()`
`String`	`toString()`
`String[]`	`toStringArray()`
`List<String>`	`toStringList()`
`NBootCmdLine`	`unregisterSpecialSimpleOption(String option)`

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

Field Detail

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

lookahead
```
protected List<NBootArg> lookahead
```

expandSimpleOptions
```
protected boolean expandSimpleOptions
```

specialSimpleOptions

protected Set<String> specialSimpleOptions

commandName
```
protected String commandName
```

Constructor Detail

NBootCmdLine
```
public NBootCmdLine()
```

NBootCmdLine
```
public NBootCmdLine(String[] args)
```

NBootCmdLine

public NBootCmdLine(List<String> args)

Method Detail

unregisterSpecialSimpleOption

public NBootCmdLine unregisterSpecialSimpleOption(String option)

getSpecialSimpleOptions

public String[] getSpecialSimpleOptions()

registerSpecialSimpleOption

public NBootCmdLine registerSpecialSimpleOption(String option)

isSpecialSimpleOption

public boolean isSpecialSimpleOption(String option)

getWordIndex
```
public int getWordIndex()
```

getCommandName
```
public String getCommandName()
```

setCommandName

public NBootCmdLine setCommandName(String commandName)

isExpandSimpleOptions

public boolean isExpandSimpleOptions()

setExpandSimpleOptions

public NBootCmdLine setExpandSimpleOptions(boolean expand)

throwUnexpectedArgument

public NBootCmdLine throwUnexpectedArgument(NBootMsg errorMessage)

throwMissingArgument

public NBootCmdLine throwMissingArgument()

throwMissingArgument

public NBootCmdLine throwMissingArgument(String argumentName)

throwMissingArgument

public NBootCmdLine throwMissingArgument(NBootMsg errorMessage)

throwUnexpectedArgument

public NBootCmdLine throwUnexpectedArgument()

pushBack

public NBootCmdLine pushBack(NBootArg arg)

next
```
public NBootArg next()
```

nextString
```
public String nextString()
```

nextOption

public NBootArg nextOption(String option)

isNextOption
```
public boolean isNextOption()
```

isNextNonOption
```
public boolean isNextNonOption()
```

peek
```
public NBootArg peek()
```

hasNext
```
public boolean hasNext()
```

hasNextOption
```
public boolean hasNextOption()
```

hasNextNonOption
```
public boolean hasNextNonOption()
```

nextFlag

public NBootArg nextFlag(String... names)

public NBootArg nextEntry(String... names)

nextEntry
```
public NBootArg nextEntry()
```

nextFlag
```
public NBootArg nextFlag()
```

public NBootArg next(String... names)

nextNonOption

public NBootArg nextNonOption(String name)

nextNonOption
```
public NBootArg nextNonOption()
```

skipAll
```
public int skipAll()
```

skip
```
public int skip()
```

skip
```
public int skip(int count)
```

accept

public boolean accept(String... values)

accept

public boolean accept(int index,
                      String... values)

find
```
public NBootArg find(String name)
```

get
```
public NBootArg get(int index)
```

contains
```
public boolean contains(String name)
```

indexOf
```
public int indexOf(String name)
```

length
```
public int length()
```

isEmpty
```
public boolean isEmpty()
```

toStringArray
```
public String[] toStringArray()
```

toStringList
```
public List<String> toStringList()
```

toArgumentArray
```
public NBootArg[] toArgumentArray()
```

isOption
```
public boolean isOption(int index)
```

isNonOption

public boolean isNonOption(int index)

setArguments

public NBootCmdLine setArguments(List<String> arguments)

setArguments

public NBootCmdLine setArguments(String[] arguments)

throwError

public void throwError(NBootMsg message)

public NBootArg next(String name,
                     boolean forceNonOption)

public NBootArg next(boolean expandSimpleOptions)

toString
```
public String toString()
```
Overrides:

toString in class Object

copy
```
public NBootCmdLine copy()
```

iterator
```
public Iterator<NBootArg> iterator()
```

parseDefault

public static String[] parseDefault(String commandLineString)

add

public NBootCmdLine add(String argument)

addAll

public NBootCmdLine addAll(List<String> arguments)

isBlank
```
public boolean isBlank()
```

pushBack

public NBootCmdLine pushBack(NBootArg... args)

pushBack

public NBootCmdLine pushBack(String... args)

append

public NBootCmdLine append(String... args)

Class NBootCmdLine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

args

lookahead

expandSimpleOptions

specialSimpleOptions

commandName

Constructor Detail

NBootCmdLine

NBootCmdLine

NBootCmdLine

Method Detail

unregisterSpecialSimpleOption

getSpecialSimpleOptions

registerSpecialSimpleOption

isSpecialSimpleOption

getWordIndex

getCommandName

setCommandName

isExpandSimpleOptions

setExpandSimpleOptions

throwUnexpectedArgument

throwMissingArgument

throwMissingArgument

throwMissingArgument

throwUnexpectedArgument

pushBack

next

nextString

nextOption

isNextOption

isNextNonOption

peek

hasNext

hasNextOption

hasNextNonOption

nextFlag

nextEntry

nextEntry

nextFlag

next

nextNonOption

nextNonOption

skipAll

skip

skip

accept

accept

find

get

contains

indexOf

length

isEmpty

toStringArray

toStringList

toArgumentArray

isOption

isNonOption

setArguments

setArguments

throwError

next

next

toString

copy

iterator

parseDefault

add

addAll

isBlank

pushBack

pushBack

append