Enum Class Doc.Empty

java.lang.Object

java.lang.Enum<Doc.Empty>

org.aya.pretty.doc.Doc.Empty

All Implemented Interfaces:

Serializable, Comparable<Doc.Empty>, Constable, Doc, Docile

Enclosing interface:

Doc

public static enum Doc.Empty
extends Enum<Doc.Empty>
implements Doc

The empty document; conceptually the unit of 'Cat'

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.aya.pretty.doc.Doc

Doc.Cat, Doc.CodeBlock, Doc.Column, Doc.Empty, Doc.EscapedText, Doc.FlatAlt, Doc.HyperLinked, Doc.Image, Doc.InlineCode, Doc.InlineMath, Doc.Line, Doc.List, Doc.MathBlock, Doc.Nest, Doc.Nesting, Doc.PageWidth, Doc.PlainText, Doc.SpecialSymbol, Doc.Styled, Doc.Tooltip, Doc.Union

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields inherited from interface org.aya.pretty.doc.Doc

ALT_WS, COMMA, ONE_WS

Method Summary

Modifier and Type	Method	Description
static Doc.Empty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Doc.Empty[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.aya.pretty.doc.Doc

commonRender, debugRender, isEmpty, isNotEmpty, render, renderToAyaMd, renderToHtml, renderToHtml, renderToMd, renderToString, renderToString, renderToTerminal, renderToTerminal, renderToTeX, toDoc

Enum Constant Details

INSTANCE

public static final Doc.Empty INSTANCE

Method Details

values

public static Doc.Empty[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Doc.Empty valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null