Package tr.com.havelsan.javarch.report.rtool.starter.engine.naming

Enum Class HvlRToolReportFileNamingStrategy

java.lang.Object

java.lang.Enum<HvlRToolReportFileNamingStrategy>

tr.com.havelsan.javarch.report.rtool.starter.engine.naming.HvlRToolReportFileNamingStrategy

All Implemented Interfaces:

Serializable, Comparable<HvlRToolReportFileNamingStrategy>, Constable

public enum HvlRToolReportFileNamingStrategy
extends Enum<HvlRToolReportFileNamingStrategy>

The type represents reporting tool report file naming strategies.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT
TIMESTAMPED

Method Summary

Modifier and Type	Method	Description
final String	generateFilename(String reportName, HvlRToolReportMediaType exportingMediaType)	Generate filename string.
protected abstract String	onGenerateFilename(String reportName, HvlRToolReportMediaType exportingMediaType)	On generate filename string.
static HvlRToolReportFileNamingStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HvlRToolReportFileNamingStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFAULT

public static final HvlRToolReportFileNamingStrategy DEFAULT

TIMESTAMPED

public static final HvlRToolReportFileNamingStrategy TIMESTAMPED

Method Details

values

public static HvlRToolReportFileNamingStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static HvlRToolReportFileNamingStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

generateFilename

public final String generateFilename(String reportName,
 HvlRToolReportMediaType exportingMediaType)

Generate filename string.

Parameters:

reportName - the report name

exportingMediaType - the exporting media type

Returns:

the string

onGenerateFilename

protected abstract String onGenerateFilename(String reportName,
 HvlRToolReportMediaType exportingMediaType)

On generate filename string.

Parameters:

reportName - the report name

exportingMediaType - the exporting media type

Returns:

the string