revxrsal.commands.orphan

Class Orphans

java.lang.Object

revxrsal.commands.orphan.Orphans

public final class Orphans
extends java.lang.Object

Represents the entrypoint to creation of OrphanCommands.

The method path(String...) has the same exact behavior as Command annotations.

 
 - @Command("foo bar") -> Orphans.path("foo bar")
 - @Command("foo", "bar") -> Orphans.path("foo", "bar")
 - @Command("foo bar", "buzz buff") -> Orphans.path("foo bar", "buzz buff")
 
 

Registering OrphanCommands directly into a Lamp#register(Object) will throw an exception. Orphan commands should be wrapped using this class as follows:

 
 lamp.register(Orphans.path("foo").handler(new Foo()));
 
 

See Also:

OrphanCommand

Constructor Summary

Constructors

Constructor and Description
Orphans(java.util.List<java.lang.String> paths)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
OrphanRegistry	handler(OrphanCommand handler) Sets the handler of this orphan command.
int	hashCode()
static Orphans	path(java.lang.String... paths) Starts the registration of an orphan command.
java.util.List<java.lang.String>	paths()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Orphans

public Orphans(java.util.List<java.lang.String> paths)

Method Detail

path

public static Orphans path(@NotNull
                           java.lang.String... paths)

Starts the registration of an orphan command. The input for this method has exactly the same behavior as Command.

- @Command("foo", "bar") -> Orphans.path("foo", "bar")

Parameters:

paths - The command paths. These accept spaces for commands with subcategories.

Returns:

A builder Orphans. You must call handler(OrphanCommand) after.

handler

public OrphanRegistry handler(OrphanCommand handler)

Sets the handler of this orphan command. This can be any class, however it must implement OrphanCommand.

Parameters:

handler - The command class logic.

Returns:

An OrphanRegistry that can be passed to Lamp#register(Object) to be registered.

paths

public java.util.List<java.lang.String> paths()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object