@Arg Optional

To define an optional argument in a command, you can choose from two different ways:

1. Using the @Arg annotation with the Optional<T> type.
2. Using the @OptionalArg annotation with a check for null.

Example

Add the Optional<T> type to the parameter to define an optional argument:

1. @Arg Optional<T>

@Command(name = "day")
public class DayCommand {
    @Execute
    void day(@Context Player sender, @Arg Optional<World> world) {
        World selectedWorld = world.orElse(sender.getWorld());

        selectedWorld.setTime(1000);
    }
}

2. @OptionalArg (null)

@Command(name = "day")
public class DayCommand {
    @Execute
    void day(@Context Player sender, @OptionalArg World world) {
        if (world == null) {
            world = sender.getWorld();
        }

        world.setTime(1000);
    }
}

In this example we handle the optional argument World, when the argument is not provided, we set the World to the sender's world:

1. @Arg Optional<T>

World selectedWorld = world.orElse(sender.getWorld());

2. @OptionalArg (null)

if (world == null) {
    world = sender.getWorld();
}

Martin Sulikowski Norbert Dejlich

Last edited about 2 months ago

View full history

fdf64fc-GH-28 Refactor docs. (#28)