Package eu.bandm.tools.format

Class FreeVariable

java.lang.Object

eu.bandm.tools.format.Format

eu.bandm.tools.format.Variable

eu.bandm.tools.format.FreeVariable

All Implemented Interfaces:

Formattable, Serializable, Cloneable

public class FreeVariable
extends Variable

Variable identified by a alphanumeric name which can be bound explicitly.

See Also:

• Serialized Form

Field Summary

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

DEFAULT_PREFIX

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

comma, DEFAULT_WIDTH, dot, empty, indent, INDENT_NOT_SET, LENGTH_PREFIX, space

Constructor Summary

Constructors

Constructor	Description
FreeVariable(String name)	Constructor which sets the name of the variable.
FreeVariable(String name, int indent)	Sets the name and the indentation value.
FreeVariable(String prefix, String name, int indent)	Sets all properties of the new instance explicitly.

Method Summary

Modifier and Type	Method	Description
Format	eval(Context c, boolean partial)	Replace this by the binding defined in the context.

Methods inherited from class eu.bandm.tools.format.Variable

bottom, debugPrefix, doprint, getName, getPrefix, 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, checkValidIndent, comment, comment, comment, comment, format, getIndent, ground, indentIsSet, isAlwaysMultiline, isSpace, line, line, literal, markup, markupLeft, markupRight, maxOfMins, maxWidth, minWidth, of, printFormat, printFormat, printNonFormat, prior, prior, properties, 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

Constructor Details

FreeVariable

public FreeVariable(String name)

Constructor which sets the name of the variable. The name must be an identifier accepted by #hasValidIdentifierStructure(String). The prefix for parsing and display deraults to Variable.DEFAULT_PREFIX.

Parameters:

name - of the variable

Throws:

IllegalArgumentException - if name is not a valid Java identifier.

See Also:

• #hasValidIdentifierStructure(String)}

FreeVariable

public FreeVariable(String name,
 int indent)

Sets the name and the indentation value. The name must be an identifier accepted by #hasValidIdentifierStructure(String). Indentation must be equal to Format.INDENT_NOT_SET. The prefix for parsing and display deraults to Variable.DEFAULT_PREFIX.

Parameters:

name - of the variable

indent - must be equal to Format.INDENT_NOT_SET.

Throws:

IllegalArgumentException - if indent in not equal to Format.INDENT_NOT_SET.

IllegalArgumentException - if name is not a valid Java identifier.

See Also:

• Variable.indent(int)

FreeVariable

public FreeVariable(String prefix,
 String name,
 int indent)

Sets all properties of the new instance explicitly. The prefix for parsing and display must be a non-empty string. The name must be an identifier accepted by #hasValidIdentifierStructure(String). Indentation must be equal to Format.INDENT_NOT_SET.

Parameters:

prefix - used for parsing and display, must not be empty.

name - of the variable

indent - must be equal to Format.INDENT_NOT_SET.

Throws:

IllegalArgumentException - if indent in not equal to Format.INDENT_NOT_SET.

IllegalArgumentException - if name is not a valid Java identifier.

See Also:

• Variable.indent(int)

Method Details

eval

public Format eval(Context c,
 boolean partial)

Replace this by the binding defined in the context. If no such binding exists leave this unaltered if partial==true, otherwise throw the exception defined by Variable.bottom().

Overrides:

eval in class Format

Parameters:

c - defines the replacement for variables by name and number.

partial - decides when a Variable not defined in the context is found: if true the Variable stays aunaltered; if false an IllegalArgumentException is thrown.

Returns:

a format with all or some variables replaced