net.wildfyre.descriptors

Class NoSuchEntityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

net.wildfyre.descriptors.NoSuchEntityException

All Implemented Interfaces:

Serializable

public class NoSuchEntityException
extends Exception

Exception thrown when the client queries an entity that does not exist server-side.

This exception stores internally a reference to the entity that did not exist, as a Descriptor. You can get it using the methods get(), or downcast it using methods such has asUser(), etc. Downcasting is generally considered a bad practice since the introduction of Generic types in Java, but we kept it here because it is not allowed to use Generics for classes that inherit from Throwable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NoSuchEntityException(String message) Creates a NoSuchEntityException.
NoSuchEntityException(String message, Descriptor descriptor) Creates a NoSuchEntityException.

Method Summary

Modifier and Type	Method and Description
Optional<Area>	asArea() Downcasts the descriptor stored in this exception to an Area; fails if there is no descriptor stored or if the descriptor is of the wrong type.
Optional<User>	asUser() Downcasts the descriptor stored in this exception to a User; fails if there is no descriptor stored or if the descriptor is of the wrong type.
Optional<Descriptor>	get() The entity that does not exist server-side, or an empty optional if none was specified when creating this exception.
boolean	isPresent() Was an entity specified when creating this exception?

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NoSuchEntityException

public NoSuchEntityException(String message)

Creates a NoSuchEntityException.

Parameters:

message - the message.

NoSuchEntityException

public NoSuchEntityException(String message,
                             Descriptor descriptor)

Creates a NoSuchEntityException.

Parameters:

message - the message.

descriptor - the entity that failed.

Method Detail

get

public Optional<Descriptor> get()

The entity that does not exist server-side, or an empty optional if none was specified when creating this exception.

Returns:

The entity that does not exist server-side.

isPresent

public boolean isPresent()

Was an entity specified when creating this exception?

Returns:

true if an entity was given to the constructor of this exception.

asUser

public Optional<User> asUser()

Downcasts the descriptor stored in this exception to a User; fails if there is no descriptor stored or if the descriptor is of the wrong type.

Returns:

The Descriptor casted as a User, or an empty optional if no descriptor is stored or if the descriptor stored is not a subclass of User.

asArea

public Optional<Area> asArea()

Downcasts the descriptor stored in this exception to an Area; fails if there is no descriptor stored or if the descriptor is of the wrong type.

Returns:

The Descriptor casted as an Area, or an empty optional if no descriptor is stored or if the descriptor stored is not a subclass of Area.