com.xmlmind.xml.load

Class LoadErrorImpl

java.lang.Object

com.xmlmind.xml.load.LoadErrorImpl

All Implemented Interfaces:

LoadError

public final class LoadErrorImpl
extends Object
implements LoadError

A simple implementation of LoadError.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadErrorImpl.CompareLoadErrors Compares load errors by their locations.

Nested classes/interfaces inherited from interface com.xmlmind.xml.load.LoadError

LoadError.Type

Field Summary

Fields

Modifier and Type	Field and Description
int	columnNumber The column number where this error was found.
static LoadErrorImpl.CompareLoadErrors	COMPARE_LOAD_ERRORS A ready-to-use comparator, comparing two load errors by their locations.
int	lineNumber The line number where this error was found.
String	message The error message.
static LoadErrorImpl[]	NO_ERRORS An empty array of load errors.
Node	node The node where this error was found.
LoadError.Type	type The type of this error.
URL	url The URL of the file where this error was found.

Constructor Summary

Constructors

Constructor and Description
LoadErrorImpl(LoadError.Type type, Node node, String message) Constructs an error found for specified node.
LoadErrorImpl(LoadError.Type type, URL url, int lineNumber, int columnNumber, String message) Constructs an error found in specified file.

Method Summary

Modifier and Type	Method and Description
static String	format(LoadError error, boolean isWarning) Utility function: returns localized message representing all the information contained in specified load error.
static Element	getElementInError(LoadError error) Convenience method: unlike getNodeInError() which returns a Node, this method always returns an Element.
int	getErrorColumnNumber() Returns the column number where this error was found.
int	getErrorLineNumber() Returns the line number where this error was found.
URL	getErrorLocation() Returns the URL of the file where this error was found.
String	getErrorMessage() Returns the error message.
LoadError.Type	getErrorType() Returns the type of this error.
Node	getNodeInError() Returns the node where this error was found.

Methods inherited from class java.lang.Object

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

Field Detail

NO_ERRORS

public static final LoadErrorImpl[] NO_ERRORS

An empty array of load errors.

type

public final LoadError.Type type

The type of this error.

url

public final URL url

The URL of the file where this error was found. Returns null if unknown or not applicable.

lineNumber

public final int lineNumber

The line number where this error was found. Number of first line is 1. Returns -1 if unknown or not applicable.

columnNumber

public final int columnNumber

The column number where this error was found. Number of first column is 1. Returns -1 if unknown or not applicable.

node

public final Node node

The node where this error was found. Returns null if unknown or not applicable.

message

public final String message

The error message.

COMPARE_LOAD_ERRORS

public static final LoadErrorImpl.CompareLoadErrors COMPARE_LOAD_ERRORS

A ready-to-use comparator, comparing two load errors by their locations.

Constructor Detail

LoadErrorImpl

public LoadErrorImpl(LoadError.Type type,
                     URL url,
                     int lineNumber,
                     int columnNumber,
                     String message)

Constructs an error found in specified file.

Parameters:

type - The type of the error.

url - The URL of the file where this error was found.

lineNumber - The line number where this error was found. Number of first line is 1. Returns -1 if unknown.

columnNumber - The column number where this error was found. Number of first column is 1. Returns -1 if unknown.

message - The error message.

LoadErrorImpl

public LoadErrorImpl(LoadError.Type type,
                     Node node,
                     String message)

Constructs an error found for specified node.

Parameters:

type - The type of the error.

node - The node where the error was found.

message - The error message.

Method Detail

getErrorType

public LoadError.Type getErrorType()

Description copied from interface: LoadError

Returns the type of this error.

Specified by:

getErrorType in interface LoadError

getErrorLocation

public URL getErrorLocation()

Description copied from interface: LoadError

Returns the URL of the file where this error was found. Returns null if unknown or not applicable.

Specified by:

getErrorLocation in interface LoadError

getErrorLineNumber

public int getErrorLineNumber()

Description copied from interface: LoadError

Returns the line number where this error was found. Number of first line is 1. Returns -1 if unknown or not applicable.

Specified by:

getErrorLineNumber in interface LoadError

getErrorColumnNumber

public int getErrorColumnNumber()

Description copied from interface: LoadError

Returns the column number where this error was found. Number of first column is 1. Returns -1 if unknown or not applicable.

Specified by:

getErrorColumnNumber in interface LoadError

getNodeInError

public Node getNodeInError()

Description copied from interface: LoadError

Returns the node where this error was found. Returns null if unknown or not applicable.

Specified by:

getNodeInError in interface LoadError

getErrorMessage

public String getErrorMessage()

Description copied from interface: LoadError

Returns the error message.

Specified by:

getErrorMessage in interface LoadError

getElementInError

public static Element getElementInError(LoadError error)

Convenience method: unlike getNodeInError() which returns a Node, this method always returns an Element. For example, it returns the root element when getNodeInError returns the Document.

format

public static String format(LoadError error,
                            boolean isWarning)

Utility function: returns localized message representing all the information contained in specified load error.

Parameters:

error - Load error to be formatted.

isWarning - If true, the load error object is just a warning; if false, it is an actual error.