Interface Content<D extends AnyDocument<D>,__ extends Content<D,__>>
- Type Parameters:
D
- This document type__
- This content model, which will be the parent content model of child elements
- All Superinterfaces:
DocumentWriter
,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,
__>
- All Known Implementing Classes:
AnyA_c
,AnyABBR__
,AnyABBR_c
,AnyADDRESS__
,AnyADDRESS_c
,AnyARTICLE__
,AnyARTICLE_c
,AnyASIDE__
,AnyASIDE_c
,AnyB__
,AnyB_c
,AnyBDI__
,AnyBDI_c
,AnyBDO__
,AnyBDO_c
,AnyBLOCKQUOTE__
,AnyBLOCKQUOTE_c
,AnyBODY__
,AnyBODY_c
,AnyCAPTION__
,AnyCAPTION_c
,AnyCITE__
,AnyCITE_c
,AnyCODE__
,AnyCODE_c
,AnyCOLGROUP__
,AnyCOLGROUP_c
,AnyDATA__
,AnyDATA_c
,AnyDATALIST__
,AnyDATALIST_c
,AnyDD__
,AnyDD_c
,AnyDEL_c
,AnyDFN__
,AnyDFN_c
,AnyDIV__
,AnyDIV_c
,AnyDL__
,AnyDL_c
,AnyDocument
,AnyDT__
,AnyDT_c
,AnyEM__
,AnyEM_c
,AnyFOOTER__
,AnyFOOTER_c
,AnyFORM__
,AnyFORM_c
,AnyH__
,AnyH_c
,AnyH1__
,AnyH1_c
,AnyH2__
,AnyH2_c
,AnyH3__
,AnyH3_c
,AnyH4__
,AnyH4_c
,AnyH5__
,AnyH5_c
,AnyH6__
,AnyH6_c
,AnyHEAD__
,AnyHEAD_c
,AnyHEADER__
,AnyHEADER_c
,AnyHTML__
,AnyHTML_c
,AnyI__
,AnyI_c
,AnyINS_c
,AnyKBD__
,AnyKBD_c
,AnyLABEL__
,AnyLABEL_c
,AnyLI__
,AnyLI_c
,AnyMAIN__
,AnyMAIN_c
,AnyMAP_c
,AnyMARK__
,AnyMARK_c
,AnyMENU__
,AnyMENU_c
,AnyMETER__
,AnyMETER_c
,AnyNAV__
,AnyNAV_c
,AnyOBJECT__
,AnyOBJECT_c
,AnyOL__
,AnyOL_c
,AnyOPTGROUP__
,AnyOPTGROUP_c
,AnyOPTION__
,AnyOPTION_c
,AnyOUTPUT__
,AnyOUTPUT_c
,AnyP__
,AnyP_c
,AnyPRE__
,AnyPRE_c
,AnyPROGRESS__
,AnyPROGRESS_c
,AnyQ__
,AnyQ_c
,AnyS__
,AnyS_c
,AnySAMP__
,AnySAMP_c
,AnySECTION__
,AnySECTION_c
,AnySELECT__
,AnySELECT_c
,AnySMALL__
,AnySMALL_c
,AnySPAN__
,AnySPAN_c
,AnySTRONG__
,AnySTRONG_c
,AnySUB__
,AnySUB_c
,AnySUP__
,AnySUP_c
,AnyTABLE__
,AnyTABLE_c
,AnyTBODY__
,AnyTBODY_c
,AnyTD__
,AnyTD_c
,AnyTEXTAREA__
,AnyTEXTAREA_c
,AnyTFOOT__
,AnyTFOOT_c
,AnyTH__
,AnyTH_c
,AnyTHEAD__
,AnyTHEAD_c
,AnyTITLE__
,AnyTITLE_c
,AnyTR__
,AnyTR_c
,AnyU__
,AnyU_c
,AnyUL__
,AnyUL_c
,AnyVAR__
,AnyVAR_c
,Normal__
,Normal_c
,NormalText__
,NormalText_c
,Transparent_c
,TransparentText_c
- Author:
- AO Industries, Inc.
-
Field Summary
Fields inherited from interface com.aoapps.encoding.Whitespace
INDENT_SPACES, NL, SPACE
-
Method Summary
Modifier and TypeMethodDescriptiondefault __
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
autoIndent
(int depthOffset) Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
autoNl()
Performs automatic newline whenDocumentWriter.getAutonli()
and notDocumentWriter.getAtnl()
.default __
autoNli()
Performs automatic newline whenDocumentWriter.getAutonli()
and notDocumentWriter.getAtnl()
, followed by automatic indentation when enabled.default __
autoNli
(int depthOffset) Performs automatic newline whenDocumentWriter.getAutonli()
and notDocumentWriter.getAtnl()
, followed by automatic indentation with a depth offset when enabled.default __
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
decDepth()
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default boolean
getAtnl()
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default boolean
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default int
getDepth()
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Gets the document for the current content model.default boolean
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default Writer
Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault Writer
getRawUnsafe
(Boolean endsNewline) Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
incDepth()
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
indent()
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
indent
(int depthOffset) Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
nl()
default __
nli()
default __
nli
(int depthOffset) default __
setAtnl()
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
setAtnl
(boolean atnl) Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
setAutonli
(boolean autonli) Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
setDepth
(int depth) Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
setIndent
(boolean indent) Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.default __
sp()
default __
sp
(int count) unsafe()
Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
unsafe
(char ch) Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
unsafe
(char[] cbuf) Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
unsafe
(char[] cbuf, int offset, int len) Deprecated.This method will remain, but its use is discouraged as it can be dangerousunsafe
(IOSupplierE<?, Ex> unsafe) Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
unsafe
(CharSequence csq) Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
unsafe
(CharSequence csq, int start, int end) Deprecated.This method will remain, but its use is discouraged as it can be dangerousdefault __
Deprecated.This method will remain, but its use is discouraged as it can be dangerous
-
Method Details
-
getDocument
D getDocument()Gets the document for the current content model. The document can be used to perform raw output or write elements not expected in the current context. -
nl
Delegates to
AnyDocument.nl()
.- Specified by:
nl
in interfaceDocumentWriter
- Specified by:
nl
in interfaceWhitespace
- Throws:
IOException
-
nli
Delegates to
AnyDocument.nli()
.- Specified by:
nli
in interfaceDocumentWriter
- Specified by:
nli
in interfaceWhitespace
- Throws:
IOException
-
nli
Delegates to
AnyDocument.nli(int)
.- Specified by:
nli
in interfaceDocumentWriter
- Specified by:
nli
in interfaceWhitespace
- Throws:
IOException
-
indent
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.indent()
.- Specified by:
indent
in interfaceDocumentWriter
- Specified by:
indent
in interfaceWhitespace
- Throws:
IOException
-
indent
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.indent(int)
.- Specified by:
indent
in interfaceDocumentWriter
- Specified by:
indent
in interfaceWhitespace
- Throws:
IOException
-
getIndent
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.getIndent()
.- Specified by:
getIndent
in interfaceWhitespace
-
setIndent
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.setIndent(boolean)
.- Specified by:
setIndent
in interfaceDocumentWriter
- Specified by:
setIndent
in interfaceWhitespace
-
getDepth
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.getDepth()
.- Specified by:
getDepth
in interfaceWhitespace
-
setDepth
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.setDepth(int)
.- Specified by:
setDepth
in interfaceDocumentWriter
- Specified by:
setDepth
in interfaceWhitespace
-
incDepth
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.incDepth()
.- Specified by:
incDepth
in interfaceDocumentWriter
- Specified by:
incDepth
in interfaceWhitespace
-
decDepth
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Delegates to
AnyDocument.decDepth()
.- Specified by:
decDepth
in interfaceDocumentWriter
- Specified by:
decDepth
in interfaceWhitespace
-
sp
Delegates to
AnyDocument.sp()
.- Specified by:
sp
in interfaceDocumentWriter
- Specified by:
sp
in interfaceWhitespace
- Throws:
IOException
-
sp
Delegates to
AnyDocument.sp(int)
.- Specified by:
sp
in interfaceDocumentWriter
- Specified by:
sp
in interfaceWhitespace
- Throws:
IOException
-
getRawUnsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousGets the current writer this document is writing to, which may be used for raw output.Please prefer
DocumentWriter.unsafe()
, which is compatible with try-with-resources blocks. The writer returned here is the real, underlying writer.Delegates to
AnyDocument.getRawUnsafe(java.lang.Boolean)
.- Specified by:
getRawUnsafe
in interfaceDocumentWriter
- Parameters:
endsNewline
- Indicates whether the data that will be written will end in aWhitespace.NL
. When non-null, will callDocumentWriter.setAtnl(boolean)
with the given value.- Returns:
- The writer, already optimized via
Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)
withencoder = null
. - Throws:
IllegalStateException
- when output has been set tonull
.- See Also:
-
getRawUnsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousGets the current writer this document is writing to, which may be used for raw output.Please prefer
DocumentWriter.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
DocumentWriter.clearAtnl()
to be safe.Delegates to
AnyDocument.getRawUnsafe()
.- Specified by:
getRawUnsafe
in interfaceDocumentWriter
- Returns:
- The writer, already optimized via
Coercion.optimize(java.io.Writer, com.aoapps.lang.io.Encoder)
withencoder = null
. - Throws:
IllegalStateException
- when output has been set tonull
.- See Also:
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output of a single character, automatically determiningDocumentWriter.setAtnl(boolean)
.Delegates to
AnyDocument.unsafe(char)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output, automatically determiningDocumentWriter.setAtnl(boolean)
.Delegates to
AnyDocument.unsafe(char[])
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output, automatically determiningDocumentWriter.setAtnl(boolean)
.Delegates to
AnyDocument.unsafe(char[], int, int)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output, automatically determiningDocumentWriter.setAtnl(boolean)
.Delegates to
AnyDocument.unsafe(java.lang.CharSequence)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output, automatically determiningDocumentWriter.setAtnl(boolean)
.Delegates to
AnyDocument.unsafe(java.lang.CharSequence, int, int)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output, automatically determiningDocumentWriter.setAtnl(boolean)
.When no knowledge of what will be written, calls
DocumentWriter.clearAtnl()
to be safe.Delegates to
AnyDocument.unsafe(java.lang.Object)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
@Deprecated default <Ex extends Throwable> __ unsafe(IOSupplierE<?, Ex> unsafe) throws IOException, ExDeprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output, automatically determiningDocumentWriter.setAtnl(boolean)
.When no knowledge of what will be written, calls
DocumentWriter.clearAtnl()
to be safe.Delegates to
AnyDocument.unsafe(com.aoapps.lang.io.function.IOSupplierE)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Type Parameters:
Ex
- An arbitrary exception type that may be thrown- Returns:
this
writer- Throws:
IOException
Ex
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output.With no knowledge of what will be written, calls
DocumentWriter.clearAtnl()
to be safe.Delegates to
AnyDocument.unsafe(com.aoapps.lang.io.Writable)
.- Specified by:
unsafe
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
unsafe
Deprecated.This method will remain, but its use is discouraged as it can be dangerousPerforms raw output. This is well suited for use in a try-with-resources block.With no knowledge of what will be written, calls
DocumentWriter.clearAtnl()
to be safe.Delegates to
AnyDocument.unsafe()
.- Specified by:
unsafe
in interfaceDocumentWriter
- 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
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Gets if automatic newline (and indentation when enabled) is currently enabled, off by default.Delegates to
AnyDocument.getAutonli()
.- Specified by:
getAutonli
in interfaceDocumentWriter
-
setAutonli
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Enables or disabled automatic newline (and indentation when enabled).Delegates to
AnyDocument.setAutonli(boolean)
.- Specified by:
setAutonli
in interfaceDocumentWriter
- Returns:
this
writer
-
getAtnl
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Gets the at newline flag.Delegates to
AnyDocument.getAtnl()
.- Specified by:
getAtnl
in interfaceDocumentWriter
-
setAtnl
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Flags is at a newline.Delegates to
AnyDocument.setAtnl()
.- Specified by:
setAtnl
in interfaceDocumentWriter
- Returns:
this
writer
-
setAtnl
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Sets the at newline flag.Delegates to
AnyDocument.setAtnl(boolean)
.- Specified by:
setAtnl
in interfaceDocumentWriter
- Returns:
this
writer
-
clearAtnl
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Clears the at newline flag.Delegates to
AnyDocument.clearAtnl()
.- Specified by:
clearAtnl
in interfaceDocumentWriter
- Returns:
this
writer
-
autoNl
Performs automatic newline whenDocumentWriter.getAutonli()
and notDocumentWriter.getAtnl()
.Delegates to
AnyDocument.autoNl()
.- Specified by:
autoNl
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
autoNli
Performs automatic newline whenDocumentWriter.getAutonli()
and notDocumentWriter.getAtnl()
, followed by automatic indentation when enabled.Delegates to
AnyDocument.autoNli()
.- Specified by:
autoNli
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
autoNli
Performs automatic newline whenDocumentWriter.getAutonli()
and notDocumentWriter.getAtnl()
, followed by automatic indentation with a depth offset when enabled.Delegates to
AnyDocument.autoNli(int)
.- Specified by:
autoNli
in interfaceDocumentWriter
- 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
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Performs automatic indentation whenDocumentWriter.getAutonli()
,Whitespace.getIndent()
, andDocumentWriter.getAtnl()
.Delegates to
AnyDocument.autoIndent()
.- Specified by:
autoIndent
in interfaceDocumentWriter
- Returns:
this
writer- Throws:
IOException
-
autoIndent
Deprecated.Deprecated to keep out of the way in code assist, since this not expected to be used normally.Performs automatic indentation with a depth offset whenDocumentWriter.getAutonli()
,Whitespace.getIndent()
, andDocumentWriter.getAtnl()
.Delegates to
AnyDocument.autoIndent(int)
.- Specified by:
autoIndent
in interfaceDocumentWriter
- 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
-