org.vishia.util

Class OutTextPreparer.DataTextPreparer

java.lang.Object

org.vishia.util.OutTextPreparer.DataTextPreparer

Enclosing class:

OutTextPreparer

public static class OutTextPreparer.DataTextPreparer
extends java.lang.Object

Instances of this class holds the data for one OutTextPreparer instance but maybe for all invocations. An instance can be gotten from OutTextPreparer.createArgumentDataObj() proper and associated to the out text. The constructor of this class is not public, it should be only gotten with this routine.

Invoke setArgument(String, Object) to set any named argument.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.Object[]	args Array of all arguments.
(package private) java.util.Map<java.lang.String,java.lang.Object>	argsByName This is only to see the arguments for debug.
(package private) java.util.Map<java.lang.String,DataAccess.IntegerIx>	argsIxByName This is only to see the arguments for debug.
(package private) OutTextPreparer.DataTextPreparer[]	argSub Any <call in the pattern get the data for the called OutTextPreparer, but only ones, reused.
(package private) boolean	bChecks
(package private) CalculatorExpr.Data	calcExprData Set on first usage.
int	debugIxCmd
java.lang.String	debugOtx
(package private) java.lang.Object	execObj The instance where the <:exec:operation(...)> are located. null if not necessary.
(package private) java.util.Formatter	formatter Default use formatter for ENCLISH to be international.
(package private) java.lang.Appendable	logExec If this is not null, the line of the cmd is written into on certain cmds.
(package private) OutTextPreparer	prep The associated const data for OutText preparation used for setArgument(String, Object) by name.
(package private) java.lang.StringBuilder	sbFormatted

Constructor Summary

Constructors

Constructor and Description
DataTextPreparer(OutTextPreparer prep) Package private constructor invoked only in OutTextPreparer.createArgumentDataObj()

Method Summary

Modifier and Type	Method and Description
void	setArgument(int ixArg, java.lang.Object value) User routine to set a argument with an index in order of the argument list with a value.
void	setArgument(java.lang.String name, java.lang.Object value) User routine to set a named argument with a value.
boolean	setArgumentOptional(java.lang.String name, java.lang.Object value) User routine to set a optional argument with a value.
void	setCheck(boolean bChecks) Switches check of some stuff on or off, especially <:type: check
void	setDebug(java.lang.String patternName, int ixCmd) Sets a debug point.
void	setExecObj(java.lang.Object data) Sets an instance due to the given 'execClass' for the script.
void	setLogCmdline(java.lang.Appendable log) Sets an output channel to output the line on certain cmds.

Methods inherited from class java.lang.Object

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

Field Detail

prep

final OutTextPreparer prep

The associated const data for OutText preparation used for setArgument(String, Object) by name.

execObj

java.lang.Object execObj

The instance where the <:exec:operation(...)> are located. null if not necessary.

args

final java.lang.Object[] args

Array of all arguments. It is sorted to the OutTextPreparer.nameVariables with its value DataAccess.IntegerIx.

argsByName

java.util.Map<java.lang.String,java.lang.Object> argsByName

This is only to see the arguments for debug.

argsIxByName

final java.util.Map<java.lang.String,DataAccess.IntegerIx> argsIxByName

This is only to see the arguments for debug.

argSub

OutTextPreparer.DataTextPreparer[] argSub

Any <call in the pattern get the data for the called OutTextPreparer, but only ones, reused.

calcExprData

CalculatorExpr.Data calcExprData

Set on first usage.

debugOtx

public java.lang.String debugOtx

debugIxCmd

public int debugIxCmd

logExec

java.lang.Appendable logExec

If this is not null, the line of the cmd is written into on certain cmds. It is for a log of execution.

sbFormatted

java.lang.StringBuilder sbFormatted

formatter

java.util.Formatter formatter

Default use formatter for ENCLISH to be international.

bChecks

boolean bChecks

Constructor Detail

DataTextPreparer

DataTextPreparer(OutTextPreparer prep)

Package private constructor invoked only in OutTextPreparer.createArgumentDataObj()

Method Detail

setArgument

public void setArgument(java.lang.String name,
                        java.lang.Object value)

User routine to set a named argument with a value. If a faulty name is used, an Exception is thrown

Parameters:

name - argument name of the argument list given in the constructor OutTextPreparer#OutTextPreparer(String, Object, String, String), 3. argment or also given in the textual script.

value - any value for this argument.

setArgumentOptional

public boolean setArgumentOptional(java.lang.String name,
                                   java.lang.Object value)

User routine to set a optional argument with a value. This operation can be used if some text templates are possible, some have more arguments. Then try to set all possible and not obligate arguments with this operation.

Parameters:

name - argument name of the argument list given in the constructor OutTextPreparer#OutTextPreparer(String, Object, String, String), 3. argment or also given in the textual script.

value - any value for this argument.

Returns:

true if set, false if the argument does not exists.

setArgument

public void setArgument(int ixArg,
                        java.lang.Object value)

User routine to set a argument with an index in order of the argument list with a value.

Parameters:

ixArg - index of the argument starting with 0 for the first argument in the list.

value - any value for this argument.

setLogCmdline

public void setLogCmdline(java.lang.Appendable log)

Sets an output channel to output the line on certain cmds. It is for a log of execution.

Parameters:

log -

setExecObj

public void setExecObj(java.lang.Object data)

Sets an instance due to the given 'execClass' for the script.

Parameters:

data - The instance must be proper to the 'execClass' argument of the constructors respectively to the OutTextPreparer#readTemplateCreatePreparer(InputStream, String, Class, Map, String). If it does not match, an exception is thrown while processing a non static <:exec:operation(...)>

setDebug

public void setDebug(java.lang.String patternName,
                     int ixCmd)

Sets a debug point. You have to set a breakpoint on usage position. It is only for internal debug.

Parameters:

patternName - Because the debug info is copied to called pattern, the name of the called pattern is possible here.

ixCmd - Use 0 to stop in the start cmd, see the commands with data debug, then decide.

setCheck

public void setCheck(boolean bChecks)

Switches check of some stuff on or off, especially <:type: check

Parameters:

bCheck - true check on Hint for user: Set in anyway from a one time set boolean variable.