Module io.xlate.staedi

Package io.xlate.edi.stream

Class EDIStreamException

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.xlate.edi.stream.EDIStreamException

All Implemented Interfaces:

Serializable

public class EDIStreamException
extends Exception

Checked exception that may be thrown by EDIInputFactory, EDIStreamReader, EDIOutputFactory, and EDIStreamWriter in the processing of EDI data.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Location	location	Location of the exception

Constructor Summary

Constructors

Constructor	Description
EDIStreamException(String message)	Construct an exception with the associated message.
EDIStreamException(String message, Location location)	Construct an exception with the associated message, exception and location.
EDIStreamException(String message, Location location, Throwable cause)	Construct an exception with the associated message, exception and location.
EDIStreamException(Throwable cause)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected static String	buildMessage(String message, Location location)	Build a readable message that includes a detail message together with the location of the exception
Location	getLocation()	Gets the location of the 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

Field Details

location

protected final transient Location location

Location of the exception

Constructor Details

EDIStreamException

public EDIStreamException(String message)

Construct an exception with the associated message.

Parameters:

message - the message to report

EDIStreamException

@Deprecated
public EDIStreamException(Throwable cause)

Deprecated.

Construct an exception with the associated exception

Parameters:

cause - a nested exception

EDIStreamException

public EDIStreamException(String message,
 Location location,
 Throwable cause)

Construct an exception with the associated message, exception and location.

Parameters:

message - the message to report

location - the location of the error

cause - a nested error / exception

EDIStreamException

public EDIStreamException(String message,
 Location location)

Construct an exception with the associated message, exception and location.

Parameters:

message - the message to report

location - the location of the error

Method Details

buildMessage

protected static String buildMessage(String message,
 Location location)

Build a readable message that includes a detail message together with the location of the exception

Parameters:

message - detail message for the exception

location - location of the exception

Returns:

concatenation of the detail message and location if the message does not already contain the location

getLocation

public Location getLocation()

Gets the location of the exception

Returns:

the location of the exception, may be null if none is available