Module com.aoapps.html.any

Package com.aoapps.html.any

Interface DocumentWriter

All Superinterfaces:

Whitespace

All Known Subinterfaces:

AnyCOLGROUP_content<D,__>, AnyContent<D,__>, AnyDATALIST_content<D,__>, AnyDIV_content<D,__>, AnyDL_content<D,__>, AnyEmbeddedContent<D,__>, AnyFlowContent<D,__>, AnyHeadingContent<D,__>, AnyHTML_content<D,__>, AnyInteractiveContent<D,__>, AnyListContent<D,__>, AnyMetadataContent<D,__>, AnyOBJECT_content<D,__>, AnyOPTGROUP_content<D,__>, AnyPalpableContent<D,__>, AnyPhrasingContent<D,__>, AnyScriptSupportingContent<D,__>, AnySectioningContent<D,__>, AnySELECT_content<D,__>, AnyTABLE_content<D,__>, AnyTextContent<D,__>, AnyTR_content<D,__>, AnyUnion_COLGROUP_ScriptSupporting<D,__>, AnyUnion_DATALIST_OPTGROUP<D,__>, AnyUnion_DIV_DL<D,__>, AnyUnion_DL_Palpable<D,__>, AnyUnion_Embedded_Interactive<D,__>, AnyUnion_Embedded_Palpable_Phrasing<D,__>, AnyUnion_Interactive_Phrasing<D,__>, AnyUnion_Metadata_Phrasing<D,__>, AnyUnion_Palpable_Phrasing<D,__>, AnyUnion_TBODY_THEAD_TFOOT<D,__>, Content<D,__>

All Known Implementing Classes:

AnyA, AnyA_c, AnyABBR, AnyABBR__, AnyABBR_c, AnyADDRESS, AnyADDRESS__, AnyADDRESS_c, AnyAREA, AnyARTICLE, AnyARTICLE__, AnyARTICLE_c, AnyASIDE, AnyASIDE__, AnyASIDE_c, AnyB, AnyB__, AnyB_c, AnyBASE, AnyBDI, AnyBDI__, AnyBDI_c, AnyBDO, AnyBDO__, AnyBDO_c, AnyBLOCKQUOTE, AnyBLOCKQUOTE__, AnyBLOCKQUOTE_c, AnyBODY, AnyBODY__, AnyBODY_c, AnyBR, AnyCAPTION, AnyCAPTION__, AnyCAPTION_c, AnyCITE, AnyCITE__, AnyCITE_c, AnyCODE, AnyCODE__, AnyCODE_c, AnyCOL, AnyCOLGROUP, AnyCOLGROUP__, AnyCOLGROUP_c, AnyDATA, AnyDATA__, AnyDATA_c, AnyDATALIST, AnyDATALIST__, AnyDATALIST_c, AnyDD, AnyDD__, AnyDD_c, AnyDEL, AnyDEL_c, AnyDFN, AnyDFN__, AnyDFN_c, AnyDIV, AnyDIV__, AnyDIV_c, AnyDL, AnyDL__, AnyDL_c, AnyDocument, AnyDT, AnyDT__, AnyDT_c, AnyEM, AnyEM__, AnyEM_c, AnyFOOTER, AnyFOOTER__, AnyFOOTER_c, AnyFORM, AnyFORM__, AnyFORM_c, AnyH, AnyH__, AnyH_c, AnyH1, AnyH1__, AnyH1_c, AnyH2, AnyH2__, AnyH2_c, AnyH3, AnyH3__, AnyH3_c, AnyH4, AnyH4__, AnyH4_c, AnyH5, AnyH5__, AnyH5_c, AnyH6, AnyH6__, AnyH6_c, AnyHEAD, AnyHEAD__, AnyHEAD_c, AnyHEADER, AnyHEADER__, AnyHEADER_c, AnyHR, AnyHTML, AnyHTML__, AnyHTML_c, AnyI, AnyI__, AnyI_c, AnyIMG, AnyINPUT, AnyINPUT.Button, AnyINPUT.Checkbox, AnyINPUT.Color, AnyINPUT.Date, AnyINPUT.DatetimeLocal, AnyINPUT.Dynamic, AnyINPUT.Email, AnyINPUT.File, AnyINPUT.Hidden, AnyINPUT.Image, AnyINPUT.Month, AnyINPUT.Number, AnyINPUT.Password, AnyINPUT.Radio, AnyINPUT.Range, AnyINPUT.Reset, AnyINPUT.Search, AnyINPUT.Submit, AnyINPUT.Tel, AnyINPUT.Text, AnyINPUT.Time, AnyINPUT.Url, AnyINPUT.Week, AnyINS, AnyINS_c, AnyKBD, AnyKBD__, AnyKBD_c, AnyLABEL, AnyLABEL__, AnyLABEL_c, AnyLI, AnyLI__, AnyLI_c, AnyLINK, AnyMAIN, AnyMAIN__, AnyMAIN_c, AnyMAP, AnyMAP_c, AnyMARK, AnyMARK__, AnyMARK_c, AnyMENU, AnyMENU__, AnyMENU_c, AnyMETA, AnyMETER, AnyMETER__, AnyMETER_c, AnyNAV, AnyNAV__, AnyNAV_c, AnyOBJECT, AnyOBJECT__, AnyOBJECT_c, AnyOL, AnyOL__, AnyOL_c, AnyOPTGROUP, AnyOPTGROUP__, AnyOPTGROUP_c, AnyOPTION, AnyOPTION__, AnyOPTION_c, AnyOUTPUT, AnyOUTPUT__, AnyOUTPUT_c, AnyP, AnyP__, AnyP_c, AnyPARAM, AnyPRE, AnyPRE__, AnyPRE_c, AnyPROGRESS, AnyPROGRESS__, AnyPROGRESS_c, AnyQ, AnyQ__, AnyQ_c, AnyS, AnyS__, AnyS_c, AnySAMP, AnySAMP__, AnySAMP_c, AnySCRIPT, AnySECTION, AnySECTION__, AnySECTION_c, AnySELECT, AnySELECT__, AnySELECT_c, AnySMALL, AnySMALL__, AnySMALL_c, AnySPAN, AnySPAN__, AnySPAN_c, AnySTRONG, AnySTRONG__, AnySTRONG_c, AnySTYLE, AnySUB, AnySUB__, AnySUB_c, AnySUP, AnySUP__, AnySUP_c, AnyTABLE, AnyTABLE__, AnyTABLE_c, AnyTBODY, AnyTBODY__, AnyTBODY_c, AnyTD, AnyTD__, AnyTD_c, AnyTEXTAREA, AnyTEXTAREA__, AnyTEXTAREA_c, AnyTFOOT, AnyTFOOT__, AnyTFOOT_c, AnyTH, AnyTH__, AnyTH_c, AnyTHEAD, AnyTHEAD__, AnyTHEAD_c, AnyTITLE, AnyTITLE__, AnyTITLE_c, AnyTR, AnyTR__, AnyTR_c, AnyU, AnyU__, AnyU_c, AnyUL, AnyUL__, AnyUL_c, AnyVAR, AnyVAR__, AnyVAR_c, AnyWBR, Element, Normal, Normal__, Normal_c, NormalText, NormalText__, NormalText_c, Transparent, Transparent_c, TransparentText, TransparentText_c, Void

public interface DocumentWriter
extends Whitespace

Allows writing raw document output.

Author:

AO Industries, Inc.

Field Summary

Fields inherited from interface com.aoapps.encoding.Whitespace

INDENT_SPACES, NL, SPACE

Method Summary

Modifier and Type	Method	Description
DocumentWriter	autoIndent()	Performs automatic indentation when getAutonli(), Whitespace.getIndent(), and getAtnl().
DocumentWriter	autoIndent(int depthOffset)	Performs automatic indentation with a depth offset when getAutonli(), Whitespace.getIndent(), and getAtnl().
DocumentWriter	autoNl()	Performs automatic newline when getAutonli() and not getAtnl().
DocumentWriter	autoNli()	Performs automatic newline when getAutonli() and not getAtnl(), followed by automatic indentation when enabled.
DocumentWriter	autoNli(int depthOffset)	Performs automatic newline when getAutonli() and not getAtnl(), followed by automatic indentation with a depth offset when enabled.
DocumentWriter	clearAtnl()	Clears the at newline flag.
DocumentWriter	decDepth()
boolean	getAtnl()	Gets the at newline flag.
boolean	getAutonli()	Gets if automatic newline (and indentation when enabled) is currently enabled, off by default.
Writer	getRawUnsafe()	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
Writer	getRawUnsafe(Boolean endsNewline)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	incDepth()
default DocumentWriter	indent()
default DocumentWriter	indent(int depthOffset)
DocumentWriter	nl()
default DocumentWriter	nli()
default DocumentWriter	nli(int depthOffset)
DocumentWriter	setAtnl()	Flags is at a newline.
DocumentWriter	setAtnl(boolean atnl)	Sets the at newline flag.
DocumentWriter	setAutonli(boolean autonli)	Enables or disabled automatic newline (and indentation when enabled).
DocumentWriter	setDepth(int depth)
DocumentWriter	setIndent(boolean indent)
default DocumentWriter	sp()
DocumentWriter	sp(int count)
<W extends Writer & NoClose> W	unsafe()	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(char ch)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(char[] cbuf)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(char[] cbuf, int offset, int len)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
<Ex extends Throwable> DocumentWriter	unsafe(IOSupplierE<?,Ex> unsafe)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(Writable unsafe)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(CharSequence csq)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(CharSequence csq, int start, int end)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous
DocumentWriter	unsafe(Object unsafe)	Deprecated. This method will remain, but its use is discouraged as it can be dangerous

Methods inherited from interface com.aoapps.encoding.Whitespace

getDepth, getIndent

Method Details

nl

DocumentWriter nl()
           throws IOException

Specified by:

nl in interface Whitespace

Throws:

IOException

nli

default DocumentWriter nli()
                    throws IOException

Specified by:

nli in interface Whitespace

Throws:

IOException

nli

default DocumentWriter nli(int depthOffset)
                    throws IOException

Specified by:

nli in interface Whitespace

Throws:

IOException

indent

default DocumentWriter indent()
                       throws IOException

Specified by:

indent in interface Whitespace

Throws:

IOException

indent

default DocumentWriter indent(int depthOffset)
                       throws IOException

Specified by:

indent in interface Whitespace

Throws:

IOException

setIndent

DocumentWriter setIndent(boolean indent)

Specified by:

setIndent in interface Whitespace

setDepth

DocumentWriter setDepth(int depth)

Specified by:

setDepth in interface Whitespace

incDepth

DocumentWriter incDepth()

Specified by:

incDepth in interface Whitespace

decDepth

DocumentWriter decDepth()

Specified by:

decDepth in interface Whitespace

sp

default DocumentWriter sp()
                   throws IOException

Specified by:

sp in interface Whitespace

Throws:

IOException

sp

DocumentWriter sp(int count)
           throws IOException

Specified by:

sp in interface Whitespace

Throws:

IOException

getRawUnsafe

@Deprecated(forRemoval=false)
Writer getRawUnsafe(Boolean endsNewline)
             throws IllegalStateException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Gets the current writer this document is writing to, which may be used for raw output.

Please prefer unsafe(), which is compatible with try-with-resources blocks. The writer returned here is the real, underlying writer.

Parameters:

endsNewline - Indicates whether the data that will be written will end in a Whitespace.NL. When non-null, will call setAtnl(boolean) with the given value.

Returns:

The writer, already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

Throws:

IllegalStateException - when output has been set to null.

See Also:

• getRawUnsafe()
• AnyDocument.setOut(java.io.Writer)

getRawUnsafe

@Deprecated(forRemoval=false)
Writer getRawUnsafe()
             throws IllegalStateException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Gets the current writer this document is writing to, which may be used for raw output.

Please prefer unsafe(), which is compatible with try-with-resources blocks. The writer returned here is the real, underlying writer.

With no knowledge of what will be written, calls clearAtnl() to be safe.

Returns:

The writer, already optimized via Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder) with encoder = null.

Throws:

IllegalStateException - when output has been set to null.

See Also:

• getRawUnsafe(java.lang.Boolean)
• AnyDocument.setOut(java.io.Writer)

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(char ch)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output of a single character, automatically determining setAtnl(boolean).

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(char[] cbuf)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output, automatically determining setAtnl(boolean).

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(char[] cbuf,
 int offset,
 int len)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output, automatically determining setAtnl(boolean).

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(CharSequence csq)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output, automatically determining setAtnl(boolean).

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(CharSequence csq,
 int start,
 int end)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output, automatically determining setAtnl(boolean).

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(Object unsafe)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output, automatically determining setAtnl(boolean).

When no knowledge of what will be written, calls clearAtnl() to be safe.

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
<Ex extends Throwable> DocumentWriter unsafe(IOSupplierE<?,Ex> unsafe)
                                      throws IOException,
Ex

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output, automatically determining setAtnl(boolean).

When no knowledge of what will be written, calls clearAtnl() to be safe.

Type Parameters:

Ex - An arbitrary exception type that may be thrown

Returns:

this writer

Throws:

IOException

Ex

unsafe

@Deprecated(forRemoval=false)
DocumentWriter unsafe(Writable unsafe)
               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output.

With no knowledge of what will be written, calls clearAtnl() to be safe.

Returns:

this writer

Throws:

IOException

unsafe

@Deprecated(forRemoval=false)
<W extends Writer & NoClose> W unsafe()
                               throws IOException

Deprecated.

This method will remain, but its use is discouraged as it can be dangerous

Performs raw output. This is well suited for use in a try-with-resources block.

With no knowledge of what will be written, calls clearAtnl() to be safe.

Returns:

a writer for direct output, which will ignore any calls to Writer.close() to be safely used in a try-with-resources block.

Throws:

IOException

getAutonli

boolean getAutonli()

Gets if automatic newline (and indentation when enabled) is currently enabled, off by default.

setAutonli

DocumentWriter setAutonli(boolean autonli)

Enables or disabled automatic newline (and indentation when enabled).

Returns:

this writer

getAtnl

boolean getAtnl()

Gets the at newline flag.

setAtnl

DocumentWriter setAtnl()

Flags is at a newline.

Returns:

this writer

setAtnl

DocumentWriter setAtnl(boolean atnl)

Sets the at newline flag.

Returns:

this writer

clearAtnl

DocumentWriter clearAtnl()

Clears the at newline flag.

Returns:

this writer

autoNl

DocumentWriter autoNl()
               throws IOException

Performs automatic newline when getAutonli() and not getAtnl().

Returns:

this writer

Throws:

IOException

autoNli

DocumentWriter autoNli()
                throws IOException

Performs automatic newline when getAutonli() and not getAtnl(), followed by automatic indentation when enabled.

Returns:

this writer

Throws:

IOException

autoNli

DocumentWriter autoNli(int depthOffset)
                throws IOException

Performs automatic newline when getAutonli() and not getAtnl(), followed by automatic indentation with a depth offset when enabled.

Parameters:

depthOffset - A value added to the current indentation depth. For example, pass -1 when performing a newline before a closing tag or ending curly brace.

Returns:

this writer

Throws:

IOException

autoIndent

DocumentWriter autoIndent()
                   throws IOException

Performs automatic indentation when getAutonli(), Whitespace.getIndent(), and getAtnl().

Returns:

this writer

Throws:

IOException

autoIndent

DocumentWriter autoIndent(int depthOffset)
                   throws IOException

Performs automatic indentation with a depth offset when getAutonli(), Whitespace.getIndent(), and getAtnl().

Parameters:

depthOffset - A value added to the current indentation depth. For example, pass -1 when performing a newline before a closing tag or ending curly brace.

Returns:

this writer

Throws:

IOException