Package eu.bandm.tools.format

Class Format.Prior

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Prior

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Enclosing class:

Format

public static class Format.Prior
extends Format

This format is rendered differently, according to its relative positions to ancestor formats of this class. It prints it parens format, if it is (directly or indirectly) contained in a Prior Format with a higher priority level (which is a numerically larger priority code).

If not, but contained in a format with the same priority. a different value of alternative between these formats also selects the parens format. So does a negative alternative value.

Otherwise the noparens format is printed.

So one can automatically diferentiate between a+b*c+d for the expressio tree +(a, *(b, c), d) (a+b)*c*d *(+(a, b), c, d) a+(b-c)+d +(a, -(b, c), d) a-(b+c+d) -(a, -(b, c, d))

The priority of the outermost level, when initially calling Format.FormatPrinter.startPrinting(Format), is set to zero.

In contrast to most other format classes, the preparatory calculations of the format's width requirements are only heuristical and use the respective maximum values, because the final print context is (naturally) not known.

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 int	alternative	The paren version will be printed if this format is contained (maybe indirectly) in another Prior with same priority and different alternative, or if this alternative == -1.
final int	level	The paren version will be printed if this format is contained (maybe indirectly) in another Prior with higher priority.
final Format	noparens
final Format	parens

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Prior(int level, int alternative, Format noparens, Format parens)	Sets all fields of the new instance, but the indentation to Format.INDENT_NOT_SET.
protected	Prior(int level, int alternative, Format noparens, Format parens, int indent)	Sets all fields of the new instance.

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.Prior	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, 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

level

public final int level

The paren version will be printed if this format is contained (maybe indirectly) in another Prior with higher priority.

alternative

public final int alternative

The paren version will be printed if this format is contained (maybe indirectly) in another Prior with same priority and different alternative, or if this alternative == -1.

noparens

public final Format noparens

parens

public final Format parens

Constructor Details

Prior

protected Prior(int level,
 int alternative,
 Format noparens,
 Format parens,
 int indent)

Sets all fields of the new instance.

Prior

protected Prior(int level,
 int alternative,
 Format noparens,
 Format parens)

Sets all fields of the new instance, but the indentation to Format.INDENT_NOT_SET.

Method Details

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

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.Prior 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