org.jsoup.helper

Class DataUtil

java.lang.Object

org.jsoup.helper.DataUtil

public final class DataUtil
extends java.lang.Object

Internal static utilities for handling data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DataUtil.BomCharset

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	boundaryLength
(package private) static int	bufferSize
private static java.util.regex.Pattern	charsetPattern
(package private) static java.lang.String	defaultCharsetName
private static int	firstReadBufferSize
private static char[]	mimeBoundaryChars
static java.nio.charset.Charset	UTF_8

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DataUtil()

Method Summary

Modifier and Type	Method and Description
(package private) static void	crossStreams(java.io.InputStream in, java.io.OutputStream out) Writes the input stream to the output stream.
private static DataUtil.BomCharset	detectCharsetFromBom(java.nio.ByteBuffer byteData)
(package private) static java.nio.ByteBuffer	emptyByteBuffer()
(package private) static java.lang.String	getCharsetFromContentType(java.lang.String contentType) Parse out a charset from a content type header.
static Document	load(java.io.File file, java.lang.String charsetName, java.lang.String baseUri) Loads and parses a file to a Document, with the HtmlParser.
static Document	load(java.io.File file, java.lang.String charsetName, java.lang.String baseUri, Parser parser) Loads and parses a file to a Document.
static Document	load(java.io.InputStream in, java.lang.String charsetName, java.lang.String baseUri) Parses a Document from an input steam.
static Document	load(java.io.InputStream in, java.lang.String charsetName, java.lang.String baseUri, Parser parser) Parses a Document from an input steam, using the provided Parser.
(package private) static java.lang.String	mimeBoundary() Creates a random string, suitable for use as a mime boundary
(package private) static Document	parseInputStream(java.io.InputStream input, java.lang.String charsetName, java.lang.String baseUri, Parser parser)
static java.nio.ByteBuffer	readToByteBuffer(java.io.InputStream inStream, int maxSize) Read the input stream into a byte buffer.
private static java.lang.String	validateCharset(java.lang.String cs)

Methods inherited from class java.lang.Object

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

Field Detail

charsetPattern

private static final java.util.regex.Pattern charsetPattern

UTF_8

public static final java.nio.charset.Charset UTF_8

defaultCharsetName

static final java.lang.String defaultCharsetName

firstReadBufferSize

private static final int firstReadBufferSize

See Also:

Constant Field Values

bufferSize

static final int bufferSize

See Also:

Constant Field Values

mimeBoundaryChars

private static final char[] mimeBoundaryChars

boundaryLength

static final int boundaryLength

See Also:

Constant Field Values

Constructor Detail

DataUtil

private DataUtil()

Method Detail

load

public static Document load(java.io.File file,
                            @Nullable
                            java.lang.String charsetName,
                            java.lang.String baseUri)
                     throws java.io.IOException

Loads and parses a file to a Document, with the HtmlParser. Files that are compressed with gzip (and end in .gz or .z) are supported in addition to uncompressed files.

Parameters:

file - file to load

charsetName - (optional) character set of input; specify null to attempt to autodetect. A BOM in the file will always override this setting.

baseUri - base URI of document, to resolve relative links against

Returns:

Document

Throws:

java.io.IOException - on IO error

load

public static Document load(java.io.File file,
                            @Nullable
                            java.lang.String charsetName,
                            java.lang.String baseUri,
                            Parser parser)
                     throws java.io.IOException

Loads and parses a file to a Document. Files that are compressed with gzip (and end in .gz or .z) are supported in addition to uncompressed files.

Parameters:

file - file to load

charsetName - (optional) character set of input; specify null to attempt to autodetect. A BOM in the file will always override this setting.

baseUri - base URI of document, to resolve relative links against

parser - alternate parser to use.

Returns:

Document

Throws:

java.io.IOException - on IO error

Since:

1.14.2

load

public static Document load(@WillClose
                            java.io.InputStream in,
                            @Nullable
                            java.lang.String charsetName,
                            java.lang.String baseUri)
                     throws java.io.IOException

Parses a Document from an input steam.

Parameters:

in - input stream to parse. The stream will be closed after reading.

charsetName - character set of input (optional)

baseUri - base URI of document, to resolve relative links against

Returns:

Document

Throws:

java.io.IOException - on IO error

load

public static Document load(@WillClose
                            java.io.InputStream in,
                            @Nullable
                            java.lang.String charsetName,
                            java.lang.String baseUri,
                            Parser parser)
                     throws java.io.IOException

Parses a Document from an input steam, using the provided Parser.

Parameters:

in - input stream to parse. The stream will be closed after reading.

charsetName - character set of input (optional)

baseUri - base URI of document, to resolve relative links against

parser - alternate parser to use.

Returns:

Document

Throws:

java.io.IOException - on IO error

crossStreams

static void crossStreams(java.io.InputStream in,
                         java.io.OutputStream out)
                  throws java.io.IOException

Writes the input stream to the output stream. Doesn't close them.

Parameters:

in - input stream to read from

out - output stream to write to

Throws:

java.io.IOException - on IO error

parseInputStream

static Document parseInputStream(@Nullable @WillClose
                                 java.io.InputStream input,
                                 @Nullable
                                 java.lang.String charsetName,
                                 java.lang.String baseUri,
                                 Parser parser)
                          throws java.io.IOException

Throws:

java.io.IOException

readToByteBuffer

public static java.nio.ByteBuffer readToByteBuffer(java.io.InputStream inStream,
                                                   int maxSize)
                                            throws java.io.IOException

Read the input stream into a byte buffer. To deal with slow input streams, you may interrupt the thread this method is executing on. The data read until being interrupted will be available.

Parameters:

inStream - the input stream to read from

maxSize - the maximum size in bytes to read from the stream. Set to 0 to be unlimited.

Returns:

the filled byte buffer

Throws:

java.io.IOException - if an exception occurs whilst reading from the input stream.

emptyByteBuffer

static java.nio.ByteBuffer emptyByteBuffer()

getCharsetFromContentType

@Nullable
static java.lang.String getCharsetFromContentType(@Nullable
                                                            java.lang.String contentType)

Parse out a charset from a content type header. If the charset is not supported, returns null (so the default will kick in.)

Parameters:

contentType - e.g. "text/html; charset=EUC-JP"

Returns:

"EUC-JP", or null if not found. Charset is trimmed and uppercased.

validateCharset

@Nullable
private static java.lang.String validateCharset(@Nullable
                                                          java.lang.String cs)

mimeBoundary

static java.lang.String mimeBoundary()

Creates a random string, suitable for use as a mime boundary

detectCharsetFromBom

@Nullable
private static DataUtil.BomCharset detectCharsetFromBom(java.nio.ByteBuffer byteData)