net.caseif.flint.round

Interface JoinResult

public interface JoinResult

Represents the result of a Challenger attempting to join a round.

Since:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JoinResult.Status Represents a specific reason for a player failing to join a Round.

Method Summary

Modifier and Type	Method and Description
Challenger	getChallenger() Returns the new Challenger object created by the join event.
JoinResult.Status	getStatus() Returns the JoinResult.Status of this JoinResult.
Throwable	getThrowable() Returns the Throwable which caused an INTERNAL_ERROR status.

Method Detail

getChallenger

Challenger getChallenger()
                  throws IllegalStateException

Returns the new Challenger object created by the join event.

Returns:

The new Challenger object created by the join event

Throws:

IllegalStateException - If getStatus() returns anything other than JoinResult.Status.SUCCESS

Since:

1.1

getStatus

JoinResult.Status getStatus()

Returns the JoinResult.Status of this JoinResult.

Returns:

The JoinResult.Status of this JoinResult

Since:

1.1

getThrowable

Throwable getThrowable()
                throws IllegalStateException

Returns the Throwable which caused an INTERNAL_ERROR status.

Returns:

The Throwable which caused an INTERNAL_ERROR status.

Throws:

IllegalStateException - If getStatus() returns anything other than JoinResult.Status.SUCCESS

Since:

1.1