Module com.aoapps.html.servlet

Package com.aoapps.html.servlet

Class DocumentEE

java.lang.Object

com.aoapps.html.any.AnyDocument<DocumentEE>

com.aoapps.html.servlet.any.AnyDocumentEE<DocumentEE>

com.aoapps.html.servlet.DocumentEE

All Implemented Interfaces:

Encode, Text, Whitespace, AnyCOLGROUP_content<DocumentEE,DocumentEE>, AnyContent<DocumentEE,DocumentEE>, AnyDATALIST_content<DocumentEE,DocumentEE>, AnyDIV_content<DocumentEE,DocumentEE>, AnyDL_content<DocumentEE,DocumentEE>, AnyEmbeddedContent<DocumentEE,DocumentEE>, AnyFlowContent<DocumentEE,DocumentEE>, AnyHeadingContent<DocumentEE,DocumentEE>, AnyHTML_content<DocumentEE,DocumentEE>, AnyInteractiveContent<DocumentEE,DocumentEE>, AnyListContent<DocumentEE,DocumentEE>, AnyMetadataContent<DocumentEE,DocumentEE>, AnyOBJECT_content<DocumentEE,DocumentEE>, AnyOPTGROUP_content<DocumentEE,DocumentEE>, AnyPalpableContent<DocumentEE,DocumentEE>, AnyPhrasingContent<DocumentEE,DocumentEE>, AnyScriptSupportingContent<DocumentEE,DocumentEE>, AnySectioningContent<DocumentEE,DocumentEE>, AnySELECT_content<DocumentEE,DocumentEE>, AnyTABLE_content<DocumentEE,DocumentEE>, AnyTextContent<DocumentEE,DocumentEE>, AnyTR_content<DocumentEE,DocumentEE>, AnyUnion_COLGROUP_ScriptSupporting<DocumentEE,DocumentEE>, AnyUnion_DATALIST_OPTGROUP<DocumentEE,DocumentEE>, AnyUnion_DIV_DL<DocumentEE,DocumentEE>, AnyUnion_DL_Palpable<DocumentEE,DocumentEE>, AnyUnion_Embedded_Interactive<DocumentEE,DocumentEE>, AnyUnion_Embedded_Palpable_Phrasing<DocumentEE,DocumentEE>, AnyUnion_Interactive_Phrasing<DocumentEE,DocumentEE>, AnyUnion_Metadata_Phrasing<DocumentEE,DocumentEE>, AnyUnion_Palpable_Phrasing<DocumentEE,DocumentEE>, AnyUnion_TBODY_THEAD_TFOOT<DocumentEE,DocumentEE>, Content<DocumentEE,DocumentEE>, DocumentWriter, AnyContentEE<DocumentEE,DocumentEE>, ContentEE<DocumentEE,DocumentEE>, AnyContentEE<DocumentEE>, COLGROUP_content<DocumentEE>, ContentEE<DocumentEE>, DATALIST_content<DocumentEE>, DIV_content<DocumentEE>, DL_content<DocumentEE>, EmbeddedContent<DocumentEE>, FlowContent<DocumentEE>, HeadingContent<DocumentEE>, HTML_content<DocumentEE>, InteractiveContent<DocumentEE>, ListContent<DocumentEE>, MetadataContent<DocumentEE>, OBJECT_content<DocumentEE>, OPTGROUP_content<DocumentEE>, PalpableContent<DocumentEE>, PhrasingContent<DocumentEE>, ScriptSupportingContent<DocumentEE>, SectioningContent<DocumentEE>, SELECT_content<DocumentEE>, TABLE_content<DocumentEE>, TextContent<DocumentEE>, TR_content<DocumentEE>, Union_COLGROUP_ScriptSupporting<DocumentEE>, Union_DATALIST_OPTGROUP<DocumentEE>, Union_DIV_DL<DocumentEE>, Union_DL_Palpable<DocumentEE>, Union_Embedded_Interactive<DocumentEE>, Union_Embedded_Palpable_Phrasing<DocumentEE>, Union_Interactive_Phrasing<DocumentEE>, Union_Metadata_Phrasing<DocumentEE>, Union_Palpable_Phrasing<DocumentEE>, Union_TBODY_THEAD_TFOOT<DocumentEE>

public final class DocumentEE
extends AnyDocumentEE<DocumentEE>
implements AnyContentEE<DocumentEE>

Fluent Java DSL for high-performance HTML generation in a Servlet environment.

Author:

AO Industries, Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.aoapps.html.any.AnyUnion_Interactive_Phrasing

AnyUnion_Interactive_Phrasing.InputFactory<D extends AnyDocument<D>,__ extends AnyUnion_Interactive_Phrasing<D,__>>

Nested classes/interfaces inherited from interface com.aoapps.html.servlet.Union_Interactive_Phrasing

Union_Interactive_Phrasing.InputFactory<__ extends Union_Interactive_Phrasing<__>>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTONLI_INIT_PARAM	Context init parameter that may be used to configure the default document autonli within an application.
static final String	INDENT_INIT_PARAM	Context init parameter that may be used to configure the default document indent within an application.

Fields inherited from class com.aoapps.html.any.AnyDocument

ENCODING, encodingContext

Fields inherited from interface com.aoapps.encoding.Text

NBSP

Fields inherited from interface com.aoapps.encoding.Whitespace

INDENT_SPACES, NL, SPACE

Constructor Summary

Constructors

Constructor	Description
DocumentEE(HttpServletRequest request, HttpServletResponse response)	Uses the current or default autonli settings and current or default indentation settings.
DocumentEE(HttpServletRequest request, HttpServletResponse response, boolean autonli, boolean indent)
DocumentEE(HttpServletRequest request, HttpServletResponse response, Writer out)	Uses the current or default autonli settings and current or default indentation settings.
DocumentEE(HttpServletRequest request, HttpServletResponse response, Writer out, boolean autonli, boolean indent)
DocumentEE(HttpServletResponse response, EncodingContextEE encodingContext, Writer out, boolean autonli, boolean indent)
DocumentEE(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response)	Uses the current or default autonli settings and current or default indentation settings.
DocumentEE(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, boolean autonli, boolean indent)
DocumentEE(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, Writer out)	Uses the current or default autonli settings and current or default indentation settings.
DocumentEE(ServletContext servletContext, HttpServletRequest request, HttpServletResponse response, Writer out, boolean autonli, boolean indent)

Method Summary

Modifier and Type	Method	Description
static boolean	getAutonli(ServletContext servletContext, ServletRequest request)	Gets the document autonli in effect for the request, or the default when not yet set.
static boolean	getDefaultAutonli(ServletContext servletContext)	Determines the default document autonli by first checking for context-param of AUTONLI_INIT_PARAM, then using false when unspecified or "auto".
static boolean	getDefaultIndent(ServletContext servletContext)	Determines the default document indent by first checking for context-param of INDENT_INIT_PARAM, then using false when unspecified or "auto".
static boolean	getIndent(ServletContext servletContext, ServletRequest request)	Gets the document indent in effect for the request, or the default when not yet set.
static Boolean	replaceAutonli(ServletRequest request, Boolean autonli)	Replaces the document autonli in effect for the request.
static Boolean	replaceIndent(ServletRequest request, Boolean indent)	Replaces the document indent in effect for the request.
static void	setAutonli(ServletRequest request, Boolean autonli)	Registers the document autonli in effect for the request.
static void	setIndent(ServletRequest request, Boolean indent)	Registers the document indent in effect for the request.

Methods inherited from class com.aoapps.html.any.AnyDocument

autoIndent, autoIndent, autoNl, autoNli, autoNli, clearAtnl, decDepth, doctype, encode, encode, encode, encode, encode, encode, encode, encode, encode, getAtnl, getAutonli, getDepth, getDocument, getIndent, getRawUnsafe, getRawUnsafe, incDepth, indent, indent, nbsp, nbsp, nl, nli, nli, setAtnl, setAtnl, setAutonli, setDepth, setIndent, setOut, sp, sp, text, text, text, text, text, text, text, text, text, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, xmlDeclaration

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoapps.html.any.AnyContent

figcaption, html__, html__, html__any, legend, rp, rt, source, summary, tr__, tr__, tr__any, track

Methods inherited from interface com.aoapps.html.servlet.AnyContentEE

html, html__, html_c, tr, tr__, tr_c

Methods inherited from interface com.aoapps.html.any.AnyEmbeddedContent

picture

Methods inherited from interface com.aoapps.html.any.AnyFlowContent

dialog, hr__

Methods inherited from interface com.aoapps.html.any.AnyHeadingContent

h, h__, h__, h__, h__, h_c, h1__, h1__, h1__, h1__any, h2__, h2__, h2__, h2__any, h3__, h3__, h3__, h3__any, h4__, h4__, h4__, h4__any, h5__, h5__, h5__, h5__any, h6__, h6__, h6__, h6__any, hgroup

Methods inherited from interface com.aoapps.html.any.AnyHTML_content

body__, body__, body__any, head__, head__, head__any

Methods inherited from interface com.aoapps.html.any.AnyInteractiveContent

details, menu__, menu__, menu__any

Methods inherited from interface com.aoapps.html.any.AnyListContent

li__, li__, li__, li__any

Methods inherited from interface com.aoapps.html.any.AnyMetadataContent

base__, title__, title__, title__any

Methods inherited from interface com.aoapps.html.any.AnyOBJECT_content

param__

Methods inherited from interface com.aoapps.html.any.AnyPalpableContent

address__, address__, address__, address__any, blockquote__, blockquote__, blockquote__, blockquote__any, dl__, dl__, dl__any, fieldset, figure, footer__, footer__, footer__, footer__any, form__, form__, form__, form__any, header__, header__, header__, header__any, main__, main__, main__, main__any, ol__, ol__, ol__any, p__, p__, p__, p__any, pre__, pre__, pre__, pre__any, table__, table__, table__any, ul__, ul__, ul__any

Methods inherited from interface com.aoapps.html.any.AnyPhrasingContent

br__, datalist__, datalist__, datalist__, datalist__any, del__, del__, del__, slot, wbr__

Methods inherited from interface com.aoapps.html.any.AnySectioningContent

article__, article__, article__, article__any, aside__, aside__, aside__, aside__any, nav__, nav__, nav__, nav__any, section__, section__, section__, section__any

Methods inherited from interface com.aoapps.html.any.AnySELECT_content

optgroup__, optgroup__, optgroup__any

Methods inherited from interface com.aoapps.html.any.AnyTABLE_content

caption__, caption__, caption__, caption__any, colgroup__, colgroup__, colgroup__any, tbody__, tbody__, tbody__any, tfoot__, tfoot__, tfoot__any, thead__, thead__, thead__any

Methods inherited from interface com.aoapps.html.any.AnyTextContent

decDepth, encode, encode, encode, encode, encode, encode, encode, encode, encode, incDepth, indent, indent, nbsp, nbsp, nl, nli, nli, setDepth, setIndent, sp, sp, text, text, text, text, text, text, text, text, text

Methods inherited from interface com.aoapps.html.any.AnyTR_content

td__, td__, td__, td__any, th__, th__, th__, th__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_COLGROUP_ScriptSupporting

template

Methods inherited from interface com.aoapps.html.any.AnyUnion_DATALIST_OPTGROUP

option__, option__, option__, option__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_DIV_DL

dd__, dd__, dd__, dd__any, dt__, dt__, dt__, dt__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_DL_Palpable

div__, div__, div__, div__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_Embedded_Interactive

audio, embed, iframe, object__, object__, object__any, video

Methods inherited from interface com.aoapps.html.any.AnyUnion_Embedded_Palpable_Phrasing

canvas

Methods inherited from interface com.aoapps.html.any.AnyUnion_Interactive_Phrasing

a__, a__, a__, a__, button, label__, label__, label__, label__any, select__, select__, select__any, textarea__, textarea__, textarea__, textarea__any

Methods inherited from interface com.aoapps.html.any.AnyUnion_Metadata_Phrasing

noscript

Methods inherited from interface com.aoapps.html.any.AnyUnion_Palpable_Phrasing

abbr__, abbr__, abbr__, abbr__any, b__, b__, b__, b__any, bdi__, bdi__, bdi__, bdi__any, bdo__, bdo__, bdo__, bdo__any, cite__, cite__, cite__, cite__any, code__, code__, code__, code__any, data__, data__, data__, data__any, dfn__, dfn__, dfn__, dfn__any, em__, em__, em__, em__any, i__, i__, i__, i__any, ins__, ins__, ins__, ins__, kbd__, kbd__, kbd__, kbd__any, map__, map__, map__, map__, mark__, mark__, mark__, mark__any, meter__, meter__, meter__, meter__any, output__, output__, output__, output__any, progress__, progress__, progress__, progress__any, q__, q__, q__, q__any, ruby, s__, s__, s__, s__any, samp__, samp__, samp__, samp__any, small__, small__, small__, small__any, span__, span__, span__, span__any, strong__, strong__, strong__, strong__any, sub__, sub__, sub__, sub__any, sup__, sup__, sup__, sup__any, time, u__, u__, u__, u__any, var__, var__, var__, var__any

Methods inherited from interface com.aoapps.html.servlet.COLGROUP_content

col

Methods inherited from interface com.aoapps.html.any.Content

autoIndent, autoIndent, autoNl, autoNli, autoNli, clearAtnl, getAtnl, getAutonli, getDepth, getDocument, getIndent, getRawUnsafe, getRawUnsafe, setAtnl, setAtnl, setAutonli, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe, unsafe

Methods inherited from interface com.aoapps.html.servlet.FlowContent

hr

Methods inherited from interface com.aoapps.html.servlet.HeadingContent

h1, h1__, h1_c, h2, h2__, h2_c, h3, h3__, h3_c, h4, h4__, h4_c, h5, h5__, h5_c, h6, h6__, h6_c

Methods inherited from interface com.aoapps.html.servlet.HTML_content

body, body__, body_c, head, head__, head_c

Methods inherited from interface com.aoapps.html.servlet.InteractiveContent

menu, menu__, menu_c

Methods inherited from interface com.aoapps.html.servlet.ListContent

li, li__, li_c

Methods inherited from interface com.aoapps.html.servlet.MetadataContent

base, style, style, style, style, style, title, title__, title_c

Methods inherited from interface com.aoapps.html.servlet.OBJECT_content

param

Methods inherited from interface com.aoapps.html.servlet.PalpableContent

address, address__, address_c, blockquote, blockquote__, blockquote_c, dl, dl__, dl_c, footer, footer__, footer_c, form, form, form, form__, form_c, header, header__, header_c, main, main__, main_c, ol, ol__, ol_c, p, p__, p_c, pre, pre__, pre_c, table, table__, table_c, ul, ul__, ul_c

Methods inherited from interface com.aoapps.html.servlet.PhrasingContent

area, area, area, area, area, area, area, area, area, br, datalist, datalist__, datalist_c, del, del_c, wbr

Methods inherited from interface com.aoapps.html.servlet.ScriptSupportingContent

script, script, script, script, script

Methods inherited from interface com.aoapps.html.servlet.SectioningContent

article, article__, article_c, aside, aside__, aside_c, nav, nav__, nav_c, section, section__, section_c

Methods inherited from interface com.aoapps.html.servlet.SELECT_content

optgroup, optgroup__, optgroup_c

Methods inherited from interface com.aoapps.html.servlet.TABLE_content

caption, caption__, caption_c, colgroup, colgroup__, colgroup_c, tbody, tbody__, tbody_c, tfoot, tfoot__, tfoot_c, thead, thead__, thead_c

Methods inherited from interface com.aoapps.html.servlet.TR_content

td, td__, td_c, th, th__, th_c

Methods inherited from interface com.aoapps.html.servlet.Union_DATALIST_OPTGROUP

option, option__, option_c

Methods inherited from interface com.aoapps.html.servlet.Union_DIV_DL

dd, dd__, dd_c, dt, dt__, dt_c

Methods inherited from interface com.aoapps.html.servlet.Union_DL_Palpable

div, div__, div_c

Methods inherited from interface com.aoapps.html.servlet.Union_Embedded_Interactive

img, img, img, object, object__, object_c

Methods inherited from interface com.aoapps.html.servlet.Union_Interactive_Phrasing

a, a, a, a_c, input, label, label__, label_c, select, select__, select_c, textarea, textarea__, textarea_c

Methods inherited from interface com.aoapps.html.servlet.Union_Metadata_Phrasing

link, link, meta

Methods inherited from interface com.aoapps.html.servlet.Union_Palpable_Phrasing

abbr, abbr__, abbr_c, b, b__, b_c, bdi, bdi__, bdi_c, bdo, bdo, bdo, bdo, bdo, bdo__, bdo_c, cite, cite__, cite_c, code, code__, code_c, data, data, data, data__, data_c, dfn, dfn__, dfn_c, em, em__, em_c, i, i__, i_c, ins, ins_c, kbd, kbd__, kbd_c, map, map, map, map_c, mark, mark__, mark_c, meter, meter__, meter_c, output, output__, output_c, progress, progress__, progress_c, q, q__, q_c, s, s__, s_c, samp, samp__, samp_c, small, small__, small_c, span, span__, span_c, strong, strong__, strong_c, sub, sub__, sub_c, sup, sup__, sup_c, u, u__, u_c, var, var__, var_c

Field Details

AUTONLI_INIT_PARAM

public static final String AUTONLI_INIT_PARAM

Context init parameter that may be used to configure the default document autonli within an application. Must be one of "true", "false", or "auto" (the default).

INDENT_INIT_PARAM

public static final String INDENT_INIT_PARAM

Context init parameter that may be used to configure the default document indent within an application. Must be one of "true", "false", or "auto" (the default).

Constructor Details

DocumentEE

public DocumentEE(HttpServletResponse response,
 EncodingContextEE encodingContext,
 Writer out,
 boolean autonli,
 boolean indent)

Parameters:

out - Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

DocumentEE

public DocumentEE(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 Writer out,
 boolean autonli,
 boolean indent)

Parameters:

out - Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

DocumentEE

public DocumentEE(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 Writer out)

Uses the current or default autonli settings and current or default indentation settings.

Parameters:

out - Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

See Also:

• getAutonli(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• getIndent(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• DocumentEE(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.io.Writer, boolean, boolean)

DocumentEE

public DocumentEE(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response,
 boolean autonli,
 boolean indent)
           throws IOException

Throws:

IOException

See Also:

• ServletResponse.getWriter()

DocumentEE

public DocumentEE(ServletContext servletContext,
 HttpServletRequest request,
 HttpServletResponse response)
           throws IOException

Uses the current or default autonli settings and current or default indentation settings.

Throws:

IOException

See Also:

• getAutonli(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• getIndent(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• DocumentEE(javax.servlet.ServletContext, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, boolean, boolean)

DocumentEE

public DocumentEE(HttpServletRequest request,
 HttpServletResponse response,
 Writer out,
 boolean autonli,
 boolean indent)

Parameters:

out - Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

DocumentEE

public DocumentEE(HttpServletRequest request,
 HttpServletResponse response,
 Writer out)

Uses the current or default autonli settings and current or default indentation settings.

Parameters:

out - Will be through Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

See Also:

• getAutonli(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• getIndent(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• DocumentEE(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.io.Writer, boolean, boolean)

DocumentEE

public DocumentEE(HttpServletRequest request,
 HttpServletResponse response,
 boolean autonli,
 boolean indent)
           throws IOException

Throws:

IOException

See Also:

• ServletRequest.getServletContext()
• ServletResponse.getWriter()

DocumentEE

public DocumentEE(HttpServletRequest request,
 HttpServletResponse response)
           throws IOException

Uses the current or default autonli settings and current or default indentation settings.

Throws:

IOException

See Also:

• getAutonli(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• getIndent(javax.servlet.ServletContext, javax.servlet.ServletRequest)
• DocumentEE(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, boolean, boolean)

Method Details

getDefaultAutonli

public static boolean getDefaultAutonli(ServletContext servletContext)

Determines the default document autonli by first checking for context-param of AUTONLI_INIT_PARAM, then using false when unspecified or "auto".

setAutonli

public static void setAutonli(ServletRequest request,
 Boolean autonli)

Registers the document autonli in effect for the request.

This does not change existing instances of DocumentEE; it only affects the configuration of new instances.

replaceAutonli

public static Boolean replaceAutonli(ServletRequest request,
 Boolean autonli)

Replaces the document autonli in effect for the request.

This does not change existing instances of DocumentEE; it only affects the configuration of new instances.

Returns:

The previous attribute value, if any

getAutonli

public static boolean getAutonli(ServletContext servletContext,
 ServletRequest request)

Gets the document autonli in effect for the request, or the default when not yet set.

Once the default is resolved, sets the request attribute.

This does not change existing instances of DocumentEE; it only affects the configuration of new instances.

getDefaultIndent

public static boolean getDefaultIndent(ServletContext servletContext)

Determines the default document indent by first checking for context-param of INDENT_INIT_PARAM, then using false when unspecified or "auto".

setIndent

public static void setIndent(ServletRequest request,
 Boolean indent)

Registers the document indent in effect for the request.

This does not change existing instances of DocumentEE; it only affects the configuration of new instances.

replaceIndent

public static Boolean replaceIndent(ServletRequest request,
 Boolean indent)

Replaces the document indent in effect for the request.

This does not change existing instances of DocumentEE; it only affects the configuration of new instances.

Returns:

The previous attribute value, if any

getIndent

public static boolean getIndent(ServletContext servletContext,
 ServletRequest request)

Gets the document indent in effect for the request, or the default when not yet set.

Once the default is resolved, sets the request attribute.

This does not change existing instances of DocumentEE; it only affects the configuration of new instances.