Package eu.bandm.tools.format

Class Format.Markup

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Markup

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Enclosing class:

Format

public static class Format.Markup
extends Format

Printed literally to the output, but not included in width calculation.

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
protected final String	content	The mark-up text.
protected boolean	isright	Whether this mark-up is the right=closing part of a pair=parantheses.

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	Markup(String s, boolean isright)	Constructor which sets the contents and unsets the indent value.
protected	Markup(String s, boolean isright, int indent)

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.
String	getContent()	Getter used by diagnosis.
boolean	getIsright()	Getter used by diagnosis.
Format.Markup	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

protected final String content

The mark-up text.

isright

protected boolean isright

Whether this mark-up is the right=closing part of a pair=parantheses.

Constructor Details

Markup

protected Markup(String s,
 boolean isright)

Constructor which sets the contents and unsets the indent value. Factory methods are preferable.

Markup

protected Markup(String s,
 boolean isright,
 int indent)

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

indent

public Format.Markup 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

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

getContent

public String getContent()

Getter used by diagnosis.

getIsright

public boolean getIsright()

Getter used by diagnosis.