Package org.apache.juneau.html

Class HtmlParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.xml.XmlParser

org.apache.juneau.html.HtmlParser

All Implemented Interfaces:

AnnotationProvider, HtmlMetaProvider, XmlMetaProvider

public class HtmlParser
extends XmlParser
implements HtmlMetaProvider

Parses text generated by the HtmlSerializer class back into a POJO model.

Media types

Handles Content-Type types: text/html

Description

See the HtmlSerializer class for a description of the HTML generated.

This class is used primarily for automated testing of the HtmlSerializer class.

Notes:

• This class is thread safe and reusable.

See Also:

• HTML Basics

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.apache.juneau.parser.Parser

Parser.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final HtmlParser	DEFAULT	Default parser, all default settings.

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
HtmlParser(HtmlParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
HtmlParser.Builder	copy()	Creates a builder from this context object.
static HtmlParser.Builder	create()	Creates a new builder for this object.
HtmlParserSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
HtmlBeanPropertyMeta	getHtmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
HtmlClassMeta	getHtmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
HtmlParserSession	getSession()	Returns a session to use for this context.

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

getEventAllocator, getReporter, getResolver, getXmlBeanMeta, getXmlBeanPropertyMeta, getXmlClassMeta, isPreserveRootElement, isValidating, properties

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

getFileCharset, getStreamCharset, isReaderParser

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

canHandle, createParserBuilder, doParse, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, 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.AnnotationProvider

firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Field Details

DEFAULT

public static final HtmlParser DEFAULT

Default parser, all default settings.

Constructor Details

HtmlParser

public HtmlParser(HtmlParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static HtmlParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public HtmlParser.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class XmlParser

Returns:

A new Builder object.

createSession

public HtmlParserSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class XmlParser

Returns:

A new session builder.

getSession

public HtmlParserSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class XmlParser

Returns:

A new session object.

getHtmlClassMeta

public HtmlClassMeta getHtmlClassMeta(ClassMeta<?> cm)

Description copied from interface: HtmlMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getHtmlClassMeta in interface HtmlMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getHtmlBeanPropertyMeta

public HtmlBeanPropertyMeta getHtmlBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: HtmlMetaProvider

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

Specified by:

getHtmlBeanPropertyMeta in interface HtmlMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.