Package net.morimekta.providence

Class PApplicationException._Builder

java.lang.Object

net.morimekta.providence.PMessageBuilder<PApplicationException,PApplicationException._Field>

net.morimekta.providence.PApplicationException._Builder

All Implemented Interfaces:

PBuilder<PApplicationException>, BinaryReader

Enclosing class:

PApplicationException

public static class PApplicationException._Builder
extends PMessageBuilder<PApplicationException,PApplicationException._Field>
implements BinaryReader

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

Constructor Summary

Constructors

Constructor	Description
_Builder()	Make a pservice.PApplicationException builder instance.
_Builder(PApplicationException base)	Make a mutating builder off a base pservice.PApplicationException.

Method Summary

Modifier and Type	Method	Description
PApplicationException._Builder	addTo(int key, java.lang.Object value)	Adds a value to a set or list container.
PApplicationException	build()	Build the instance value.
PApplicationException._Builder	clear(int key)	Clear the provided field value.
PApplicationException._Builder	clearId()	Clear the id field.
PApplicationException._Builder	clearMessage()	Clear the message field.
PExceptionDescriptor<PApplicationException,PApplicationException._Field>	descriptor()	Get the descriptor for the message being built.
boolean	equals(java.lang.Object o)
PApplicationExceptionType	getId()	The application exception type.
java.lang.String	getMessage()	Exception message.
int	hashCode()
PApplicationException._Builder	initCause(java.lang.Throwable cause)	Initializes the cause of the pservice.PApplicationException
boolean	isModified(int key)	Checks if a specific field is modified on the builder.
boolean	isModifiedId()	Checks if the id field has been modified since the builder was created.
boolean	isModifiedMessage()	Checks if the message field has been modified since the builder was created.
boolean	isSet(int key)	Checks if a specific field is set on the builder.
boolean	isSetId()	Checks for presence of the id field.
boolean	isSetMessage()	Checks for presence of the message field.
PApplicationException._Builder	merge(PApplicationException from)	Merges the provided message into the builder.
PMessageBuilder	mutator(int key)	Get the builder for the given message contained in this builder.
void	readBinary(net.morimekta.util.io.BigEndianBinaryReader reader, boolean strict)	Read the binary content into the current builder.
PApplicationException._Builder	set(int key, java.lang.Object value)	Set the provided field value.
PApplicationException._Builder	setId(PApplicationExceptionType value)	Set the id field value.
PApplicationException._Builder	setMessage(java.lang.String value)	Set the message field value.
boolean	valid()	Checks if the current set data is enough to make a valid struct.
void	validate()	Checks if the current set data is enough to make a valid struct.

Methods inherited from class java.lang.Object

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

Methods inherited from class net.morimekta.providence.PMessageBuilder

addTo, clear, isModified, isSet, modifiedFields, mutator, presentFields, set

Constructor Detail

_Builder

public _Builder()

Make a pservice.PApplicationException builder instance.

_Builder

public _Builder(PApplicationException base)

Make a mutating builder off a base pservice.PApplicationException.

Parameters:

base - The base PApplicationException

Method Detail

merge

@Nonnull
public PApplicationException._Builder merge(PApplicationException from)

Description copied from class: PMessageBuilder

Merges the provided message into the builder. Contained messages should in turn be merged and not replaced wholesale. Sets are unioned (addAll) and maps will overwrite / replace on a per-key basis (putAll).

Specified by:

merge in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

from - The message to merge values from.

Returns:

The message builder.

setMessage

@Nonnull
public PApplicationException._Builder setMessage(java.lang.String value)

Set the message field value.

Exception message.

Parameters:

value - The new value

Returns:

The builder

isSetMessage

public boolean isSetMessage()

Checks for presence of the message field.

Returns:

True if message has been set.

isModifiedMessage

public boolean isModifiedMessage()

Checks if the message field has been modified since the builder was created.

Returns:

True if message has been modified.

clearMessage

@Nonnull
public PApplicationException._Builder clearMessage()

Clear the message field.

Returns:

The builder

getMessage

public java.lang.String getMessage()

Exception message.

Returns:

The message field value

setId

@Nonnull
public PApplicationException._Builder setId(PApplicationExceptionType value)

Set the id field value.

The application exception type.

Parameters:

value - The new value

Returns:

The builder

isSetId

public boolean isSetId()

Checks for presence of the id field.

Returns:

True if id has been set.

isModifiedId

public boolean isModifiedId()

Checks if the id field has been modified since the builder was created.

Returns:

True if id has been modified.

clearId

@Nonnull
public PApplicationException._Builder clearId()

Clear the id field.

Returns:

The builder

getId

public PApplicationExceptionType getId()

The application exception type.

Returns:

The id field value

initCause

@Nonnull
public PApplicationException._Builder initCause(java.lang.Throwable cause)

Initializes the cause of the pservice.PApplicationException

Parameters:

cause - The cause

Returns:

Builder instance

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

mutator

public PMessageBuilder mutator(int key)

Description copied from class: PMessageBuilder

Get the builder for the given message contained in this builder. If the sub-builder does not exist, create, either from existing instance or from scratch.

Specified by:

mutator in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

key - The field key.

Returns:

The field builder.

set

@Nonnull
public PApplicationException._Builder set(int key,
                                          java.lang.Object value)

Description copied from class: PMessageBuilder

Set the provided field value.

Specified by:

set in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

key - The key of the field to set.

value - The value to be set.

Returns:

The message builder.

isSet

public boolean isSet(int key)

Description copied from class: PMessageBuilder

Checks if a specific field is set on the builder.

Specified by:

isSet in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

key - The key of the field to check.

Returns:

True if the field is set.

isModified

public boolean isModified(int key)

Description copied from class: PMessageBuilder

Checks if a specific field is modified on the builder.

Specified by:

isModified in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

key - The key of the field to check.

Returns:

True if the field is modified.

addTo

@Nonnull
public PApplicationException._Builder addTo(int key,
                                            java.lang.Object value)

Description copied from class: PMessageBuilder

Adds a value to a set or list container.

Specified by:

addTo in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

key - The key of the container field to add too.

value - The value to add.

Returns:

The message builder.

clear

@Nonnull
public PApplicationException._Builder clear(int key)

Description copied from class: PMessageBuilder

Clear the provided field value.

Specified by:

clear in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Parameters:

key - The key of the field to clear.

Returns:

The message builder.

valid

public boolean valid()

Description copied from class: PMessageBuilder

Checks if the current set data is enough to make a valid struct. It will check for all required fields, and if any are missing it will return false.

Specified by:

valid in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Returns:

True for a valid message.

validate

public void validate()

Description copied from class: PMessageBuilder

Checks if the current set data is enough to make a valid struct. It will check for all required fields, and if any are missing it will throw an IllegalStateException with an appropriate error message.

Specified by:

validate in class PMessageBuilder<PApplicationException,PApplicationException._Field>

descriptor

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

Description copied from class: PMessageBuilder

Get the descriptor for the message being built.

Specified by:

descriptor in class PMessageBuilder<PApplicationException,PApplicationException._Field>

Returns:

The struct descriptor.

readBinary

public void readBinary(net.morimekta.util.io.BigEndianBinaryReader reader,
                       boolean strict)
                throws java.io.IOException

Description copied from interface: BinaryReader

Read the binary content into the current builder. NOTE: This method is not intended to be used directly. Instead use the BinarySerializer.deserialize(InputStream, PMessageDescriptor) call.

Specified by:

readBinary in interface BinaryReader

Parameters:

reader - The reader to read from.

strict - If content should be handled strictly. True means to fail on everything that Apache thrift failed read() on.

Throws:

java.io.IOException - When unable to read message for any reason.

build

public PApplicationException build()

Description copied from interface: PBuilder

Build the instance value.

Specified by:

build in interface PBuilder<PApplicationException>

Returns:

The instance value.