Package echo.parameter

Class PluginParameters

java.lang.Object

echo.parameter.PluginParameters

public class PluginParameters
extends java.lang.Object

Contains all parameters that are sent to the plugin

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	appendToFile
private java.io.File	basePath
private boolean	characterOutput
private java.lang.String	encoding
private boolean	force
private java.lang.String	fromFile
private OutputLevelType	level
private LineSeparator	lineSeparator
private java.lang.String	message
private java.lang.String	toFile

Constructor Summary

Constructors

Constructor	Description
PluginParameters(java.lang.String message, java.lang.String fromFile, java.io.File basePath, java.lang.String toFile, boolean appendToFile, boolean force, OutputLevelType level, java.lang.String encoding, LineSeparator lineSeparator, boolean characterOutput)	Creates an instance of PluginParameters with user-supplied plugin parameters

Method Summary

Modifier and Type	Method	Description
java.io.File	getBasePath()
java.lang.String	getEncoding()
java.lang.String	getFromFile()
OutputLevelType	getLevel()
LineSeparator	getLineSeparator()
java.lang.String	getMessage()
java.lang.String	getToFile()
boolean	isAppendToFile()
boolean	isCharacterOutput()
boolean	isForce()

Methods inherited from class java.lang.Object

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

Field Detail

message

private final java.lang.String message

fromFile

private final java.lang.String fromFile

basePath

private final java.io.File basePath

toFile

private final java.lang.String toFile

appendToFile

private final boolean appendToFile

force

private final boolean force

level

private final OutputLevelType level

encoding

private final java.lang.String encoding

lineSeparator

private final LineSeparator lineSeparator

characterOutput

private final boolean characterOutput

Constructor Detail

PluginParameters

public PluginParameters(java.lang.String message,
                        java.lang.String fromFile,
                        java.io.File basePath,
                        java.lang.String toFile,
                        boolean appendToFile,
                        boolean force,
                        OutputLevelType level,
                        java.lang.String encoding,
                        LineSeparator lineSeparator,
                        boolean characterOutput)

Creates an instance of PluginParameters with user-supplied plugin parameters

Method Detail

getMessage

public java.lang.String getMessage()

getFromFile

public java.lang.String getFromFile()

getBasePath

public java.io.File getBasePath()

getToFile

public java.lang.String getToFile()

isAppendToFile

public boolean isAppendToFile()

isForce

public boolean isForce()

getLevel

public OutputLevelType getLevel()

getEncoding

public java.lang.String getEncoding()

getLineSeparator

public LineSeparator getLineSeparator()

isCharacterOutput

public boolean isCharacterOutput()