com.xmlmind.xml.load

Class DocumentCache.Event

java.lang.Object

com.xmlmind.xml.load.DocumentCache.Event

All Implemented Interfaces:

Cloneable

Enclosing class:

DocumentCache

public static class DocumentCache.Event
extends Object
implements Cloneable

Rather low-level event detailing what happened to the document cache.

See Also:

DocumentCache.Listener

Field Summary

Fields

Modifier and Type	Field and Description
DocumentCache	documentCache The document cache which has reported this event.

Constructor Summary

Constructors

Constructor and Description
Event(DocumentCache documentCache) Constructs an empty document cache event.

Method Summary

Modifier and Type	Method and Description
DocumentCache.Event	copy() Returns a shallow copy of this event.
Document	getDocument() Returns the loaded document.
DocumentCache.Entry	getEntry() Returns the cache entry involved in this event.
String	getIOError() Returns the I/O error which has caused the load failure.
List<LoadError>	getLoadErrors() Returns the list of errors which have been reported by the loader while loading the document.
List<LoadError>	getLoadWarnings() Returns the list of warnings which have been reported by the loader while loading the document.
String	getMessage() Returns a localized message representing this event.
DocumentCache.EventType	getType() Returns the type of this event.
URL	getURL() Returns the URL of the document involved in this event.
void	log(Log log) Log this event to specified log.
String	toString() Returns a string representation of this entry which is suitable for debugging and testing.

Methods inherited from class java.lang.Object

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

Field Detail

documentCache

public final DocumentCache documentCache

The document cache which has reported this event.

Constructor Detail

Event

public Event(DocumentCache documentCache)

Constructs an empty document cache event.

Method Detail

copy

public DocumentCache.Event copy()

Returns a shallow copy of this event.

getType

public DocumentCache.EventType getType()

Returns the type of this event.

This information is available for all event types.

getURL

public URL getURL()

Returns the URL of the document involved in this event. Never null.

This information is available for all event types.

getEntry

public DocumentCache.Entry getEntry()

Returns the cache entry involved in this event. May be null.

This information is available for all event types except DocumentCache.EventType.LOADED_DOCUMENT.

getDocument

public Document getDocument()

Returns the loaded document. Is null if loading the document has failed.

This information is available only for the DocumentCache.EventType.LOADED_DOCUMENT event type.

See Also:

getIOError(), getLoadErrors(), getLoadWarnings()

getIOError

public String getIOError()

Returns the I/O error which has caused the load failure. May be null.

This information is available only for the DocumentCache.EventType.LOADED_DOCUMENT event type.

See Also:

getDocument(), getLoadErrors(), getLoadWarnings()

getLoadErrors

public List<LoadError> getLoadErrors()

Returns the list of errors which have been reported by the loader while loading the document.

This information is available only for the DocumentCache.EventType.LOADED_DOCUMENT event type.

See Also:

getDocument(), getIOError(), getLoadWarnings()

getLoadWarnings

public List<LoadError> getLoadWarnings()

Returns the list of warnings which have been reported by the loader while loading the document.

This information is available only for the DocumentCache.EventType.LOADED_DOCUMENT event type.

See Also:

getDocument(), getIOError(), getLoadErrors()

toString

public String toString()

Returns a string representation of this entry which is suitable for debugging and testing.

Overrides:

toString in class Object

log

public void log(Log log)

Log this event to specified log. The log entry is the localized message returned by getMessage().

getMessage

public String getMessage()

Returns a localized message representing this event.