com.asakusafw.yaess.flowlog

Class FlowLoggerProfile

java.lang.Object

com.asakusafw.yaess.flowlog.FlowLoggerProfile

public class FlowLoggerProfile
extends Object

A structured profile for FlowLoggerProvider.

Since:

0.2.6

Method Summary

Modifier and Type	Method and Description
static FlowLoggerProfile	convert(ServiceProfile<?> profile) Converts the generic profile into the structured profile about FlowLogger.
DateFormat	getDateFormat() Returns the log date format.
File	getDirectory() Returns the base directory of log output target.
Charset	getEncoding() Returns the log output encoding.
File	getEscapeFile(ExecutionContext context) Returns abstract path for the escaped log file.
File	getLogFile(ExecutionContext context) Returns abstract path for the target log file.
double	getStepUnit() Returns the step unit.
boolean	isDeleteOnCleanup() Returns whether delete logs after cleanup phase was succeeded.
boolean	isDeleteOnSetup() Returns whether delete logs before cleanup phase was started.
boolean	isReportJob() Returns whether report job status.

Methods inherited from class java.lang.Object

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

Method Detail

getDirectory

public File getDirectory()

Returns the base directory of log output target.

Returns:

the output base directory

getEncoding

public Charset getEncoding()

Returns the log output encoding.

Returns:

the log output encoding

getDateFormat

public DateFormat getDateFormat()

Returns the log date format.

Returns:

the log date format

getStepUnit

public double getStepUnit()

Returns the step unit.

Returns:

the step unit

isReportJob

public boolean isReportJob()

Returns whether report job status.

Returns:

true to report job status, otherwise false

isDeleteOnSetup

public boolean isDeleteOnSetup()

Returns whether delete logs before cleanup phase was started.

Returns:

true to delete logs, otherwise false

Throws:

IllegalArgumentException - if some parameters were null

isDeleteOnCleanup

public boolean isDeleteOnCleanup()

Returns whether delete logs after cleanup phase was succeeded.

Returns:

true to delete logs, otherwise false

Throws:

IllegalArgumentException - if some parameters were null

getLogFile

public File getLogFile(ExecutionContext context)

Returns abstract path for the target log file.

Parameters:

context - current context

Returns:

target log file

Throws:

IllegalArgumentException - if some parameters were null

getEscapeFile

public File getEscapeFile(ExecutionContext context)

Returns abstract path for the escaped log file.

Parameters:

context - current context

Returns:

escaped log file

Throws:

IllegalArgumentException - if some parameters were null

convert

public static FlowLoggerProfile convert(ServiceProfile<?> profile)

Converts the generic profile into the structured profile about FlowLogger.

Parameters:

profile - the target profile

Returns:

the converted profile

Throws:

IllegalArgumentException - if some parameters were invalid