nova.core.util

Interface ProgressBar

All Known Implementing Classes:

AbstractProgressBar, ProgressBar.NullProgressBar

public interface ProgressBar

A progress bar used to show mod loading. The default implementation does nothing. It is up to wrappers to implement functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProgressBar.NullProgressBar A progress bar implementation that does nothing.

Method Summary

Modifier and Type	Method and Description
void	finish() Finish the progress bar.
boolean	isFinished() Check if the progress bar has been finished.
default void	step(java.lang.Class<?> clazz) Advance one step.
default void	step(java.lang.Class<?> clazz, java.lang.String message) Advance one step.
void	step(java.lang.String message) Advance one step.
default void	step(java.lang.String message, java.lang.Class<?> clazz) Advance one step.
static java.lang.String	toStringMod(java.lang.Class<?> clazz)

Method Detail

step

void step(java.lang.String message)

Advance one step.

Parameters:

message - The message to show for the current step.

Throws:

java.lang.IllegalStateException - If finish() has been called.

finish

void finish()

Finish the progress bar. Calling this method a second time does nothing.

isFinished

boolean isFinished()

Check if the progress bar has been finished.

Returns:

If the progress bar has finished.

step

default void step(java.lang.Class<?> clazz)

Advance one step. The default implementation is the same as calling: ProgressBar.step(state + ": " + clazz)

Parameters:

clazz - The mod class

Throws:

java.lang.IllegalStateException - If finish() has been called.

step

default void step(java.lang.String message,
                  java.lang.Class<?> clazz)

Advance one step. The default implementation is the same as calling: ProgressBar.step(message + ": " + clazz)

Parameters:

message - The message to display before clazz

clazz - The mod class

Throws:

java.lang.IllegalStateException - If finish() has been called.

step

default void step(java.lang.Class<?> clazz,
                  java.lang.String message)

Advance one step. The default implementation is the same as calling: ProgressBar.step(clazz + ": " + message)

Parameters:

message - The message to display before clazz

clazz - The mod class

Throws:

java.lang.IllegalStateException - If finish() has been called.

toStringMod

static java.lang.String toStringMod(java.lang.Class<?> clazz)