Interface Console

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

JLine3Console

public interface Console
extends AutoCloseable

Method Summary

Modifier and Type	Method	Description
void	addCommandHandler(@NonNull UUID uniqueId, @NonNull ConsoleInputHandler handler)
void	addTabCompleteHandler(@NonNull UUID uniqueId, @NonNull ConsoleTabCompleteHandler handler)
boolean	animationRunning()
void	clearScreen()
@Unmodifiable @NonNull Collection<String>	commandHistory()
void	commandHistory(@Nullable Collection<String> history)
void	commandInputValue(@NonNull String commandInputValue)
void	disableAllCommandHandlers()
void	disableAllHandlers()
void	disableAllTabCompleteHandlers()
int	displayLength(@NonNull String string)
void	emptyPrompt()
void	enableAllCommandHandlers()
void	enableAllHandlers()
void	enableAllTabCompleteHandlers()
@NonNull Console	forceWriteLine(@NonNull String text)
boolean	printingEnabled()
@NonNull String	prompt()
void	prompt(@NonNull String prompt)
@NonNull CompletableFuture<String>	readLine()
void	removeCommandHandler(@NonNull UUID uniqueId)
void	removePrompt()
void	removeTabCompleteHandler(@NonNull UUID uniqueId)
void	resetPrompt()
@UnmodifiableView @NonNull Collection<AbstractConsoleAnimation>	runningAnimations()
void	startAnimation(@NonNull AbstractConsoleAnimation animation)
void	togglePrinting(boolean enabled)
boolean	usingMatchingHistoryComplete()
void	usingMatchingHistoryComplete(boolean matchingHistoryComplete)
int	width()
@NonNull Console	writeLine(@NonNull String text)
@NonNull Console	writeRaw(@NonNull Supplier<String> rawText)

Methods inherited from interface AutoCloseable

close

Method Details

runningAnimations

@NonNull
@UnmodifiableView @NonNull Collection<AbstractConsoleAnimation> runningAnimations()

startAnimation

void startAnimation(@NonNull
 @NonNull AbstractConsoleAnimation animation)

animationRunning

boolean animationRunning()

togglePrinting

void togglePrinting(boolean enabled)

printingEnabled

boolean printingEnabled()

commandHistory

@NonNull
@Unmodifiable @NonNull Collection<String> commandHistory()

commandHistory

void commandHistory(@Nullable
 @Nullable Collection<String> history)

commandInputValue

void commandInputValue(@NonNull
 @NonNull String commandInputValue)

readLine

@NonNull
@NonNull CompletableFuture<String> readLine()

enableAllHandlers

void enableAllHandlers()

disableAllHandlers

void disableAllHandlers()

enableAllCommandHandlers

void enableAllCommandHandlers()

disableAllCommandHandlers

void disableAllCommandHandlers()

enableAllTabCompleteHandlers

void enableAllTabCompleteHandlers()

disableAllTabCompleteHandlers

void disableAllTabCompleteHandlers()

addCommandHandler

void addCommandHandler(@NonNull
 @NonNull UUID uniqueId,
 @NonNull
 @NonNull ConsoleInputHandler handler)

removeCommandHandler

void removeCommandHandler(@NonNull
 @NonNull UUID uniqueId)

addTabCompleteHandler

void addTabCompleteHandler(@NonNull
 @NonNull UUID uniqueId,
 @NonNull
 @NonNull ConsoleTabCompleteHandler handler)

removeTabCompleteHandler

void removeTabCompleteHandler(@NonNull
 @NonNull UUID uniqueId)

writeRaw

@NonNull
@NonNull Console writeRaw(@NonNull
 @NonNull Supplier<String> rawText)

forceWriteLine

@NonNull
@NonNull Console forceWriteLine(@NonNull
 @NonNull String text)

writeLine

@NonNull
@NonNull Console writeLine(@NonNull
 @NonNull String text)

usingMatchingHistoryComplete

boolean usingMatchingHistoryComplete()

usingMatchingHistoryComplete

void usingMatchingHistoryComplete(boolean matchingHistoryComplete)

prompt

@NonNull
@NonNull String prompt()

prompt

void prompt(@NonNull
 @NonNull String prompt)

resetPrompt

void resetPrompt()

removePrompt

void removePrompt()

emptyPrompt

void emptyPrompt()

clearScreen

void clearScreen()

width

int width()

displayLength

int displayLength(@NonNull
 @NonNull String string)