com.google.gerrit.httpd

Class HtmlDomUtil

java.lang.Object

com.google.gerrit.httpd.HtmlDomUtil

public class HtmlDomUtil
extends java.lang.Object

Utility functions to deal with HTML using W3C DOM operations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	ENC Standard character encoding we prefer (UTF-8).
static java.lang.String	HTML_STRICT DOCTYPE for a standards mode HTML document.

Constructor Summary

Constructors

Constructor and Description
HtmlDomUtil()

Method Summary

Modifier and Type	Method and Description
static void	addHidden(org.w3c.dom.Element form, java.lang.String name, java.lang.String value) Append an HTML <input type="hidden"> to the form.
static org.w3c.dom.Document	clone(org.w3c.dom.Document doc) Clone a document so it can be safely modified on a per-request basis.
static byte[]	compress(byte[] raw) Compress the document.
static org.w3c.dom.Element	find(org.w3c.dom.Node parent, java.lang.String name) Find an element by its "id" attribute; null if no element is found.
static org.w3c.dom.Document	newDocument() Construct a new empty document.
static org.w3c.dom.Document	parseFile(java.lang.Class<?> context, java.lang.String name) Parse an XHTML file from our CLASSPATH and return the instance.
static org.w3c.dom.Document	parseFile(java.nio.file.Path path) Parse an XHTML file from the local drive and return the instance.
static java.lang.String	readFile(java.lang.Class<?> context, java.lang.String name) Read a Read a UTF-8 text file from our CLASSPATH and return it.
static java.lang.String	readFile(java.nio.file.Path parentDir, java.lang.String name) Read a UTF-8 text file from the local drive.
static java.lang.String	toString(org.w3c.dom.Document hostDoc) Convert a document to a String, assuming later encoding to UTF-8.
static byte[]	toUTF8(org.w3c.dom.Document hostDoc) Convert a document to a UTF-8 byte sequence.

Methods inherited from class java.lang.Object

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

Field Detail

ENC

public static final java.nio.charset.Charset ENC

Standard character encoding we prefer (UTF-8).

HTML_STRICT

public static final java.lang.String HTML_STRICT

DOCTYPE for a standards mode HTML document.

See Also:

Constant Field Values

Constructor Detail

HtmlDomUtil

public HtmlDomUtil()

Method Detail

toUTF8

public static byte[] toUTF8(org.w3c.dom.Document hostDoc)
                     throws java.io.IOException

Convert a document to a UTF-8 byte sequence.

Throws:

java.io.IOException

compress

public static byte[] compress(byte[] raw)
                       throws java.io.IOException

Compress the document.

Throws:

java.io.IOException

toString

public static java.lang.String toString(org.w3c.dom.Document hostDoc)
                                 throws java.io.IOException

Convert a document to a String, assuming later encoding to UTF-8.

Throws:

java.io.IOException

find

public static org.w3c.dom.Element find(org.w3c.dom.Node parent,
                                       java.lang.String name)

Find an element by its "id" attribute; null if no element is found.

addHidden

public static void addHidden(org.w3c.dom.Element form,
                             java.lang.String name,
                             java.lang.String value)

Append an HTML <input type="hidden"> to the form.

newDocument

public static org.w3c.dom.Document newDocument()

Construct a new empty document.

clone

public static org.w3c.dom.Document clone(org.w3c.dom.Document doc)
                                  throws java.io.IOException

Clone a document so it can be safely modified on a per-request basis.

Throws:

java.io.IOException

parseFile

public static org.w3c.dom.Document parseFile(java.lang.Class<?> context,
                                             java.lang.String name)
                                      throws java.io.IOException

Parse an XHTML file from our CLASSPATH and return the instance.

Throws:

java.io.IOException

readFile

public static java.lang.String readFile(java.lang.Class<?> context,
                                        java.lang.String name)
                                 throws java.io.IOException

Read a Read a UTF-8 text file from our CLASSPATH and return it.

Throws:

java.io.IOException

parseFile

public static org.w3c.dom.Document parseFile(java.nio.file.Path path)
                                      throws java.io.IOException

Parse an XHTML file from the local drive and return the instance.

Throws:

java.io.IOException

readFile

public static java.lang.String readFile(java.nio.file.Path parentDir,
                                        java.lang.String name)
                                 throws java.io.IOException

Read a UTF-8 text file from the local drive.

Throws:

java.io.IOException