Package eu.bandm.tools.format

Class Format.Annotated<A>

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Annotated<A>

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Direct Known Subclasses:

ReferenceFormat

Enclosing class:

Format

public static class Format.Annotated<A>
extends Format

Foreseen for data annotations. Required for the metajava reference format.

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 A	annotation	The annotation value.
protected final Format	format	The printable contents which shall be annotated.

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
Annotated(Format format, int indent, A annotation)	Constructor used only internally by the cloning methods.
Annotated(Format format, A annotation)	Constructor used by the factory methods.

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.
A	getAnnotation()	Getter used by diagnosis.
Format	getFormat()	Getter used by diagnosis.
Format.Annotated<A>	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

format

protected final Format format

The printable contents which shall be annotated.

annotation

@Opt
protected final A annotation

The annotation value.

Constructor Details

Annotated

public Annotated(Format format,
 @Opt
 A annotation)

Constructor used by the factory methods.

Annotated

public Annotated(Format format,
 int indent,
 @Opt
 A annotation)

Constructor used only internally by the cloning methods.

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.Annotated<A> 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

getFormat

public Format getFormat()

Getter used by diagnosis.

getAnnotation

public A getAnnotation()

Getter used by diagnosis.