CommandArgIterator (Ignite 8.9.30)

java.lang.Object
- org.apache.ignite.internal.commandline.CommandArgIterator

public class CommandArgIterator
extends Object

Iterator over command arguments.

Constructor Summary

Constructors
Constructor and Description

CommandArgIterator(Iterator<String> argsIt, Set<String> commonArgumentsAndHighLevelCommandSet)

Constructors
Constructor and Description
`CommandArgIterator(Iterator<String> argsIt, Set<String> commonArgumentsAndHighLevelCommandSet)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`hasNextArg()`
`boolean`	`hasNextSubArg()`
`static boolean`	`isCommandOrOption(String raw)` Check if raw arg is command or option.
`String`	`nextArg(String err)` Extract next argument.
`@NotNull String`	`nextArgValue(String argName)` Extract next non command argument value
`byte`	`nextByteArg(String argName)`
`@NotNull Set<String>`	`nextCacheGroupsSet(String cachesGroupsArgName)`
`@NotNull Set<String>`	`nextCachesSet(String cachesArgName)`
`@NotNull Set<String>`	`nextCachesSet0(String cachesArgName, boolean groups)` Parses next value as set of caches names
`<E extends Enum<E> & CommandArg> E`	`nextCmdArgOrFail(Class<E> type, String argName)` Parse next argument as specified `CommandArg` Enum value
`<E extends Enum<E>> E`	`nextEnumOrFail(Class<E> type, String argName)` Parse next argument as specified Enum value
`int`	`nextIntArg(String argName)`
`long`	`nextLongArg(String argName)`
`Set<String>`	`nextNonEmptyStringSet(String expectedValDescr)`
`int`	`nextNonNegativeIntArg(String argName)`
`long`	`nextNonNegativeLongArg(String argName)`
`Set<String>`	`nextStringSet(String expectedValDescr)`
`Set<String>`	`nextStringSet0(String expectedValDescr, boolean requireNonEmpty)`
`@NotNull String`	`nextToken(String errOnNoData, Function<String,String> unexpectedDataErrMapper)` Extract next Non Auto Confirmation argument
`UUID`	`nextUuidArg(String argName)`
`@NotNull Set<String>`	`parseStringSet(String string)`
`String`	`peekNextArg()` Returns the next argument in the iteration, without advancing the iteration.

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

- Constructor Detail
  - CommandArgIterator
```
public CommandArgIterator(Iterator<String> argsIt,
                          Set<String> commonArgumentsAndHighLevelCommandSet)
```
    Parameters:
    
    argsIt - Raw argument iterator.
    
    commonArgumentsAndHighLevelCommandSet - All known subcommands.
- Method Detail
  - hasNextArg
```
public boolean hasNextArg()
```
    Returns:
    
    Returns true if the iteration has more elements.
  - hasNextSubArg
```
public boolean hasNextSubArg()
```
    Returns:
    
    true if there's next argument for subcommand.
  - nextArg
```
public String nextArg(String err)
```
    Extract next argument.
    
    Parameters:
    
    err - Error message.
    
    Returns:
    
    Next argument value.
  - nextArgValue
```
@NotNull
public @NotNull String nextArgValue(String argName)
```
    Extract next non command argument value
    
    Parameters:
    
    argName - Name of argument, which values we're trying to extract.
    
    Returns:
    
    Next argument value.
  - nextToken
```
@NotNull
public @NotNull String nextToken(String errOnNoData,
                                          Function<String,String> unexpectedDataErrMapper)
```
    Extract next Non Auto Confirmation argument
    
    Parameters:
    
    errOnNoData - Message for error when not enough data to parse.
    
    unexpectedDataErrMapper - Mapper that must provide error message based on unexpected input value.
    
    Returns:
    
    Next argument value.
  - nextCmdArgOrFail
```
@NotNull
public <E extends Enum<E> & CommandArg> E nextCmdArgOrFail(Class<E> type,
                                                                    String argName)
```
    Parse next argument as specified CommandArg Enum value
    
    Parameters:
    
    type - CommandArg Enum class.
    
    argName - Name of argument, which values we're trying to convert to Enum.
    
    Returns:
    
    Enum value
    
    Throws:
    
    IllegalArgumentException - if no suitable Enum value found
  - nextEnumOrFail
```
@NotNull
public <E extends Enum<E>> E nextEnumOrFail(Class<E> type,
                                                     String argName)
```
    Parse next argument as specified Enum value
    
    Parameters:
    
    type - Enum class.
    
    argName - Name of argument, which values we're trying to convert to Enum.
    
    Returns:
    
    Enum value
    
    Throws:
    
    IllegalArgumentException - if no suitable Enum value found
  - peekNextArg
```
public String peekNextArg()
```
    Returns the next argument in the iteration, without advancing the iteration.
    
    Returns:
    
    Next argument value or null if no next argument.
  - nextNonNegativeLongArg
```
public long nextNonNegativeLongArg(String argName)
```
    Returns:
    
    Numeric value.
  - nextNonNegativeIntArg
```
public int nextNonNegativeIntArg(String argName)
```
    Returns:
    
    Numeric value.
  - nextLongArg
```
public long nextLongArg(String argName)
```
    Returns:
    
    Numeric value.
  - nextIntArg
```
public int nextIntArg(String argName)
```
    Returns:
    
    Numeric value.
  - nextByteArg
```
public byte nextByteArg(String argName)
```
    Returns:
    
    Numeric value.
  - nextStringSet
```
public Set<String> nextStringSet(String expectedValDescr)
```
    Parameters:
    
    expectedValDescr - description of expected data.
    
    Returns:
    
    Set of string parsed from next argument or Collections.emptySet() if next argument is an option
  - nextNonEmptyStringSet
```
public Set<String> nextNonEmptyStringSet(String expectedValDescr)
```
    See Also:
    
    nextStringSet0(String, boolean)
  - nextStringSet0
```
public Set<String> nextStringSet0(String expectedValDescr,
                                  boolean requireNonEmpty)
```
    Parameters:
    
    expectedValDescr - description of expected data.
    
    requireNonEmpty - True if exception must be thrown on empty set
    
    Returns:
    
    Set of string parsed from next argument
  - parseStringSet
```
@NotNull
public @NotNull Set<String> parseStringSet(String string)
```
    Parameters:
    
    string - To scan on for string set.
    
    Returns:
    
    Set of string parsed from string param.
  - nextCachesSet0
```
@NotNull
public @NotNull Set<String> nextCachesSet0(String cachesArgName,
                                                    boolean groups)
```
    Parses next value as set of caches names
    
    Parameters:
    
    cachesArgName - Name of argument
    
    groups - True if we're parsing cache group names
    
    Returns:
    
    Set of cache (group) names
  - nextCachesSet
```
@NotNull
public @NotNull Set<String> nextCachesSet(String cachesArgName)
```
    See Also:
    
    nextCachesSet0(String, boolean)
  - nextCacheGroupsSet
```
@NotNull
public @NotNull Set<String> nextCacheGroupsSet(String cachesGroupsArgName)
```
    See Also:
    
    nextCachesSet0(String, boolean)
  - nextUuidArg
```
public UUID nextUuidArg(String argName)
```
    Parameters:
    
    argName - Name of the argument to be parsed.
    
    Returns:
    
    UUID value.
  - isCommandOrOption
```
public static boolean isCommandOrOption(String raw)
```
    Check if raw arg is command or option.
    
    Returns:
    
    true If raw arg is command, otherwise false.

Class CommandArgIterator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommandArgIterator

Method Detail

hasNextArg

hasNextSubArg

nextArg

nextArgValue

nextToken

nextCmdArgOrFail

nextEnumOrFail

peekNextArg

nextNonNegativeLongArg

nextNonNegativeIntArg

nextLongArg

nextIntArg

nextByteArg

nextStringSet

nextNonEmptyStringSet

nextStringSet0

parseStringSet

nextCachesSet0

nextCachesSet

nextCacheGroupsSet

nextUuidArg

isCommandOrOption