Index

C D E F G I L N O P Q R S T V X
All Classes and Interfaces|All Packages|Serialized Form

C

column() - Method in exception class org.libxmq.ParseException

Get the column.

compact() - Method in class org.libxmq.OutputSettings

Returns the previously set compact setting.

CONTINUE - Enum constant in enum class org.libxmq.Proceed

Return CONTINUE from invoke in the node callback, to keep iterating.

D

DecodingException - Exception Class in org.libxmq

The DecodingException is thrown when a query failes to decode the text retrieved from the Document into the desired type.

DecodingException(String, String, String) - Constructor for exception class org.libxmq.DecodingException

Construct a decoding exception.

E

element(String) - Method in class org.libxmq.Query

Fetches a single element from the xpath.

errorCode() - Method in exception class org.libxmq.ParseException

Get the error code.

expect(String, NodeCallback) - Method in class org.libxmq.Query

Perform a single callback for a single node matching the xpath expression.

F

forEach(String, NodeCallback) - Method in class org.libxmq.Query

Perform a callback for each node matching the xpath expression.

G

getBoolean(String) - Method in class org.libxmq.Query

Get a boolean from an xpath location.

getDouble(String, String) - Method in class org.libxmq.Query

Get a 64 bit IEEE double floating point value from an xpath location and check that it complies with the restrictions.

getFloat(String, String) - Method in class org.libxmq.Query

Get a 32 bit IEEE double floating point value from an xpath location and check that it complies with the restrictions.

getFQDN(String) - Static method in class org.libxmq.QueryNetwork

Retrieve a fully qualified domain name, such as mail.mydomain.com.

getHostname(String) - Static method in class org.libxmq.QueryNetwork

Retrieve a host name, such as mail or gateway or mycomputer.

getImplicitRoot() - Method in class org.libxmq.InputSettings

Returns the previously set trim none.

getInetAddress(String) - Static method in class org.libxmq.QueryNetwork

Retrieve an internet address ipv4 or ipv6.

getInt(String, String) - Method in class org.libxmq.Query

Get a 32 bit signed integer from an xpath location and check that it complies with the restriction.

getLong(String, String) - Method in class org.libxmq.Query

Get a 64 bit signed integer from an xpath location that complies with any restriction.

getNoMerge() - Method in class org.libxmq.InputSettings

Returns the previously set no merge.

getOptionalBoolean(String) - Method in class org.libxmq.Query

Get an optional boolean from an xpath location.

getOptionalDouble(String, String) - Method in class org.libxmq.Query

Get an optional 64 bit IEEE double floating point value from an xpath location and check that it complies with the restrictions.

getOptionalFloat(String, String) - Method in class org.libxmq.Query

Get an optional 32 bit IEEE double floating point value from an xpath location and check that it complies with the restrictions.

getOptionalInt(String, String) - Method in class org.libxmq.Query

Get an optional 32 bit signed integer from an xpath location and check that it complies with the restriction.

getOptionalLong(String, String) - Method in class org.libxmq.Query

Get an optional 64 bit signed integer from an xpath location that complies with any restriction.

getOptionalString(String, String) - Method in class org.libxmq.Query

Get an optional string from an xpath location that complies with a restriction.

getString(String, String) - Method in class org.libxmq.Query

Get a string from an xpath location that complies with a restriction.

getTrimNone() - Method in class org.libxmq.InputSettings

Returns the previously set trim none.

getURL(String) - Static method in class org.libxmq.QueryNetwork

Retrieve an URL, such as https://foo.bar.com?

getXPathExpression(String) - Method in class org.libxmq.Query

Fetch a potentially cached xpath expression.

I

indentAmount() - Method in class org.libxmq.OutputSettings

Returns the previously set indentation amount.

InputSettings - Class in org.libxmq

Used to configure the parser behaviour when parsing XMQ.

InputSettings() - Constructor for class org.libxmq.InputSettings

Construct an default input settings.

invoke(Node) - Method in interface org.libxmq.NodeCallback

Invoked for each node found.

L

line() - Method in exception class org.libxmq.ParseException

Get the line number.

N

node() - Method in class org.libxmq.Query

Return the node from which the query starts.

NodeCallback - Interface in org.libxmq

A functional interface used to call back for each found DOM node.

NotFoundException - Exception Class in org.libxmq

The not found exception is thrown when a query cannot find the desired value to decode and return.

NotFoundException(String) - Constructor for exception class org.libxmq.NotFoundException

Construct a not found exception.

O

optionalElement(String) - Method in class org.libxmq.Query

Fetches a single optional element from the xpath.

org.libxmq - module org.libxmq

The org.libxmq module contains the XMQ library used to parse/print/render XMQ/XML/HTML/JSON.

org.libxmq - package org.libxmq

OutputSettings - Class in org.libxmq

The OutputSettings class is used to configure the output behavior when printing XMQ.

OutputSettings() - Constructor for class org.libxmq.OutputSettings

Create default output settings.

P

parseBuffer(String, InputSettings) - Method in class org.libxmq.XMQ

Parse a buffer containing XMQ/XML/HTML/JSON/CLINES.

ParseErrorCode - Enum Class in org.libxmq

These are the potential parse errors that can be returned from libxmq.

ParseException - Exception Class in org.libxmq

The parse exception contains necessary information to understand the parse failure.

ParseException(ParseErrorCode, String, int, int, String) - Constructor for exception class org.libxmq.ParseException

Construct a parse exception.

parseFile(Path, InputSettings) - Method in class org.libxmq.XMQ

Parse a file containing XMQ/XML/HTML/JSON/CLINES.

printException(ParseException) - Static method in class org.libxmq.XMQ

Render a locale adapted text cli error printout of a parse exception using the default locale.

printException(ParseException, Locale) - Static method in class org.libxmq.XMQ

Render a locale adapted text cli error printout of a parse exception.

Proceed - Enum Class in org.libxmq

Used when iterating over found DOM nodes.

Q

query(String) - Method in class org.libxmq.Query

Fetches a single element and wraps it inside a query from the xpath.

Query - Class in org.libxmq

The Query class implemets the basic querying methods.

Query(Node) - Constructor for class org.libxmq.Query

Build a new query from a DOM node.

queryBuffer(String, InputSettings) - Method in class org.libxmq.XMQ

Parse a buffer containing XMQ/XML/HTML/JSON/CLINES and return a Query object for the DOM.

queryFile(Path, InputSettings) - Method in class org.libxmq.XMQ

Parse a file containing XMQ/XML/HTML/JSON/CLINES and return a Query object to the DOM.

QueryNetwork - Class in org.libxmq

Implements network related queries, url:s, hostnames, ip-addresses etc.

QueryNetwork(Node) - Constructor for class org.libxmq.QueryNetwork

Build a new query from a DOM node.

QueryScientific - Class in org.libxmq

This class is used to extract scientific values from a DOM.

QueryScientific(Node) - Constructor for class org.libxmq.QueryScientific

Build a new scientific query from a DOM node.

R

renderHTML(Document, OutputSettings) - Method in class org.libxmq.XMQ

Render the document as XMQ in HTML.

renderTEX(Document, OutputSettings) - Method in class org.libxmq.XMQ

Render the document as XMQ in TeX.

S

setCompact(boolean) - Method in class org.libxmq.OutputSettings

Set if printing compact XMQ or not.

setImplicitRoot(String) - Method in class org.libxmq.InputSettings

Set the implicit root when parsing XMQ.

setIndentAmount(int) - Method in class org.libxmq.OutputSettings

Sets the number of spaces to use for each level of indentation when pretty printing XMQ output.

setNoMerge(boolean) - Method in class org.libxmq.InputSettings

Disable automatic merging of text noes when loading document.

setTrimNone(boolean) - Method in class org.libxmq.InputSettings

Disable whitespace trimming using the xmq heuristic when loading xml/html.

source() - Method in exception class org.libxmq.ParseException

Get the source, ie file name, "mbuffer", "stdin" etc.

STOP - Enum constant in enum class org.libxmq.Proceed

Return STOP from invoke in the node callback, to stop itering.

T

text() - Method in exception class org.libxmq.ParseException

Get the line of text.

toCLINES(Document, OutputSettings) - Method in class org.libxmq.XMQ

Print the document as clines.

toHTML(Document, OutputSettings) - Method in class org.libxmq.XMQ

Print the document as HTML.

toJSON(Document, OutputSettings) - Method in class org.libxmq.XMQ

Print the document as json.

TooManyException - Exception Class in org.libxmq

The too many exception is thrown when a query expected a single answer but more than one was found.

TooManyException(String) - Constructor for exception class org.libxmq.TooManyException

Construct a too many exception.

toXML(Document, OutputSettings) - Method in class org.libxmq.XMQ

Print the document as XML.

toXMQ(Document, OutputSettings) - Method in class org.libxmq.XMQ

Print the document as XMQ.

V

value - Variable in enum class org.libxmq.ParseErrorCode

Return error code.

valueOf(String) - Static method in enum class org.libxmq.ParseErrorCode

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

valueOf(String) - Static method in enum class org.libxmq.Proceed

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

valueOf(String) - Static method in enum class org.libxmq.XMQColorName

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

values() - Static method in enum class org.libxmq.ParseErrorCode

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

values() - Static method in enum class org.libxmq.Proceed

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

values() - Static method in enum class org.libxmq.XMQColorName

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

X

XMQ - Class in org.libxmq

The XMQ class is used to parse/print/render XMQ/XML/HTML/JSON documents.

XMQ() - Constructor for class org.libxmq.XMQ

Construct an XMQ with the default DOM implementation.

XMQ(DocumentBuilderFactory) - Constructor for class org.libxmq.XMQ

Construct an XMQ with a DocumentBuilderFactory if you need to override the default DOM implementation.

XMQ_COLOR_AK - Enum constant in enum class org.libxmq.XMQColorName

Attribute Key

XMQ_COLOR_AKV - Enum constant in enum class org.libxmq.XMQColorName

Attribute Key Value

XMQ_COLOR_C - Enum constant in enum class org.libxmq.XMQColorName

Comment

XMQ_COLOR_CP - Enum constant in enum class org.libxmq.XMQColorName

Compound Parentheses

XMQ_COLOR_E - Enum constant in enum class org.libxmq.XMQColorName

Entity

XMQ_COLOR_EK - Enum constant in enum class org.libxmq.XMQColorName

Element Key

XMQ_COLOR_EKV - Enum constant in enum class org.libxmq.XMQColorName

Element Key Value

XMQ_COLOR_EN - Enum constant in enum class org.libxmq.XMQColorName

Element Name

XMQ_COLOR_NS - Enum constant in enum class org.libxmq.XMQColorName

Name Space (both for element and attribute)

XMQ_COLOR_NSD - Enum constant in enum class org.libxmq.XMQColorName

Name Space Declaration xmlns

XMQ_COLOR_Q - Enum constant in enum class org.libxmq.XMQColorName

Quote

XMQ_COLOR_UW - Enum constant in enum class org.libxmq.XMQColorName

Unicode whitespace

XMQ_COLOR_XLS - Enum constant in enum class org.libxmq.XMQColorName

Override XLS element names with this color.

XMQ_ERROR_ATTRIBUTES_NOT_CLOSED - Enum constant in enum class org.libxmq.ParseErrorCode

Attributes not closed.

XMQ_ERROR_BAD_DOCTYPE - Enum constant in enum class org.libxmq.ParseErrorCode

Bad doctype.

XMQ_ERROR_BODY_NOT_CLOSED - Enum constant in enum class org.libxmq.ParseErrorCode

Body not closed.

XMQ_ERROR_CANNOT_HANDLE_HTML - Enum constant in enum class org.libxmq.ParseErrorCode

Cannot handle HTML.

XMQ_ERROR_CANNOT_HANDLE_JSON - Enum constant in enum class org.libxmq.ParseErrorCode

Cannot handle JSON.

XMQ_ERROR_CANNOT_HANDLE_XML - Enum constant in enum class org.libxmq.ParseErrorCode

Cannot handle XML.

XMQ_ERROR_CANNOT_READ_FILE - Enum constant in enum class org.libxmq.ParseErrorCode

Cannot read file.

XMQ_ERROR_COMMENT_CLOSED_WITH_TOO_MANY_SLASHES - Enum constant in enum class org.libxmq.ParseErrorCode

Comment closed with too many slashes.

XMQ_ERROR_COMMENT_NOT_CLOSED - Enum constant in enum class org.libxmq.ParseErrorCode

Comment not closed.

XMQ_ERROR_COMPOUND_MAY_NOT_CONTAIN - Enum constant in enum class org.libxmq.ParseErrorCode

Compound may not contain.

XMQ_ERROR_COMPOUND_NOT_CLOSED - Enum constant in enum class org.libxmq.ParseErrorCode

Compound not closed.

XMQ_ERROR_ENTITY_NOT_CLOSED - Enum constant in enum class org.libxmq.ParseErrorCode

Entity not closed.

XMQ_ERROR_EXPECTED_CONTENT_AFTER_EQUALS - Enum constant in enum class org.libxmq.ParseErrorCode

Expected content after equals.

XMQ_ERROR_EXPECTED_HTML - Enum constant in enum class org.libxmq.ParseErrorCode

Expected HTML.

XMQ_ERROR_EXPECTED_HTMQ - Enum constant in enum class org.libxmq.ParseErrorCode

Expected HTMQ.

XMQ_ERROR_EXPECTED_JSON - Enum constant in enum class org.libxmq.ParseErrorCode

Expected JSON.

XMQ_ERROR_EXPECTED_XML - Enum constant in enum class org.libxmq.ParseErrorCode

Expected XML.

XMQ_ERROR_EXPECTED_XMQ - Enum constant in enum class org.libxmq.ParseErrorCode

Expected XMQ.

XMQ_ERROR_INVALID_CHAR - Enum constant in enum class org.libxmq.ParseErrorCode

Invalid char.

XMQ_ERROR_IXML_EXPECTED_DOT - Enum constant in enum class org.libxmq.ParseErrorCode

IXML expected dot.

XMQ_ERROR_IXML_EXPECTED_EQUAL_OR_COLON - Enum constant in enum class org.libxmq.ParseErrorCode

IXML expected equal or colon.

XMQ_ERROR_IXML_EXPECTED_NAME - Enum constant in enum class org.libxmq.ParseErrorCode

IXML expected name.

XMQ_ERROR_IXML_EXPECTED_RULE - Enum constant in enum class org.libxmq.ParseErrorCode

IXML expected rule.

XMQ_ERROR_IXML_SYNTAX_ERROR - Enum constant in enum class org.libxmq.ParseErrorCode

IXML syntax error.

XMQ_ERROR_IXML_UNEXPECTED_END - Enum constant in enum class org.libxmq.ParseErrorCode

IXML unexpected end.

XMQ_ERROR_JSON_INVALID_CHAR - Enum constant in enum class org.libxmq.ParseErrorCode

JSON invalid char.

XMQ_ERROR_JSON_INVALID_ESCAPE - Enum constant in enum class org.libxmq.ParseErrorCode

JSON invalid escape.

XMQ_ERROR_NONE - Enum constant in enum class org.libxmq.ParseErrorCode

No error.

XMQ_ERROR_NOT_XMQ - Enum constant in enum class org.libxmq.ParseErrorCode

Not XMQ.

XMQ_ERROR_OOM - Enum constant in enum class org.libxmq.ParseErrorCode

Out of memory.

XMQ_ERROR_PARSING_HTML - Enum constant in enum class org.libxmq.ParseErrorCode

Error parsing HTML.

XMQ_ERROR_PARSING_XML - Enum constant in enum class org.libxmq.ParseErrorCode

Error parsing XML.

XMQ_ERROR_QUOTE_CLOSED_WITH_TOO_MANY_QUOTES - Enum constant in enum class org.libxmq.ParseErrorCode

Quote closed with too many quotes.

XMQ_ERROR_QUOTE_NOT_CLOSED - Enum constant in enum class org.libxmq.ParseErrorCode

Quote not closed.

XMQ_ERROR_UNEXPECTED_CLOSING_BRACE - Enum constant in enum class org.libxmq.ParseErrorCode

Unexpected closing brace.

XMQ_ERROR_UNEXPECTED_TAB - Enum constant in enum class org.libxmq.ParseErrorCode

Unexpected tab.

XMQ_ERROR_VALUE_CANNOT_START_WITH - Enum constant in enum class org.libxmq.ParseErrorCode

Value cannot start with.

XMQ_WARNING_QUOTES_NEEDED - Enum constant in enum class org.libxmq.ParseErrorCode

Warning quotes needed.

XMQColorName - Enum Class in org.libxmq

XMQSyntax: SYNTAX_C: Comments SYNTAX_Q: Standalone quote.

C D E F G I L N O P Q R S T V X
All Classes and Interfaces|All Packages|Serialized Form