Package eu.bandm.tools.format
Class Format.Prior
java.lang.Object
eu.bandm.tools.format.Format
eu.bandm.tools.format.Format.Prior
- All Implemented Interfaces:
Formattable
,Serializable
,Cloneable
- Enclosing class:
- Format
This format prints the "parens" format, if it is (directly or indirectly)
contained in a Prior Format with a higher priority 'level" (numerically larger
priority code).
If it has the same priority, then a different value of "alternative" selects the "parens" format. So does a negative "alternative" value.
Otherwise it prints the "noparens" format. The priority of the outermost level, when initially calling
If it has the same priority, then a different value of "alternative" selects the "parens" format. So does a negative "alternative" value.
Otherwise it prints the "noparens" format. The priority of the outermost level, when initially calling
Format.FormatPrinter.startPrinting(Format)
, is defined as 0(zero).
The preparatory calculations of the format's width requirements are
only heuristical and use the maximum values, because the final print
context is (naturally) not known.- 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 TypeFieldDescriptionfinal int
The paren version will be printed if this format is contained (maybe indirectly) in another Prior with same priority and different alternative, or if this alternative == -1.final int
The paren version will be printed if this format is contained (maybe indirectly) in another Prior with higher priority.final Format
final Format
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
ConstructorsModifierConstructorDescriptionprotected
Sets all fields of the new instance, but the indentation toFormat.INDENT_NOT_SET
.protected
Sets all fields of the new instance. -
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.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
-
level
public final int levelThe paren version will be printed if this format is contained (maybe indirectly) in another Prior with higher priority. -
alternative
public final int alternativeThe paren version will be printed if this format is contained (maybe indirectly) in another Prior with same priority and different alternative, or if this alternative == -1. -
noparens
-
parens
-
-
Constructor Details
-
Prior
Sets all fields of the new instance. -
Prior
Sets all fields of the new instance, but the indentation toFormat.INDENT_NOT_SET
.
-
-
Method Details
-
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
-
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).
-