Module io.xlate.staedi

Package io.xlate.edi.stream

Class EDIValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.xlate.edi.stream.EDIValidationException

All Implemented Interfaces:

Serializable

public class EDIValidationException
extends RuntimeException

Runtime exception that may occur when reading or writing EDI any the EDI error event would not otherwise be handled by an application. For example, when writing EDI and no EDIOutputErrorReporter is in use.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final CharSequence	data	The data from the data stream (input for a reader or output for a writer) associated with the validation error.
protected final EDIStreamValidationError	error	The actual error of this exception.
protected final EDIStreamEvent	event	The stream event associated with the error, one of the events for which EDIStreamEvent.isError() is true.
protected final Location	location	Location of the exception

Constructor Summary

Constructors

Constructor	Description
EDIValidationException(EDIStreamEvent event, EDIStreamValidationError error, Location location, CharSequence data)	Construct an EDIValidationException with the given data elements.

Method Summary

Modifier and Type	Method	Description
CharSequence	getData()	Get the data associated with the validation error
EDIStreamValidationError	getError()	Get the type of validation error
EDIStreamEvent	getEvent()	Get the stream event associated with the error
Location	getLocation()	Get the location of the validation error
EDIValidationException	getNextException()	Retrieves the exception chained to this EDIValidationException object by setNextException(EDIValidationException ex).
void	setNextException(EDIValidationException ex)	Adds an EDIValidationException object to the end of the chain.

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

Field Details

event

protected final EDIStreamEvent event

The stream event associated with the error, one of the events for which EDIStreamEvent.isError() is true.

error

protected final EDIStreamValidationError error

The actual error of this exception.

location

protected final transient Location location

Location of the exception

data

protected final transient CharSequence data

The data from the data stream (input for a reader or output for a writer) associated with the validation error.

Constructor Details

EDIValidationException

public EDIValidationException(EDIStreamEvent event,
 EDIStreamValidationError error,
 Location location,
 CharSequence data)

Construct an EDIValidationException with the given data elements.

Parameters:

event - stream event (required)

error - validation error (required)

location - location of the validation error

data - data associated with the validation error

Method Details

getEvent

public EDIStreamEvent getEvent()

Get the stream event associated with the error

Returns:

event associated with the error

getError

public EDIStreamValidationError getError()

Get the type of validation error

Returns:

type of validation error

getLocation

public Location getLocation()

Get the location of the validation error

Returns:

location of the validation error

getData

public CharSequence getData()

Get the data associated with the validation error

Returns:

character data associated with the validation error

getNextException

public EDIValidationException getNextException()

Retrieves the exception chained to this EDIValidationException object by setNextException(EDIValidationException ex).

Returns:

the next EDIValidationException object in the chain; null if there are none

See Also:

• setNextException(io.xlate.edi.stream.EDIValidationException)

setNextException

public void setNextException(EDIValidationException ex)

Adds an EDIValidationException object to the end of the chain.

Parameters:

ex - the new exception that will be added to the end of the EDIValidationException chain

See Also:

• getNextException()