Package eu.bandm.tools.format

Class Format.Variable

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Variable

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Direct Known Subclasses:

Format.BoundVariable, Format.FreeVariable

Enclosing class:

Format

public abstract static class Format.Variable
extends Format

Common base class for Format.FreeVariable and Format.BoundVariable

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	name	Either the explicit name of Format.FreeVariable, or the positoin number of a Format.BoundVariable.

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	Variable(String s)
protected	Variable(String s, int indent)	Set index and indentation value.

Method Summary

Modifier and Type	Method	Description
protected Format	bottom()	Needed as a pseudo-return value for Java control flow analysis.
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.

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, indent, 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

name

public final String name

Either the explicit name of Format.FreeVariable, or the positoin number of a Format.BoundVariable.

Constructor Details

Variable

protected Variable(String s)

Variable

protected Variable(String s,
 int indent)

Set index and indentation value. ???? FIXME WIRD NICHT VERWENDET !?!?

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

bottom

protected Format bottom()

Needed as a pseudo-return value for Java control flow analysis.

Throws:

always - an IllegalArgumentException.

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