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
Foreseen for data annotations. Required for the metajava
reference format.
- See Also:
-
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
FieldsModifier and TypeFieldDescriptionprotected final A
The annotation value.protected final 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 -
Method Summary
Modifier and TypeMethodDescriptiondebugPrefix
(int n) Overridden by subclasses to deliver a printable representation for debugging purpose.protected void
Over-ridden by all sub-classes of Format, for performing the adquate print operations.Getter used by diagnosis.Getter used by diagnosis.indent
(int i) Returns a clone ofthis
with the new value ofFormat.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
-
Field Details
-
format
The printable contents which shall be annotated. -
annotation
The annotation value.
-
-
Constructor Details
-
Annotated
Constructor used by the factory methods. -
Annotated
Constructor used only internally by the cloning methods.
-
-
Method Details
-
doprint
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. -
indent
Description copied from class:Format
Returns a clone ofthis
with the new value ofFormat.indent
. (The built-in "clone()" functionality cannot be used, since field "indent" is final). -
debugPrefix
Description copied from class:Format
Overridden by subclasses to deliver a printable representation for debugging purpose.- Specified by:
debugPrefix
in classFormat
- Parameters:
n
- the maximal number of characters
-
getFormat
Getter used by diagnosis. -
getAnnotation
Getter used by diagnosis.
-