Package eu.bandm.tools.format

Class Format.Subst

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Subst

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Enclosing class:

Format

public static class Format.Subst
extends Format

bt [__] FIXME DOK FEHLT, NEVER TESTED !?!? NEVER USED !?!?

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 Format	body
protected final Format.Context	context
protected final boolean	partial

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

Constructor	Description
Subst(Format body, Format.Context context, boolean partial)
Subst(Format body, Format.Context context, boolean partial, 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.
Format	eval(Format.Context c, boolean partial)	Return the result of replacing all variables with the bindings in the given Context.
Format	getBody()	Getter used by diagnosis.
Format.Context	getContext()	Getter used by diagnosis.
boolean	getPartial()	Getter used by diagnosis.
Format.Subst	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, 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

body

protected final Format body

context

protected final Format.Context context

partial

protected final boolean partial

Constructor Details

Subst

public Subst(Format body,
 Format.Context context,
 boolean partial)

Subst

public Subst(Format body,
 Format.Context context,
 boolean partial,
 int indent)

Method Details

indent

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

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

eval

public Format eval(Format.Context c,
 boolean partial)

Description copied from class: Format

Return the result of replacing all variables with the bindings in the given Context. Will be overridden only by Variables, which need look-up in the context, and by Compound for descending into the sub-formats. These methods do not use the Visitor/Matcher framework, but direct method invocation and basic method dispatch for descending to child nodes.

Overrides:

eval in class Format

partial - decides when a Variable not defined in the context is found: if true the Variable stays aunaltered; if false an IllegalArgumentException is thrown.

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

getPartial

public boolean getPartial()

Getter used by diagnosis.

getContext

public Format.Context getContext()

Getter used by diagnosis.

getBody

public Format getBody()

Getter used by diagnosis.