A B C D E F G H I M N O P S T U V W X
All Classes All Packages

A

accept(XmlException) - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

accept(XmlException) - Method in class com.github.oowekyala.ooxml.messages.PrintStreamMessageHandler

accept(XmlException) - Method in interface com.github.oowekyala.ooxml.messages.XmlMessageHandler

Handle an XML message.

AccumulatingMessageHandler - Class in com.github.oowekyala.ooxml.messages

Accumulates messages and does not display them until the reporter is closed.

AccumulatingMessageHandler(XmlMessageHandler, XmlSeverity) - Constructor for class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

ANSI_RESET - Static variable in enum com.github.oowekyala.ooxml.messages.TerminalColor

Reset all attributes.

apply(String, boolean, boolean, boolean) - Method in enum com.github.oowekyala.ooxml.messages.TerminalColor

Style the given string with this color.

asList(NamedNodeMap) - Static method in class com.github.oowekyala.ooxml.DomUtils

Returns an unmodifiable view of the given nodemap as a list.

asList(NodeList) - Static method in class com.github.oowekyala.ooxml.DomUtils

Returns an unmodifiable view of the given nodelist as a list.

at(Node) - Method in interface com.github.oowekyala.ooxml.messages.XmlMessageReporter

Returns the second stage, which typically allows reporting messages like reporter.at(node).error("an error");.

at(Node) - Method in class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

B

basePrinter - Variable in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

C

children(Element) - Static method in class com.github.oowekyala.ooxml.DomUtils

Returns the list of children of the given element that are also elements.

childrenNamed(Element, String) - Static method in class com.github.oowekyala.ooxml.DomUtils

Returns the list of children of the given element that are also elements.

close() - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

close() - Method in interface com.github.oowekyala.ooxml.messages.XmlMessageReporter

close() - Method in class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

Do nothing by default.

close(XmlSeverity, XmlSeverity) - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

Close the reporter and print the accumulated exceptions.

COL_BLACK - com.github.oowekyala.ooxml.messages.TerminalColor

COL_BLUE - com.github.oowekyala.ooxml.messages.TerminalColor

COL_CYAN - com.github.oowekyala.ooxml.messages.TerminalColor

COL_GREEN - com.github.oowekyala.ooxml.messages.TerminalColor

COL_MAGENTA - com.github.oowekyala.ooxml.messages.TerminalColor

COL_RED - com.github.oowekyala.ooxml.messages.TerminalColor

COL_WHITE - com.github.oowekyala.ooxml.messages.TerminalColor

COL_YELLOW - com.github.oowekyala.ooxml.messages.TerminalColor

com.github.oowekyala.ooxml - package com.github.oowekyala.ooxml

com.github.oowekyala.ooxml.messages - package com.github.oowekyala.ooxml.messages

Simple API to produce nice error messages when reading an XML file.

ContextLines - Class in com.github.oowekyala.ooxml.messages

Helper object that contains the lines around a specific XmlPosition.

create2ndStage(XmlPosition, XmlPositioner) - Method in class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

Creates the object returned by XmlMessageReporterBase.at(Node).

D

DomUtils - Class in com.github.oowekyala.ooxml

Simple utilities to work with the org.w3c.dom API.

DomUtils() - Constructor for class com.github.oowekyala.ooxml.DomUtils

dontPrint(XmlSeverity, Map<String, List<XmlException>>) - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

Handle ignored messages.

E

equals(Object) - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

ERROR - com.github.oowekyala.ooxml.messages.XmlSeverity

An error, with a red color.

F

formatSpec(OoxmlFacade, NiceXmlMessageSpec, XmlPositioner) - Method in interface com.github.oowekyala.ooxml.messages.NiceXmlMessageFormatter

FULL_MESSAGE - Static variable in interface com.github.oowekyala.ooxml.messages.NiceXmlMessageFormatter

Formats errors like:

G

getAttributeOpt(Element, String) - Static method in class com.github.oowekyala.ooxml.DomUtils

Returns the value of the attribute with the given name as an optional.

getCause() - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

getColumn() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

Returns the (1-based) column number of the start of this range.

getDocument() - Method in class com.github.oowekyala.ooxml.messages.PositionedXmlDoc

getFormatter() - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

getKind() - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

getKind() - Method in exception com.github.oowekyala.ooxml.messages.XmlException

Returns the message kind.

getLength() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

Returns the length of the text range.

getLine() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

Returns the (1-based) line number of this position.

getLinesAround(XmlPosition, int) - Method in interface com.github.oowekyala.ooxml.messages.XmlPositioner

Enrich the given message with the context of the position.

getNumContextLines() - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

getPosition() - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

getPosition() - Method in exception com.github.oowekyala.ooxml.messages.XmlException

Returns the position where the error occurred.

getPositioner() - Method in class com.github.oowekyala.ooxml.messages.PositionedXmlDoc

getPrinter() - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

getSeverity() - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

getSeverity() - Method in exception com.github.oowekyala.ooxml.messages.XmlException

Returns the severity of the message.

getSimpleMessage() - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

getSimpleMessage() - Method in exception com.github.oowekyala.ooxml.messages.XmlException

Returns the error message, without the surrounding line context.

getSystemId() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

The system ID of the file where the node is located.

H

handleEx(XmlException) - Method in class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

Handle an XML exception.

hashCode() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

I

isUndefined() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

If true, column and line numbers are unreliable

isUseAnsiColors() - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

M

minSeverity - Variable in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

N

NiceXmlMessageFormatter - Interface in com.github.oowekyala.ooxml.messages

Formats a NiceXmlMessageSpec to make the full message of an XmlException.

NiceXmlMessageSpec - Class in com.github.oowekyala.ooxml.messages

NiceXmlMessageSpec(XmlPosition, String) - Constructor for class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

NOOP - Static variable in interface com.github.oowekyala.ooxml.messages.XmlMessageHandler

Ignores all messages.

noPositioner(String) - Static method in interface com.github.oowekyala.ooxml.messages.XmlPositioner

A positioner that returns undefined positions.

O

ooxml - Variable in class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

OoxmlFacade - Class in com.github.oowekyala.ooxml.messages

Main entry point of the API.

OoxmlFacade() - Constructor for class com.github.oowekyala.ooxml.messages.OoxmlFacade

P

parse(DocumentBuilder, InputSource) - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

Parses an XML document and creates an associated XmlPositioner.

PositionedXmlDoc - Class in com.github.oowekyala.ooxml.messages

A simple pair of a parsed Document and an XmlPositioner that can position its nodes.

positioner - Variable in class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

printFully(XmlSeverity, String, List<XmlException>) - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

Print "fully", the default prints all entries.

PrintStreamMessageHandler - Class in com.github.oowekyala.ooxml.messages

Implements XmlMessageHandler with a pair of PrintStreams.

PrintStreamMessageHandler(PrintStream) - Constructor for class com.github.oowekyala.ooxml.messages.PrintStreamMessageHandler

printSummary(XmlSeverity, String, List<XmlException>) - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

Print a summary line, not every one of the entries.

printSummaryLine(String, XmlSeverity, String) - Method in class com.github.oowekyala.ooxml.messages.AccumulatingMessageHandler

S

SINGLE_LINE - Static variable in interface com.github.oowekyala.ooxml.messages.NiceXmlMessageFormatter

startPositionOf(Node) - Method in interface com.github.oowekyala.ooxml.messages.XmlPositioner

Returns an object describing the position in the file of the given XML node.

style(String, TerminalColor, TerminalColor, boolean, boolean, boolean) - Static method in enum com.github.oowekyala.ooxml.messages.TerminalColor

Style both foreground and background.

SYSTEM_ERR - Static variable in interface com.github.oowekyala.ooxml.messages.XmlMessageHandler

Outputs messages to System.err.

T

TerminalColor - Enum in com.github.oowekyala.ooxml.messages

ANSI escape sequences for colors, to style text in terminal environments.

toMap(NamedNodeMap) - Static method in class com.github.oowekyala.ooxml.DomUtils

Returns a new map of nodes built from the given node map.

toString() - Method in exception com.github.oowekyala.ooxml.messages.XmlException

toString() - Method in class com.github.oowekyala.ooxml.messages.XmlPosition

toString() - Method in enum com.github.oowekyala.ooxml.messages.XmlSeverity

U

UNDEFINED - Static variable in class com.github.oowekyala.ooxml.messages.XmlPosition

undefinedIn(String) - Static method in class com.github.oowekyala.ooxml.messages.XmlPosition

Returns an undefined position in a document identified by the given system ID.

V

valueOf(String) - Static method in enum com.github.oowekyala.ooxml.messages.TerminalColor

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.github.oowekyala.ooxml.messages.XmlSeverity

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.oowekyala.ooxml.messages.TerminalColor

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.github.oowekyala.ooxml.messages.XmlSeverity

Returns an array containing the constants of this enum type, in the order they are declared.

W

WARNING - com.github.oowekyala.ooxml.messages.XmlSeverity

A warning, with a yellow color.

withAnsiColors(boolean) - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

withCause(Throwable) - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

withColor(String) - Method in enum com.github.oowekyala.ooxml.messages.XmlSeverity

Add a color relevant to this kind to the given string.

withContextLines(int) - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

withFormatter(NiceXmlMessageFormatter) - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

withKind(String) - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

withPrinter(XmlMessageHandler) - Method in class com.github.oowekyala.ooxml.messages.OoxmlFacade

withSeverity(XmlSeverity) - Method in class com.github.oowekyala.ooxml.messages.NiceXmlMessageSpec

X

XmlException - Exception in com.github.oowekyala.ooxml.messages

Generic XML exception wrapper.

XmlException(NiceXmlMessageSpec, String) - Constructor for exception com.github.oowekyala.ooxml.messages.XmlException

Create a new exception from the given spec.

XmlMessageHandler - Interface in com.github.oowekyala.ooxml.messages

Handles XML messages, for example forwarding them to a print stream.

XmlMessageReporter<M> - Interface in com.github.oowekyala.ooxml.messages

Reports errors in an XML document.

XmlMessageReporterBase<M> - Class in com.github.oowekyala.ooxml.messages

Base implementation of XmlMessageReporter.

XmlMessageReporterBase(OoxmlFacade, XmlPositioner) - Constructor for class com.github.oowekyala.ooxml.messages.XmlMessageReporterBase

XmlPosition - Class in com.github.oowekyala.ooxml.messages

Represents the location of an XML node in a file.

XmlPosition(String, @com.github.oowekyala.ooxml.messages.Annots.OneBased int, @com.github.oowekyala.ooxml.messages.Annots.OneBased int) - Constructor for class com.github.oowekyala.ooxml.messages.XmlPosition

XmlPosition(String, @com.github.oowekyala.ooxml.messages.Annots.OneBased int, @com.github.oowekyala.ooxml.messages.Annots.OneBased int, int) - Constructor for class com.github.oowekyala.ooxml.messages.XmlPosition

XmlPositioner - Interface in com.github.oowekyala.ooxml.messages

Associates XML nodes with a position.

XmlSeverity - Enum in com.github.oowekyala.ooxml.messages

Severity of a message.

A B C D E F G H I M N O P S T U V W X
All Classes All Packages