Package io.jenkins.plugins.xmleditor.core.parse

Class XmlDocuments

java.lang.Object

io.jenkins.plugins.xmleditor.core.parse.XmlDocuments

public final class XmlDocuments
extends Object

Entry point for turning file bytes into a lossless document and back.

Method Summary

Modifier and Type	Method	Description
static LDocument	parse(byte[] bytes, String displayName, long maxBytes)	Decodes, checks well-formedness (securely) and builds the lossless tree.
static LDocument	parseText(String text, String displayName, long maxBytes)	Parses XML that is already text (e.g.
static byte[]	toBytes(LDocument doc)

Methods inherited from class java.lang.Object

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

Method Details

parse

public static LDocument parse(byte[] bytes,
 String displayName,
 long maxBytes)
                       throws XmlEditorException

Decodes, checks well-formedness (securely) and builds the lossless tree.

Parameters:

displayName - used as prefix of error messages, e.g. pom.xml:12:5: ...

Throws:

XmlEditorException

parseText

public static LDocument parseText(String text,
 String displayName,
 long maxBytes)
                           throws XmlEditorException

Parses XML that is already text (e.g. the text: parameter of a step): the encoding declared in it is ignored, since there are no bytes to decode.

Throws:

XmlEditorException

toBytes

public static byte[] toBytes(LDocument doc)
                      throws XmlEditorException

Throws:

XmlEditorException