A B C D E F G H I L M N P R S T U V W X Y
All Classes All Packages

A

AnsiConstants - Class in com.opencastsoftware.prettier4j.ansi

This class declares constants for producing ANSI escape code sequences.

append(Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one.

appendLine(Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one, separated by a line break which cannot be flattened.

appendLineOr(Doc, Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one, separated by a line break which may be flattened into the altDoc document.

appendLineOr(String, Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one, separated by a line break which may be flattened into the altText String.

appendLineOrEmpty(Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one, separated by a line break which may be flattened into an empty document.

appendLineOrSpace(Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one, separated by a line break which may be flattened into a space character.

appendSpace(Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Append the other Doc to this one, separated by a space character.

Attrs - Class in com.opencastsoftware.prettier4j.ansi

This class contains utilities for operating on display attributes.

AttrsStack - Class in com.opencastsoftware.prettier4j.ansi

A simple stack of longs, stored in a backing array.

AttrsStack() - Constructor for class com.opencastsoftware.prettier4j.ansi.AttrsStack

AttrsStack(int) - Constructor for class com.opencastsoftware.prettier4j.ansi.AttrsStack

B

bg(Color) - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the background color for a Doc when used as an argument to styled.

bgColor(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

bgColorType(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

bgParams() - Method in interface com.opencastsoftware.prettier4j.ansi.Color

Produces the SGR (Select Graphic Rendition) parameters required to apply this Color as the background color.

black() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color black to a Doc when styled via fg or bg.

blink() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the blink display style for a Doc when used as an argument to styled.

blue() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color blue to a Doc when styled via fg or bg.

bold() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the bold display style for a Doc when used as an argument to styled.

bracket(int, Doc, Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Bracket the current document by the left and right documents, indented by indent spaces.

bracket(int, Doc, Doc, Doc) - Method in class com.opencastsoftware.prettier4j.Doc

Bracket the current document by the left and right documents, indented by indent spaces.

bracket(int, Doc, String, String) - Method in class com.opencastsoftware.prettier4j.Doc

Bracket the current document by the left and right Strings, indented by indent spaces.

bracket(int, String, String) - Method in class com.opencastsoftware.prettier4j.Doc

Bracket the current document by the left and right Strings, indented by indent spaces.

brightBlack() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color black (dark grey) to a Doc when styled via fg or bg.

brightBlue() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color blue to a Doc when styled via fg or bg.

brightCyan() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color cyan to a Doc when styled via fg or bg.

brightGreen() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color green to a Doc when styled via fg or bg.

brightMagenta() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color magenta to a Doc when styled via fg or bg.

brightRed() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color red to a Doc when styled via fg or bg.

brightWhite() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of white to a Doc when styled via fg or bg.

brightYellow() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies a brighter shade of the color yellow to a Doc when styled via fg or bg.

C

code() - Method in enum com.opencastsoftware.prettier4j.ansi.ColorType

Color - Interface in com.opencastsoftware.prettier4j.ansi

This interface provides static methods to produce Colors.

COLOR_16 - com.opencastsoftware.prettier4j.ansi.ColorType

COLOR_RGB - com.opencastsoftware.prettier4j.ansi.ColorType

COLOR_XTERM - com.opencastsoftware.prettier4j.ansi.ColorType

colorType() - Method in interface com.opencastsoftware.prettier4j.ansi.Color

The ColorType of this Color.

ColorType - Enum in com.opencastsoftware.prettier4j.ansi

This enum represents the different color types that can be applied via Select Graphic Rendition parameters.

com.opencastsoftware.prettier4j - package com.opencastsoftware.prettier4j

This package contains Doc, the class used to declare documents for rendering using prettier4j.

com.opencastsoftware.prettier4j.ansi - package com.opencastsoftware.prettier4j.ansi

This package contains utilities for producing styled text via ANSI escape codes.

CSI - Static variable in class com.opencastsoftware.prettier4j.ansi.AnsiConstants

The CSI (Control Sequence Introducer) escape sequence.

cyan() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color cyan to a Doc when styled via fg or bg.

D

doc() - Method in class com.opencastsoftware.prettier4j.Doc.Indent

doc() - Method in class com.opencastsoftware.prettier4j.Doc.Styled

Doc - Class in com.opencastsoftware.prettier4j

Implements the algorithm described in Philip Wadler's "A prettier printer", a pretty printing algorithm for laying out hierarchical documents as text.

Doc() - Constructor for class com.opencastsoftware.prettier4j.Doc

Doc.Alternatives - Class in com.opencastsoftware.prettier4j

Represents a choice between a flattened and expanded layout for a single Doc.

Doc.Append - Class in com.opencastsoftware.prettier4j

Represents the concatenation of two Docs.

Doc.Empty - Class in com.opencastsoftware.prettier4j

Represents an empty Doc.

Doc.Escape - Class in com.opencastsoftware.prettier4j

Represents an ANSI escape code sequence.

Doc.Indent - Class in com.opencastsoftware.prettier4j

Represents an indented Doc.

Doc.Line - Class in com.opencastsoftware.prettier4j

Represents a line break which cannot be flattened into a more compact layout.

Doc.LineOr - Class in com.opencastsoftware.prettier4j

Represents a line break which can be flattened into an alternative document altDoc.

Doc.LineOrEmpty - Class in com.opencastsoftware.prettier4j

Represents a line break which can be flattened into an empty document.

Doc.LineOrSpace - Class in com.opencastsoftware.prettier4j

Represents a line break which can be flattened into a single space character.

Doc.Reset - Class in com.opencastsoftware.prettier4j

Represents the end of a Doc that is styled with an ANSI escape code sequence.

Doc.Styled - Class in com.opencastsoftware.prettier4j

Represents a Doc styled with ANSI escape codes.

Doc.Text - Class in com.opencastsoftware.prettier4j

Represents an atomic piece of text.

E

empty() - Static method in class com.opencastsoftware.prettier4j.Doc

Creates an empty Doc.

EMPTY - Static variable in class com.opencastsoftware.prettier4j.ansi.Attrs

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.Alternatives

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.Append

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.Escape

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.Indent

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.LineOr

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.Styled

equals(Object) - Method in class com.opencastsoftware.prettier4j.Doc.Text

Escape(Styles.StylesOperator[]) - Constructor for class com.opencastsoftware.prettier4j.Doc.Escape

F

faint() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the faint display style for a Doc when used as an argument to styled.

fg(Color) - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the foreground color for a Doc when used as an argument to styled.

fgColor(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

fgColorType(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

fgParams() - Method in interface com.opencastsoftware.prettier4j.ansi.Color

Produces the SGR (Select Graphic Rendition) parameters required to apply this Color as the foreground color.

fold(Collection<Doc>, BinaryOperator<Doc>) - Static method in class com.opencastsoftware.prettier4j.Doc

Reduce a collection of documents using the binary operator fn, returning an empty document if the collection is empty.

fold(Stream<Doc>, BinaryOperator<Doc>) - Static method in class com.opencastsoftware.prettier4j.Doc

Reduce a stream of documents using the binary operator fn, returning an empty document if the stream is empty.

G

green() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color green to a Doc when styled via fg or bg.

group(Doc) - Static method in class com.opencastsoftware.prettier4j.Doc

Creates a Doc which represents a group that can be flattened into a more compact layout.

H

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.Alternatives

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.Append

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.Escape

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.Indent

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.LineOr

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.Styled

hashCode() - Method in class com.opencastsoftware.prettier4j.Doc.Text

I

indent() - Method in class com.opencastsoftware.prettier4j.Doc.Indent

indent(int) - Method in class com.opencastsoftware.prettier4j.Doc

Indent the current Doc by indent spaces.

indent(int, Doc) - Static method in class com.opencastsoftware.prettier4j.Doc

Indent the input Doc by indent spaces.

intersperse(Doc, Collection<Doc>) - Static method in class com.opencastsoftware.prettier4j.Doc

Intersperse a separator document in between the elements of a collection of documents.

intersperse(Doc, Stream<Doc>) - Static method in class com.opencastsoftware.prettier4j.Doc

Intersperse a separator document in between the elements of a stream of documents.

inverse() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the inverse display style for a Doc when used as an argument to styled.

isBlink(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isBold(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isEmpty(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isFaint(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isInverse(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isItalic(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isStrikethrough(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

isUnderline(long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

italic() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the italic display style for a Doc when used as an argument to styled.

L

left() - Method in class com.opencastsoftware.prettier4j.Doc.Alternatives

left() - Method in class com.opencastsoftware.prettier4j.Doc.Append

line() - Static method in class com.opencastsoftware.prettier4j.Doc

Creates a Doc representing a line break which cannot be flattened.

Line() - Constructor for class com.opencastsoftware.prettier4j.Doc.Line

lineOr(Doc) - Static method in class com.opencastsoftware.prettier4j.Doc

Creates a Doc representing a line break which may be flattened into an alternative document altDoc.

lineOr(String) - Static method in class com.opencastsoftware.prettier4j.Doc

Creates a Doc representing a line break which may be flattened into the alternative text altText.

LineOr() - Constructor for class com.opencastsoftware.prettier4j.Doc.LineOr

LineOr(Doc) - Constructor for class com.opencastsoftware.prettier4j.Doc.LineOr

lineOrEmpty() - Static method in class com.opencastsoftware.prettier4j.Doc

Creates a Doc representing a line break which may be flattened into an empty document.

LineOrEmpty() - Constructor for class com.opencastsoftware.prettier4j.Doc.LineOrEmpty

lineOrSpace() - Static method in class com.opencastsoftware.prettier4j.Doc

Creates a Doc representing a line break which may be flattened into a single space character.

M

magenta() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color magenta to a Doc when styled via fg or bg.

N

none() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Restores the default color for a Doc when styled via fg or bg.

NULL - Static variable in class com.opencastsoftware.prettier4j.ansi.Attrs

P

peekLast() - Method in class com.opencastsoftware.prettier4j.ansi.AttrsStack

popLast() - Method in class com.opencastsoftware.prettier4j.ansi.AttrsStack

pushLast(long) - Method in class com.opencastsoftware.prettier4j.ansi.AttrsStack

R

red() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color red to a Doc when styled via fg or bg.

render(int) - Method in class com.opencastsoftware.prettier4j.Doc

Renders the current Doc into a String, aiming to lay out the document with at most width characters on each line.

render(int, boolean) - Method in class com.opencastsoftware.prettier4j.Doc

Renders the current Doc into a String, aiming to lay out the document with at most width characters on each line.

render(int, boolean, Doc) - Static method in class com.opencastsoftware.prettier4j.Doc

Renders the input Doc into a String, aiming to lay out the document with at most width characters on each line.

render(int, boolean, Doc, Appendable) - Static method in class com.opencastsoftware.prettier4j.Doc

Renders the input Doc into an Appendable, aiming to lay out the document with at most width characters on each line.

render(int, boolean, Appendable) - Method in class com.opencastsoftware.prettier4j.Doc

Renders the current Doc into an Appendable, aiming to lay out the document with at most width characters on each line.

render(int, Doc) - Static method in class com.opencastsoftware.prettier4j.Doc

Renders the input Doc into a String, aiming to lay out the document with at most width characters on each line.

render(int, Doc, Appendable) - Static method in class com.opencastsoftware.prettier4j.Doc

Renders the input Doc into an Appendable, aiming to lay out the document with at most width characters on each line.

render(int, Appendable) - Method in class com.opencastsoftware.prettier4j.Doc

Renders the current Doc into an Appendable, aiming to lay out the document with at most width characters on each line.

RESET - Static variable in class com.opencastsoftware.prettier4j.ansi.AnsiConstants

The Reset SGR (Select Graphic Rendition) sequence.

rgb(int, int, int) - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the given 24-bit RGB color to a Doc when styled via fg or bg.

right() - Method in class com.opencastsoftware.prettier4j.Doc.Alternatives

right() - Method in class com.opencastsoftware.prettier4j.Doc.Append

S

strikethrough() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the strikethrough display style for a Doc when used as an argument to styled.

styled(Styles.StylesOperator...) - Method in class com.opencastsoftware.prettier4j.Doc

Styles the current Doc using the styles provided via styles.

styled(Doc, Styles.StylesOperator...) - Static method in class com.opencastsoftware.prettier4j.Doc

Styles the input Doc using the styles provided via styles.

styles() - Method in class com.opencastsoftware.prettier4j.Doc.Escape

styles() - Method in class com.opencastsoftware.prettier4j.Doc.Styled

Styles - Class in com.opencastsoftware.prettier4j.ansi

This class provides static methods for applying ANSI text styles to a Doc via styled.

Styles.StylesOperator - Interface in com.opencastsoftware.prettier4j.ansi

An operator that is used to apply display styles to a Doc.

T

text() - Method in class com.opencastsoftware.prettier4j.Doc.Text

text(String) - Static method in class com.opencastsoftware.prettier4j.Doc

Construct a Doc from the text.

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Alternatives

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Append

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Empty

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Escape

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Indent

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Line

toString() - Method in class com.opencastsoftware.prettier4j.Doc.LineOr

toString() - Method in class com.opencastsoftware.prettier4j.Doc.LineOrEmpty

toString() - Method in class com.opencastsoftware.prettier4j.Doc.LineOrSpace

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Reset

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Styled

toString() - Method in class com.opencastsoftware.prettier4j.Doc.Text

transition(long, long) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

U

underline() - Static method in class com.opencastsoftware.prettier4j.ansi.Styles

Sets the underline display style for a Doc when used as an argument to styled.

V

valueOf(String) - Static method in enum com.opencastsoftware.prettier4j.ansi.ColorType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.opencastsoftware.prettier4j.ansi.ColorType

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

W

white() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color white to a Doc when styled via fg or bg.

withCode(int) - Static method in enum com.opencastsoftware.prettier4j.ansi.ColorType

withStyles(long, Styles.StylesOperator...) - Static method in class com.opencastsoftware.prettier4j.ansi.Attrs

X

xterm(int) - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the given color code from the xterm 256-color palette to a Doc when styled via fg or bg.

Y

yellow() - Static method in interface com.opencastsoftware.prettier4j.ansi.Color

Applies the color yellow to a Doc when styled via fg or bg.

A B C D E F G H I L M N P R S T U V W X Y
All Classes All Packages