Package com.arpnetworking.metrics.common.tailer

Enum Class InitialPosition

java.lang.Object

java.lang.Enum<InitialPosition>

com.arpnetworking.metrics.common.tailer.InitialPosition

All Implemented Interfaces:

Serializable, Comparable<InitialPosition>, Constable

public enum InitialPosition
extends Enum<InitialPosition>

Represents the initial position for a tailer.

Author:

Brandon Arp (brandon dot arp at inscopemetrics dot io)

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
END	Start at the end of a file.
START	Start at the beginning of a file.

Method Summary

Modifier and Type	Method	Description
abstract long	get(SeekableByteChannel channel)	Given a SeekableByteChannel, returns the position in that stream to start from.
static InitialPosition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InitialPosition[]	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

START

public static final InitialPosition START

Start at the beginning of a file.

END

public static final InitialPosition END

Start at the end of a file.

Method Details

values

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

get

public abstract long get(SeekableByteChannel channel)

Given a SeekableByteChannel, returns the position in that stream to start from.

Parameters:

channel - Channel to evaluate the position against

Returns:

The position (in bytes) to start reading