org.apache.juneau.html

Class HtmlParserSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.parser.ParserSession

org.apache.juneau.parser.ReaderParserSession

org.apache.juneau.xml.XmlParserSession

org.apache.juneau.html.HtmlParserSession

public final class HtmlParserSession
extends XmlParserSession

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

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused against multiple inputs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HtmlParserSession(HtmlParser ctx, ParserSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
protected <T> T	doParse(ParserPipe pipe, ClassMeta<T> type) Workhorse method.
protected <E> Collection<E>	doParseIntoCollection(ParserPipe pipe, Collection<E> c, Type elementType) Implementation method.
protected <K,V> Map<K,V>	doParseIntoMap(ParserPipe pipe, Map<K,V> m, Type keyType, Type valueType) Implementation method.
protected String	getElementText(XmlReader r) Identical to parseText(XmlReader) except assumes the current event is the opening tag.
protected boolean	isWhitespaceElement(XmlReader r) Returns true if the current element is a whitespace element.
protected String	parseText(XmlReader r) Parses CHARACTERS data.
protected String	parseWhitespaceElement(XmlReader r) Parses the current whitespace element.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

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

decodeString, getEventAllocator, getReporter, getResolver, getXmlReader, isPreserveRootElement, isValidating, parseAnything

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

createPipe, getFileCharset, getStreamCharset, isReaderParser

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

cast, convertAttrToType, getClassMeta, getDebugOutputLines, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getOuter, getPosition, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, mark, onUnknownProperty, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, trim, trim, unmark, unswap

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlParserSession

protected HtmlParserSession(HtmlParser ctx,
                            ParserSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime session arguments.

Method Detail

doParse

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

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method.

Overrides:

doParse 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, ObjectMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

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

doParseIntoMap

protected <K,V> Map<K,V> doParseIntoMap(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:

doParseIntoMap in class XmlParserSession

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.

doParseIntoCollection

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

Description copied from class: ParserSession

Implementation method.

Default implementation throws an UnsupportedOperationException.

Overrides:

doParseIntoCollection in class XmlParserSession

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.

parseText

protected final String parseText(XmlReader r)
                          throws IOException,
                                 ParseException,
                                 XMLStreamException

Parses CHARACTERS data.

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

Overrides:

parseText 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.

getElementText

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

Identical to parseText(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.

isWhitespaceElement

protected final 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.

parseWhitespaceElement

protected final String parseWhitespaceElement(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:

parseWhitespaceElement 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.

toMap

public ObjectMap toMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class XmlParserSession

Returns:

A new map containing the properties defined on this context.