Module org.glassfish.main.jul

Package org.glassfish.main.jul.handler

Enum Class FileHandlerProperty

java.lang.Object

java.lang.Enum<FileHandlerProperty>

org.glassfish.main.jul.handler.FileHandlerProperty

All Implemented Interfaces:

Serializable, Comparable<FileHandlerProperty>, Constable, LogProperty

public enum FileHandlerProperty
extends Enum<FileHandlerProperty>
implements LogProperty

Configuration property set of the FileHandler.

Author:

David Matejcek

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
APPEND	Whether the FileHandler should append onto any existing files (defaults to false).
COUNT	How many output files to cycle through (defaults to 1).
ENCODING	Name of the character set encoding to use (defaults to the default platform encoding).
FILTER	Name of a Filter class to use (defaults to no Filter).
FORMATTER	Class of the Formatter used with this handler
LEVEL	The default level for the Handler (defaults to Level.ALL).
LIMIT	approximate maximum amount to write (in bytes) to any one file.
MAXLOCKS	Maximum number of concurrent locks held by FileHandler (defaults to 100).
PATTERN	Output file name patten, default: %h/java%u.log

Method Summary

Modifier and Type	Method	Description
String	getPropertyFullName()
String	getPropertyName()
static FileHandlerProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FileHandlerProperty[]	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

Methods inherited from interface org.glassfish.main.jul.cfg.LogProperty

getPropertyFullName, getPropertyFullName

Enum Constant Details

APPEND

public static final FileHandlerProperty APPEND

Whether the FileHandler should append onto any existing files (defaults to false).

COUNT

public static final FileHandlerProperty COUNT

How many output files to cycle through (defaults to 1).

FILTER

public static final FileHandlerProperty FILTER

Name of a Filter class to use (defaults to no Filter).

FORMATTER

public static final FileHandlerProperty FORMATTER

Class of the Formatter used with this handler

ENCODING

public static final FileHandlerProperty ENCODING

Name of the character set encoding to use (defaults to the default platform encoding).

LEVEL

public static final FileHandlerProperty LEVEL

The default level for the Handler (defaults to Level.ALL).

LIMIT

public static final FileHandlerProperty LIMIT

approximate maximum amount to write (in bytes) to any one file. If this is zero, then there is no limit. (Defaults to no limit).

MAXLOCKS

public static final FileHandlerProperty MAXLOCKS

Maximum number of concurrent locks held by FileHandler (defaults to 100).

PATTERN

public static final FileHandlerProperty PATTERN

Output file name patten, default: %h/java%u.log

Method Details

values

public static FileHandlerProperty[] 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 FileHandlerProperty 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

getPropertyName

public String getPropertyName()

Specified by:

getPropertyName in interface LogProperty

Returns:

a name of the property, used as a last part of property name in logging.properties

getPropertyFullName

public String getPropertyFullName()

Returns:

full name using the FileHandler class.