Package org.apache.juneau.marshall.html

Class HtmlParserSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.parser.ParserSession

org.apache.juneau.marshall.parser.ReaderParserSession

org.apache.juneau.marshall.xml.XmlParserSession

org.apache.juneau.marshall.html.HtmlParserSession

All Implemented Interfaces:

BeanSession, ConverterSession, ArrayRecordReadable, RecordReadable

public class HtmlParserSession
extends XmlParserSession

ContextSession object that lives for the duration of a single use of HtmlParser.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• HTML

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HtmlParserSession.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.xml.XmlParserSession

XmlParserSession.DefaultBuilder

Field Summary

Fields inherited from class org.apache.juneau.marshall.parser.ParserSession

DEFAULT_MAX_PARSE_DEPTH

Fields inherited from class org.apache.juneau.marshall.MarshallingSession

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HtmlParserSession(HtmlParserSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static HtmlParserSession.Builder	create(HtmlParser ctx)	Creates a new builder for this object.
protected <T> T	doRead(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
protected <E> Collection<E>	doReadIntoCollection(ParserPipe pipe, Collection<E> c, Type elementType)	Implementation method.
protected <K, V> Map<K,V>	doReadIntoMap(ParserPipe pipe, Map<K,V> m, Type keyType, Type valueType)	Implementation method.
protected String	getElementText(XmlReader r)	Identical to readText(XmlReader) except assumes the current event is the opening tag.
protected HtmlBeanPropertyMeta	getHtmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
protected HtmlClassMeta	getHtmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected boolean	isWhitespaceElement(XmlReader r)	Returns true if the current element is a whitespace element.
protected String	readText(XmlReader r)	Parses CHARACTERS data.
protected String	readWhitespaceElement(XmlReader r)	Parses the current whitespace element.

Methods inherited from class org.apache.juneau.marshall.xml.XmlParserSession

create, decodeString, getEventAllocator, getReporter, getResolver, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, getXmlReader, isArrayRecordStreaming, isPreserveRootElement, isRecordStreaming, isValidating, readAnything, readArrayRecords, readArrayRecords, readRecords

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParserSession

create, createPipe, getStreamCharset, isReaderParser, properties

Methods inherited from class org.apache.juneau.marshall.parser.ParserSession

allocateLocal, cast, checkRequired, convertAttrToType, create, doReadToBeanConsumer, enterParseDepth, exitParseDepth, getCalendarFormat, getClassMeta, getDateFormat, getDebugOutputLines, getDurationFormat, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getLocaleFormat, getNulls, getOuter, getPeriodFormat, getPosition, getSchema, getStringBuilder, getTemporalFormat, getTimeZoneFormat, isAutoCloseStreams, isTrimStrings, isUnbuffered, mark, onBeanSetterException, onUnknownProperty, parentBean, read, read, read, read, read, read, readArgs, readCalendar, readDate, readDuration, readIntoCollection, readIntoMap, readPeriod, readTemporal, readToBeanConsumer, returnStringBuilder, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, swapParentBean, trim, trim, unmark, unswap

Methods inherited from class org.apache.juneau.marshall.MarshallingSession

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.marshall.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

HtmlParserSession

protected HtmlParserSession(HtmlParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlParserSession.Builder create(HtmlParser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

doRead

protected <T> T doRead(ParserPipe pipe,
 ClassMeta<T> type)
                throws IOException,
ParseException,
ExecutableException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method or Parser.doRead(ParserSession,ParserPipe,ClassMeta).

The default implementation of this method simply calls Parser.doRead(ParserSession,ParserPipe,ClassMeta).

Overrides:

doRead in class XmlParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, JsonMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.

doReadIntoCollection

protected <E> Collection<E> doReadIntoCollection(ParserPipe pipe,
 Collection<E> c,
 Type elementType)
                                          throws Exception

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doReadIntoCollection in class XmlParserSession

Type Parameters:

E - The element type.

Parameters:

pipe - The parser input.

c - The collection being loaded.

elementType - The class type of the elements, or null to default to whatever is being parsed.

Returns:

The same collection that was passed in to allow this method to be chained.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

doReadIntoMap

protected <K,
V> Map<K,V> doReadIntoMap(ParserPipe pipe,
 Map<K,V> m,
 Type keyType,
 Type valueType)
                                throws Exception

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doReadIntoMap in class XmlParserSession

Type Parameters:

K - The key type.

V - The value type.

Parameters:

pipe - The parser input.

m - The map being loaded.

keyType - The class type of the keys, or null to default to String.class.

valueType - The class type of the values, or null to default to whatever is being parsed.

Returns:

The same map that was passed in to allow this method to be chained.

Throws:

Exception - If thrown from underlying stream, or if the input contains a syntax error or is malformed.

getElementText

protected String getElementText(XmlReader r)
                         throws IOException,
XMLStreamException,
ParseException

Identical to readText(XmlReader) except assumes the current event is the opening tag.

Precondition: Pointing to opening tag. Postcondition: Pointing to closing tag.

Overrides:

getElementText in class XmlParserSession

Parameters:

r - The stream being read from.

Returns:

The parsed string.

Throws:

XMLStreamException - Thrown by underlying XML stream.

ParseException - Malformed input encountered.

IOException - Thrown by underlying stream.

getHtmlBeanPropertyMeta

protected HtmlBeanPropertyMeta getHtmlBeanPropertyMeta(BeanPropertyMeta bpm)

Returns the language-specific metadata on the specified bean property.

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getHtmlClassMeta

protected HtmlClassMeta getHtmlClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

isWhitespaceElement

protected boolean isWhitespaceElement(XmlReader r)

Description copied from class: XmlParserSession

Returns true if the current element is a whitespace element.

For the XML parser, this always returns false. However, the HTML parser defines various whitespace elements such as "br" and "sp".

Overrides:

isWhitespaceElement in class XmlParserSession

Parameters:

r - The XML stream reader to read the current event from.

Returns:

true if the current element is a whitespace element.

readText

protected String readText(XmlReader r)
                   throws IOException,
ParseException,
XMLStreamException

Parses CHARACTERS data.

Precondition: Pointing to event immediately following opening tag. Postcondition: Pointing to closing tag.

Overrides:

readText in class XmlParserSession

Parameters:

r - The stream being read from.

Returns:

The parsed string.

Throws:

XMLStreamException - Thrown by underlying XML stream.

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

readWhitespaceElement

protected String readWhitespaceElement(XmlReader r)
                                throws IOException,
ParseException,
XMLStreamException

Description copied from class: XmlParserSession

Parses the current whitespace element.

For the XML parser, this always returns null since there is no concept of a whitespace element. However, the HTML parser defines various whitespace elements such as "br" and "sp".

Overrides:

readWhitespaceElement in class XmlParserSession

Parameters:

r - The XML stream reader to read the current event from.

Returns:

The whitespace character or characters.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

XMLStreamException - Thrown by underlying reader.