org.aludratest.impl.log4testing.output.writer
Class VelocityWriter<T extends TestStepContainer>

java.lang.Object
  org.aludratest.impl.log4testing.output.writer.FileWriter<T>
      org.aludratest.impl.log4testing.output.writer.VelocityWriter<T>

Type Parameters:

T - The type of test step container to write

All Implemented Interfaces:

Validatable, Writer<T>

Direct Known Subclasses:

VelocityTestCaseWriter, VelocityTestSuiteWriter

public abstract class VelocityWriter<T extends TestStepContainer>
extends FileWriter<T>

Writes log files based on a Velocity template.

Author:

Marcel Malitz, Volker Bergmann

Nested Class Summary

class	VelocityWriter.HtmlFormat Formats texts in HTML.
class	VelocityWriter.NameFormat Formats names
class	VelocityWriter.TimeFormat Formats Periods.

Constructor Summary

VelocityWriter()

Method Summary

String	getTemplate()
String	getVariable()
void	setTemplate(String template)
void	setVariable(String variable)
void	validate() This method is called by the log4testing framework after the configuration file has been parsed and applied and requests the Writer instance to verify if it was configured properly.
File	write(T testStepContainer, String path) This method gets called by log4testing when the implementing writer class is registered and when log4testing is going to write the logging reports.

Methods inherited from class org.aludratest.impl.log4testing.output.writer.FileWriter

assertNotEmpty, getExtension, getIgnoreableRoot, getOutputDir, isAbbreviating, isHtml, isShortTimeFormat, setAbbreviating, setExtension, setIgnoreableRoot, setOutputDir, setShortTimeFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

VelocityWriter

public VelocityWriter()

Method Detail

setTemplate

public void setTemplate(String template)

Parameters:

template - the template to set

getTemplate

public String getTemplate()

Returns:

the template

setVariable

public void setVariable(String variable)

Parameters:

variable - the variable to set

getVariable

public String getVariable()

Returns:

the variable

validate

public void validate()

Description copied from interface: Validatable

This method is called by the log4testing framework after the configuration file has been parsed and applied and requests the Writer instance to verify if it was configured properly.

Specified by:

validate in interface Validatable

Overrides:

validate in class FileWriter<T extends TestStepContainer>

write

public File write(T testStepContainer,
                  String path)

Description copied from interface: Writer

This method gets called by log4testing when the implementing writer class is registered and when log4testing is going to write the logging reports.

Parameters:

testStepContainer - to be written

Returns:

a reference to the created file