com.github.geko444.im4java.script

Class AbstractScriptGenerator

java.lang.Object

com.github.geko444.im4java.script.AbstractScriptGenerator

All Implemented Interfaces:

ScriptGenerator

Direct Known Subclasses:

BashScriptGenerator, CmdScriptGenerator

public abstract class AbstractScriptGenerator
extends Object
implements ScriptGenerator

This class is an abstract implementation of a ScriptGenerator.

Since:

1.0.0

Version:

$Revision: 1.7 $

Author:

$Author: bablokb $

Field Summary

Fields

Modifier and Type	Field and Description
protected char	ESC_EOL The EOL escape character.
protected char	ESC_SPECIAL The escape character for special characters.
protected int	iArgIndex The current script-argument-index.
protected String	iIndent The current indentation-level.
protected StringBuilder	iLineBuffer The current line-buffer.
protected static int	LINE_SIZE The maximum linesize.

Constructor Summary

Constructors

Constructor and Description
AbstractScriptGenerator()

Method Summary

Modifier and Type	Method and Description
void	createScript() Generate the script.
Operation	getOperation() Return the Operation-object.
Properties	getProperties() Return the Properties-object.
protected String	getScriptArg(String pToken) Return the token as a script-argument.
protected String	getSearchPath() Return the search-path in a plattform-dependent way.
PrintWriter	getWriter() Return the PrintWriter-object.
void	init(PrintWriter pWriter, Operation pOp, Properties pProps) Intialize the generator.
protected String	quote(String pString) Quote the given string.
protected void	writeCommand() Write the ImageCommand to the script-file.
protected void	writeHeader() Write the header of the script.
protected void	writeOperation() Write the Operation to the script-file.

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SIZE

protected static final int LINE_SIZE

The maximum linesize.

See Also:

Constant Field Values

ESC_EOL

protected char ESC_EOL

The EOL escape character.

ESC_SPECIAL

protected char ESC_SPECIAL

The escape character for special characters.

iIndent

protected String iIndent

The current indentation-level.

iLineBuffer

protected StringBuilder iLineBuffer

The current line-buffer.

iArgIndex

protected int iArgIndex

The current script-argument-index.

Constructor Detail

AbstractScriptGenerator

public AbstractScriptGenerator()

Method Detail

createScript

public void createScript()

Generate the script.

Specified by:

createScript in interface ScriptGenerator

writeHeader

protected void writeHeader()

Write the header of the script. This method must be implemented by subclasses.

getSearchPath

protected String getSearchPath()

Return the search-path in a plattform-dependent way.

writeCommand

protected void writeCommand()

Write the ImageCommand to the script-file. This is a default implementation which should do for most cases.

getScriptArg

protected String getScriptArg(String pToken)

Return the token as a script-argument. Normally, the argument token is only part of the script-argument if it contains a [wxh+x+y]-read-spec.

This method must be implemented by subclasses.

quote

protected String quote(String pString)

Quote the given string. This method must be implemented by subclasses.

writeOperation

protected void writeOperation()

Write the Operation to the script-file.

init

public void init(PrintWriter pWriter,
                 Operation pOp,
                 Properties pProps)

Intialize the generator.

Specified by:

init in interface ScriptGenerator

getWriter

public PrintWriter getWriter()

Return the PrintWriter-object.

getOperation

public Operation getOperation()

Return the Operation-object.

getProperties

public Properties getProperties()

Return the Properties-object.