Package eu.bandm.tools.format

Class Format.Comment

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Compound

eu.bandm.tools.format.Format.Comment

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Enclosing class:

Format

public static class Format.Comment
extends Format.Compound

Arranges all sub-formats with leading asterisks, like a javadoc comment. Arranges all sub-formats in a text block which is smaller than usual, and prepends the comment-lead in prefix after each linefeed printed. This format is special because the line prefices must be inserted "physically" into the lower level "block" or "beneath" layout. always at the start of a line. Therefore they are handled by the Format.FormatPrinter directly. This has only one field for this purpose, thus Comments can NOT BE NESTED. This is checked not before trying to print.

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 String	linePrefix
protected final @Opt String	prefix
protected final @Opt String	suffix

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

subs

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	Comment(int i, int a, boolean m, boolean g, int ind, String prefix, String linePrefix, String suffix, List<Format> f)	Constructor used only internally by the cloning methods.
protected	Comment(@Opt String prefix, String linePrefix, @Opt String suffix, List<Format> f)	Constructor used by the factory methods.

Method Summary

Modifier and Type	Method	Description
CompoundConstructor	constructor()	Unsupported Operation.
protected void	doprint(Format.FormatPrinter v)	Over-ridden by all sub-classes of Format, for performing the adquate print operations.
Format.Comment	mutate(Consumer<List<Format>> mapSubs)	Creates a new instance of the same class as this, with sub-formats altered by the given consumer function.

Methods inherited from class eu.bandm.tools.format.Format.Compound

debugPrefix, eval, 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

prefix

@Opt
protected final @Opt String prefix

suffix

@Opt
protected final @Opt String suffix

linePrefix

protected final String linePrefix

Constructor Details

Comment

protected Comment(@Opt
 @Opt String prefix,
 String linePrefix,
 @Opt
 @Opt String suffix,
 List<Format> f)

Constructor used by the factory methods.

Comment

protected Comment(int i,
 int a,
 boolean m,
 boolean g,
 int ind,
 String prefix,
 String linePrefix,
 String suffix,
 List<Format> f)

Constructor used only internally by the cloning methods.

Method Details

constructor

public CompoundConstructor constructor()

Unsupported Operation. Comment is a Compound, but it is special as it is not freely compositinal. It thus has no corresponding CompoundConstructor.

Specified by:

constructor in class Format.Compound

mutate

public Format.Comment mutate(Consumer<List<Format>> mapSubs)

Description copied from class: Format.Compound

Creates a new instance of the same class as this, with sub-formats altered by the given consumer function.

Specified by:

mutate in class Format.Compound

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