StringArgument.Builder (cloud-core 1.0.0 API)

java.lang.Object
- cloud.commandframework.arguments.CommandArgument.Builder<C,java.lang.String>
- - cloud.commandframework.arguments.standard.StringArgument.Builder<C>

Enclosing class:: StringArgument<C>

public static final class StringArgument.Builder<C>
extends CommandArgument.Builder<C,java.lang.String>

Constructor Summary

Constructors
Modifier Constructor Description

protected Builder(@NonNull java.lang.String name)

Method Summary

Modifier and Type	Method	Description
`@NonNull StringArgument<C>`	`build()`	Builder a new string argument
`@NonNull StringArgument.Builder<C>`	`greedy()`	Set the string mode to greedy
`@NonNull StringArgument.Builder<C>`	`quoted()`	Set the string mode to greedy
`@NonNull StringArgument.Builder<C>`	`single()`	Set the string mode to single
`@NonNull StringArgument.Builder<C>`	`withSuggestionsProvider(@NonNull java.util.function.BiFunction<@NonNull CommandContext<C>,@NonNull java.lang.String,@NonNull java.util.List<@NonNull java.lang.String>> suggestionsProvider)`	Set the suggestions provider

Methods inherited from class cloud.commandframework.arguments.CommandArgument.Builder
asOptional, asOptionalWithDefault, asRequired, getDefaultValue, getName, getParser, getSuggestionsProvider, isRequired, manager, withParser

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

- Constructor Detail
  - Builder
```
protected Builder(@NonNull java.lang.String name)
```
- Method Detail
  - greedy
```
public @NonNull StringArgument.Builder<C> greedy()
```
    Set the string mode to greedy
    
    Returns:
    
    Builder instance
  - single
```
public @NonNull StringArgument.Builder<C> single()
```
    Set the string mode to single
    
    Returns:
    
    Builder instance
  - quoted
```
public @NonNull StringArgument.Builder<C> quoted()
```
    Set the string mode to greedy
    
    Returns:
    
    Builder instance
  - withSuggestionsProvider
```
public @NonNull StringArgument.Builder<C> withSuggestionsProvider(@NonNull java.util.function.BiFunction<@NonNull CommandContext<C>,@NonNull java.lang.String,@NonNull java.util.List<@NonNull java.lang.String>> suggestionsProvider)
```
    Set the suggestions provider
    
    Overrides:
    
    withSuggestionsProvider in class CommandArgument.Builder<C,java.lang.String>
    
    Parameters:
    
    suggestionsProvider - Suggestions provider
    
    Returns:
    
    Builder instance
  - build
```
public @NonNull StringArgument<C> build()
```
    Builder a new string argument
    
    Overrides:
    
    build in class CommandArgument.Builder<C,java.lang.String>
    
    Returns:
    
    Constructed argument