CharArgument (cloud-core 1.1.0 API)

java.lang.Object
- cloud.commandframework.arguments.CommandArgument<C,java.lang.Character>
- - cloud.commandframework.arguments.standard.CharArgument<C>

All Implemented Interfaces:: java.lang.Comparable<CommandArgument<?,?>>

public final class CharArgument<C>
extends CommandArgument<C,java.lang.Character>

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`CharArgument.Builder<C>`
`static class`	`CharArgument.CharacterParser<C>`
`static class`	`CharArgument.CharParseException`	Char parse exception

Method Summary

Modifier and Type	Method	Description
`static <C> @NonNull CharArgument.Builder<C>`	`newBuilder(@NonNull java.lang.String name)`	Create a new builder
`static <C> @NonNull CommandArgument<C,java.lang.Character>`	`of(@NonNull java.lang.String name)`	Create a new required command argument
`static <C> @NonNull CommandArgument<C,java.lang.Character>`	`optional(@NonNull java.lang.String name)`	Create a new optional command argument
`static <C> @NonNull CommandArgument<C,java.lang.Character>`	`optional(@NonNull java.lang.String name, @NonNull java.lang.String defaultNum)`	Create a new required command argument with a default value

Methods inherited from class cloud.commandframework.arguments.CommandArgument
addPreprocessor, compareTo, copy, equals, getDefaultValue, getName, getOwningCommand, getParser, getSuggestionsProvider, getValueType, hasDefaultValue, hashCode, isArgumentRegistered, isRequired, ofType, ofType, preprocess, setArgumentRegistered, setOwningCommand, toString

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

- Method Detail
  - newBuilder
```
public static <C> @NonNull CharArgument.Builder<C> newBuilder(@NonNull java.lang.String name)
```
    Create a new builder
    
    Type Parameters:
    
    C - Command sender type
    
    Parameters:
    
    name - Name of the argument
    
    Returns:
    
    Created builder
  - of
```
public static <C> @NonNull CommandArgument<C,java.lang.Character> of(@NonNull java.lang.String name)
```
    Create a new required command argument
    
    Type Parameters:
    
    C - Command sender type
    
    Parameters:
    
    name - Argument name
    
    Returns:
    
    Created argument
  - optional
```
public static <C> @NonNull CommandArgument<C,java.lang.Character> optional(@NonNull java.lang.String name)
```
    Create a new optional command argument
    
    Type Parameters:
    
    C - Command sender type
    
    Parameters:
    
    name - Argument name
    
    Returns:
    
    Created argument
  - optional
```
public static <C> @NonNull CommandArgument<C,java.lang.Character> optional(@NonNull java.lang.String name,
                                                                                 @NonNull java.lang.String defaultNum)
```
    Create a new required command argument with a default value
    
    Type Parameters:
    
    C - Command sender type
    
    Parameters:
    
    name - Argument name
    
    defaultNum - Default num
    
    Returns:
    
    Created argument