eu.bandm.tools.format

Class Format.Compound

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Format.Compound

All Implemented Interfaces:

Formattable, Serializable, Cloneable

Direct Known Subclasses:

Format.Append, Format.MayBreak, Format.Tabular

Enclosing class:

Format

public abstract static class Format.Compound
extends Format

The base class for all formats which combine (= "contain") sub-formats.

It provides a rewriter interface similar to the one employed by umod. It basically operates as follows:

• The user calls startMutation() and gets an intermediate clone.
• The user can access the list of all sub-formats of this clone by getSubs() and replace/delete/re-arrange the formats contained therein.
• The list is cloned lazily, so no re-computations are required as long as no real modifications are applied to the list.
• By calling endMutation() you get as a result either the clone, or the original compound format object, if this is appropriate.

Throughout it holds:

• The fact that the re-calculation of all internal attribute caches is required, is memoized by setting the flag Format.invalid Before printing, the print method has to call Format.validate(). This in turn possibly calls recursivel validate() on the sub-formats and Format.update() to re-calculate the attribute caches.
• When startMutation() and endMutation() are called in a not strictly alternating sequence, of when a "set" is attempted while isMutating() delivers false, then a IllegalStateException is thrown.

This mutation mechanism is also employed whenever variables are substituted by executing eval()!

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.Forester, Format.FormatPrinter, Format.FreeVariable, Format.Line, Format.Literal, Format.Markup, Format.Matcher, Format.MayBreak, Format.NonFormatPrinter, Format.Prior, Format.Rewriter, Format.Space, Format.Subst, Format.Tabular, Format.Variable, Format.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Format>	subs

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

comma, contentPrefixPrinted, DEFAULT_WIDTH, dot, empty, ground, indent, INDENT_NOT_SET, invalid, isAlwaysMultiline, LENGTH_PREFIX, literal, maxWidth, minWidth, pattern_illegal_literal, pattern_newline, pattern_ws, pattern_wsWithVars, space

Fields inherited from interface eu.bandm.tools.format.Formattable

format

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Compound() For deserialization only.
protected	Compound(List<Format> f)

Method Summary

Modifier and Type	Method and Description
protected boolean	calcground() returns the "and" of all sub-formats.
protected boolean	calcmult() returns the "or" of all sub-formats.
String	debugPrefix(int n)
Format.Compound	endMutation() See description of the mutation mechanism at class level.
Format	eval(Format.Context c, boolean partial)
List<Format>	getSubs() Returns a list which is modifiable only if it comes from a cloned Format.Compound, created with "startMutation()" as described at class level.
boolean	isMutating() See description of the mutation mechanism at class level.
Format.Compound	startMutation() See description of the mutation mechanism at class level.
protected int	sumMin_noTrailingBlanks()
protected void	update() Just local calculation, assumes that all sub-objects are already valid.
protected void	validate() Re-calculates all parameters by calling Format.update(), iff necessary.

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, calcmax, calcmin, comment, comment, comment, comment, doprint, format, indent, indentIsSet, invalidate, isSpace, isValidContentForLiteral, line, line, list, list, list, list, list, literal, main, makeAppend, makeBeneath, makeBeside, makeBlock, makeLine, makeTabular, markup, markupLeft, markupRight, printFormat, printFormat, printNonFormat, prior, prior, quoteDTDstyle, quoteJavaStyle, showLn, showLn, showSwingTree, space, subst, subst, subst, tabular, tabular, text, textWithVars, toFormat, toObjString, toString, toString, variable, variable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

subs

protected List<Format> subs

Constructor Detail

Compound

protected Compound(List<Format> f)

Compound

protected Compound()

For deserialization only.

Method Detail

sumMin_noTrailingBlanks

protected int sumMin_noTrailingBlanks()

calcmult

protected boolean calcmult()

returns the "or" of all sub-formats.

Overrides:

calcmult in class Format

calcground

protected boolean calcground()

returns the "and" of all sub-formats.

Overrides:

calcground in class Format

validate

protected void validate()

Description copied from class: Format

Re-calculates all parameters by calling Format.update(), iff necessary. Is over-ridden by Format.Compound for prior descending to sub-formats.

Overrides:

validate in class Format

startMutation

public Format.Compound startMutation()

See description of the mutation mechanism at class level.

Throws:

IllegalStateException - when applied to a compound which itself is already a clone.

endMutation

public Format.Compound endMutation()

See description of the mutation mechanism at class level.

Throws:

IllegalStateException - when applied to a compound which is not a clone.
ATTENTION die zusicherungen der factory schnittstellen "subs.size()>=2 wird hier NICHT eingehalten !! FIXME

isMutating

public boolean isMutating()

See description of the mutation mechanism at class level.

Returns:

whether this is a clone.

update

protected void update()

Description copied from class: Format

Just local calculation, assumes that all sub-objects are already valid. This method Is not overridden (only by Format.Compound, testing not being a temporary copy). Instead, the differente "calc<..>" methods are overridden individually.

Overrides:

update in class Format

getSubs

public List<Format> getSubs()

Returns a list which is modifiable only if it comes from a cloned Format.Compound, created with "startMutation()" as described at class level. The set() method of the returned list throws IllegalStateException if it comes from a non-clone.

eval

public Format eval(Format.Context c,
                   boolean partial)

Overrides:

eval in class Format

debugPrefix

public String debugPrefix(int n)

Specified by:

debugPrefix in class Format