org.osgi.service.log.stream

Enum LogStreamProvider.Options

java.lang.Object

java.lang.Enum<LogStreamProvider.Options>

org.osgi.service.log.stream.LogStreamProvider.Options

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LogStreamProvider.Options>

Enclosing interface:

LogStreamProvider

public static enum LogStreamProvider.Options
extends java.lang.Enum<LogStreamProvider.Options>

Creation options for the PushStream of LogEntry objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HISTORY Include history.

Method Summary

Modifier and Type	Method and Description
static LogStreamProvider.Options	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LogStreamProvider.Options[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HISTORY

public static final LogStreamProvider.Options HISTORY

Include history.

Prime the created PushStream with the available historical LogEntry objects. The number of available LogEntry objects is implementation specific.

The created PushStream will supply the available historical LogEntry objects followed by newly created LogEntry objects.

Method Detail

values

public static LogStreamProvider.Options[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LogStreamProvider.Options c : LogStreamProvider.Options.values())
    System.out.println(c);

Returns:

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

valueOf

public static LogStreamProvider.Options valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null