Package eu.bandm.tools.format

Class Format.Literal

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Literal

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Enclosing class:

Format

public static class Format.Literal
extends Format

Printed literally to the output. May, but should not, contain whitespace. This will not be correctly formatted, unlike explicit Format.Space instances. Should not contain newlines. The factory method Format.literal(String) ensures the latter.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.format.Format

Format.Annotated<A>, Format.Append, Format.Beneath, Format.Beside, Format.Block, Format.BoundVariable, Format.Comment, Format.Compound, Format.Context, Format.Empty, Format.FormatPrinter, Format.FreeVariable, Format.Line, Format.Literal, Format.Markup, Format.Matcher, Format.NonFormatPrinter, Format.Prior, Format.Rewriter, Format.Space, Format.Subst, Format.Tabular, Format.Variable, Format.Visitor

Field Summary

Fields

Modifier and Type	Field	Description
final String	content	The visible string content to print .

Fields inherited from class eu.bandm.tools.format.Format

comma, DEFAULT_WIDTH, dot, empty, ground, indent, INDENT_NOT_SET, isAlwaysMultiline, LENGTH_PREFIX, maxWidth, minWidth, pattern_illegal_literal, space

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Literal(String s)	Constructor which unsets the indent value.
protected	Literal(String s, int i)	Constructor which sets the text contents and the indent value.

Method Summary

Modifier and Type	Method	Description
String	debugPrefix(int n)	Overridden by subclasses to deliver a printable representation for debugging purpose.
protected void	doprint(Format.FormatPrinter v)	Over-ridden by all sub-classes of Format, for performing the adquate print operations.
Format.Literal	indent(int i)	Returns a clone of this with the new value of Format.indent.

Methods inherited from class eu.bandm.tools.format.Format

annotated, append, append, apply, apply, apply, apply, applyPartial, applyTo, applyTo, beneath, beneath, beside, beside, block, block, comment, comment, comment, comment, eval, format, indentIsSet, isSpace, isValidContentForLiteral, line, line, literal, makeAppend, makeBeneath, makeBeside, makeBlock, makeLine, makeTabular, markup, markupLeft, markupRight, maxOfMins, of, printFormat, printFormat, printNonFormat, prior, prior, server, showLn, space, subst, subst, subst, tabular, tabular, toObjString, toString, toString, variable, variable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

content

public final String content

The visible string content to print .

Constructor Details

Literal

protected Literal(String s)

Constructor which unsets the indent value. The factory methods Format.literal(String) is preferable.

Literal

protected Literal(String s,
 int i)

Constructor which sets the text contents and the indent value. The factory methods Format.literal(String) is preferable.

Method Details

doprint

protected void doprint(Format.FormatPrinter v)

Description copied from class: Format

Over-ridden by all sub-classes of Format, for performing the adquate print operations. To be printed is the raison d'être of Format objects. These methods do not use the Visitor/Matcher framework, but direct method invocation and basic method dispatch for descending to child nodes.

Specified by:

doprint in class Format

debugPrefix

public String debugPrefix(int n)

Description copied from class: Format

Overridden by subclasses to deliver a printable representation for debugging purpose.

Specified by:

debugPrefix in class Format

Parameters:

n - the maximal number of characters

indent

public Format.Literal indent(int i)

Description copied from class: Format

Returns a clone of this with the new value of Format.indent. (The built-in "clone()" functionality cannot be used, since field "indent" is final).

Specified by:

indent in class Format