org.apache.tez.runtime.common.objectregistry
Enum ObjectLifeCycle

java.lang.Object
  extended by java.lang.Enum<ObjectLifeCycle>
      extended by org.apache.tez.runtime.common.objectregistry.ObjectLifeCycle
All Implemented Interfaces:
Serializable, Comparable<ObjectLifeCycle>

public enum ObjectLifeCycle
extends Enum<ObjectLifeCycle>

Defines the valid lifecycle and scope of Objects stored in ObjectRegistry. Objects are guaranteed to not be valid outside of their defined life-cycle period. Objects are not guaranteed to be retained through the defined period as they may be evicted for various reasons.


Enum Constant Summary
DAG
          Objects are valid for the lifetime of the DAG.
SESSION
          Objects are valid for the lifetime of the Tez JVM/Session
VERTEX
          Objects are valid for the lifetime of the Vertex.
 
Method Summary
static ObjectLifeCycle valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ObjectLifeCycle[] 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

SESSION

public static final ObjectLifeCycle SESSION
Objects are valid for the lifetime of the Tez JVM/Session


DAG

public static final ObjectLifeCycle DAG
Objects are valid for the lifetime of the DAG.


VERTEX

public static final ObjectLifeCycle VERTEX
Objects are valid for the lifetime of the Vertex.

Method Detail

values

public static ObjectLifeCycle[] 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 (ObjectLifeCycle c : ObjectLifeCycle.values())
    System.out.println(c);

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

valueOf

public static ObjectLifeCycle valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2014 Apache Software Foundation. All rights reserved.