net.morimekta.providence

Class PApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

net.morimekta.providence.PApplicationException

All Implemented Interfaces:

Serializable, Comparable<PApplicationException>, PException, PMessage<PApplicationException,PApplicationException._Field>, PValue<PApplicationException>, BinaryWriter, net.morimekta.util.Stringable

@Generated(value="providence-maven-plugin")
 @Immutable
public class PApplicationException
extends IOException
implements PMessage<PApplicationException,PApplicationException._Field>, PException, Comparable<PApplicationException>, BinaryWriter

Base exception thrown on non-declared exceptions on a service call, and other server-side service call issues.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PApplicationException._Builder Base exception thrown on non-declared exceptions on a service call, and other server-side service call issues.
static class	PApplicationException._Field

Field Summary

Fields

Modifier and Type	Field and Description
static PExceptionDescriptor<PApplicationException,PApplicationException._Field>	kDescriptor

Constructor Summary

Constructors

Constructor and Description
PApplicationException(String pMessage, PApplicationExceptionType pId)

Method Summary

Modifier and Type	Method and Description
String	asString() Pure string representation of content.
static PApplicationException._Builder	builder() Make a pservice.PApplicationException builder.
int	compareTo(PApplicationException other)
PExceptionDescriptor<PApplicationException,PApplicationException._Field>	descriptor()
boolean	equals(Object o)
PApplicationException	fillInStackTrace()
<T> T	get(int key)
PApplicationExceptionType	getId() The application exception type.
String	getMessage() Exception message.
boolean	has(int key)
int	hashCode()
boolean	hasId()
boolean	hasMessage()
PApplicationException	initCause(Throwable cause)
PApplicationException._Builder	mutate() Get a builder that extends the current object.
Optional<PApplicationExceptionType>	optionalId() The application exception type.
Optional<String>	optionalMessage() Exception message.
String	origGetLocalizedMessage() Get the original message from the actual exception.
String	origGetMessage() Get the original message from the actual exception.
static PExceptionDescriptorProvider<PApplicationException,PApplicationException._Field>	provider()
String	toString()
int	writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer) Write the current message to the binary writer.

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getLocalizedMessage, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.morimekta.providence.PMessage

get, has, mergeWith

Field Detail

kDescriptor

public static final PExceptionDescriptor<PApplicationException,PApplicationException._Field> kDescriptor

Constructor Detail

PApplicationException

public PApplicationException(String pMessage,
                             PApplicationExceptionType pId)

Method Detail

hasMessage

public boolean hasMessage()

getMessage

public String getMessage()

Exception message.

Overrides:

getMessage in class Throwable

Returns:

The message value

optionalMessage

@Nonnull
public Optional<String> optionalMessage()

Exception message.

Returns:

Optional of the message field value.

hasId

public boolean hasId()

getId

public PApplicationExceptionType getId()

The application exception type.

Returns:

The id value

optionalId

@Nonnull
public Optional<PApplicationExceptionType> optionalId()

The application exception type.

Returns:

Optional of the id field value.

has

public boolean has(int key)

Specified by:

has in interface PMessage<PApplicationException,PApplicationException._Field>

Parameters:

key - The key of the field.

Returns:

Whether the field is present.

get

public <T> T get(int key)

Specified by:

get in interface PMessage<PApplicationException,PApplicationException._Field>

Type Parameters:

T - The return type.

Parameters:

key - The key of the field.

Returns:

The value of the field.

origGetMessage

public String origGetMessage()

Description copied from interface: PException

Get the original message from the actual exception.

Specified by:

origGetMessage in interface PException

Returns:

The original message.

origGetLocalizedMessage

public String origGetLocalizedMessage()

Description copied from interface: PException

Get the original message from the actual exception.

Specified by:

origGetLocalizedMessage in interface PException

Returns:

The original message.

initCause

public PApplicationException initCause(Throwable cause)

Overrides:

initCause in class Throwable

fillInStackTrace

public PApplicationException fillInStackTrace()

Overrides:

fillInStackTrace in class Throwable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Throwable

asString

@Nonnull
public String asString()

Description copied from interface: PMessage

Pure string representation of content. Does not contain type info.

Specified by:

asString in interface PMessage<PApplicationException,PApplicationException._Field>

Specified by:

asString in interface net.morimekta.util.Stringable

Returns:

String representation.

compareTo

public int compareTo(PApplicationException other)

Specified by:

compareTo in interface Comparable<PApplicationException>

writeBinary

public int writeBinary(net.morimekta.util.io.BigEndianBinaryWriter writer)
                throws IOException

Description copied from interface: BinaryWriter

Write the current message to the binary writer. NOTE: This method is not intended to be used directly. Instead use the BinarySerializer.serialize(OutputStream, PMessage) call.

Specified by:

writeBinary in interface BinaryWriter

Parameters:

writer - The binary writer to write to.

Returns:

The number of bytes written.

Throws:

IOException - If it failed to write the message for any reason.

mutate

@Nonnull
public PApplicationException._Builder mutate()

Description copied from interface: PMessage

Get a builder that extends the current object.

Specified by:

mutate in interface PMessage<PApplicationException,PApplicationException._Field>

Returns:

The builder instance.

provider

@Nonnull
public static PExceptionDescriptorProvider<PApplicationException,PApplicationException._Field> provider()

descriptor

@Nonnull
public PExceptionDescriptor<PApplicationException,PApplicationException._Field> descriptor()

Specified by:

descriptor in interface PMessage<PApplicationException,PApplicationException._Field>

Specified by:

descriptor in interface PValue<PApplicationException>

builder

public static PApplicationException._Builder builder()

Make a pservice.PApplicationException builder.

Returns:

The builder instance.