net.lenni0451.commandlib

Class Completion

java.lang.Object

net.lenni0451.commandlib.Completion

public class Completion
extends java.lang.Object

A completion for the user input suggesting what the user might want to type.

Constructor Summary

Constructors

Constructor and Description
Completion(int start, java.lang.String completion)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getCompletion()
int	getStart() The start of a completion is the index in the input where the completion starts.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Completion

public Completion(int start,
                  java.lang.String completion)

Method Detail

getStart

public int getStart()

The start of a completion is the index in the input where the completion starts.
To fill the completion into the input you could do something like this:

// The input the user types
String input = "test inp";
// Get the completion from somewhere
Completion completion = new Completion(5, "input");
input = input.substring(0, completion.getStart()) + completion.getCompletion();

In this example the input would be "test input" after the completion was applied.

Returns:

The start of the completion

getCompletion

public java.lang.String getCompletion()

Returns:

The completion itself

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object