Package org.apache.hadoop.fs.s3a.impl.streams

Enum Class InputStreamType

java.lang.Object

java.lang.Enum<InputStreamType>

org.apache.hadoop.fs.s3a.impl.streams.InputStreamType

All Implemented Interfaces:

Serializable, Comparable<InputStreamType>, Constable

public enum InputStreamType
extends Enum<InputStreamType>

Enum of input stream types.

Each enum value contains the factory function actually used to create the factory.

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
Analytics	The analytics input stream.
Classic	The classic input stream.
Custom	The a custom input stream.
Prefetch	The prefetching input stream.

Method Summary

Modifier and Type	Method	Description
String	capability()	Get the capability string for this stream type.
Function<Configuration,org.apache.hadoop.fs.s3a.impl.streams.ObjectInputStreamFactory>	factory()	Factory constructor.
String	getName()	String name.
int	streamID()	Get the ID of this stream.
static InputStreamType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InputStreamType[]	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

Classic

public static final InputStreamType Classic

The classic input stream.

Prefetch

public static final InputStreamType Prefetch

The prefetching input stream.

Analytics

public static final InputStreamType Analytics

The analytics input stream.

Custom

public static final InputStreamType Custom

The a custom input stream.

Method Details

values

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

getName

public String getName()

String name.

Returns:

the name

streamID

public int streamID()

Get the ID of this stream. Isolated from the enum ID in case it ever needs to be tuned.

Returns:

the numeric ID of the stream.

capability

public String capability()

Get the capability string for this stream type.

Returns:

the name of a string to probe for.

factory

public Function<Configuration,org.apache.hadoop.fs.s3a.impl.streams.ObjectInputStreamFactory> factory()

Factory constructor.

Returns:

the factory function associated with this stream type.