Environment (flink-runtime 0.8.1-hadoop1 API)

All Known Implementing Classes:

RuntimeEnvironment
```
public interface Environment
```
The user code of every Nephele task runs inside an Environment object. The environment provides important services to the task. It keeps track of setting up the communication channels and provides access to input splits, memory manager, etc.

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends IOReadableWritable> InputGate<T>`	`createAndRegisterInputGate()` Creates a new InputGate and registers it with the Environment.
`OutputGate`	`createAndRegisterOutputGate()` Creates a new OutputGate and registers it with the Environment.
`AccumulatorProtocol`	`getAccumulatorProtocolProxy()` Returns the proxy object for the accumulator protocol.
`BroadcastVariableManager`	`getBroadcastVariableManager()`
`Map<String,FutureTask<Path>>`	`getCopyTask()`
`int`	`getCurrentNumberOfSubtasks()` Returns the current number of subtasks the respective task is split into.
`int`	`getIndexInSubtaskGroup()` Returns the index of this subtask in the subtask group.
`Set<ChannelID>`	`getInputChannelIDs()` Returns the IDs of all input channels connected to this environment.
`Set<ChannelID>`	`getInputChannelIDsOfGate(GateID gateID)` Returns the IDs of all the input channels connected to the gate with the given ID.
`Set<GateID>`	`getInputGateIDs()` Returns the IDs of all input gates connected to this environment.
`InputSplitProvider`	`getInputSplitProvider()` Returns the input split provider assigned to this environment.
`IOManager`	`getIOManager()` Returns the current `IOManager`.
`Configuration`	`getJobConfiguration()` Returns the job configuration object which was attached to the original `JobGraph`.
`JobID`	`getJobID()` Returns the ID of the job from the original job graph.
`JobVertexID`	`getJobVertexId()` Gets the ID of the jobVertex that this task corresponds to.
`MemoryManager`	`getMemoryManager()` Returns the current `MemoryManager`.
`GateID`	`getNextUnboundInputGateID()` Returns the next unbound input gate ID or `null` if no such ID exists
`int`	`getNumberOfInputChannels()` Returns the number of input channels attached to this environment.
`int`	`getNumberOfInputGates()` Returns the number of input gates registered with this environment.
`int`	`getNumberOfOutputChannels()` Returns the number of output channels attached to this environment.
`int`	`getNumberOfOutputGates()` Returns the number of output gates registered with this environment.
`BufferProvider`	`getOutputBufferProvider()` Returns the buffer provider for this environment.
`Set<ChannelID>`	`getOutputChannelIDs()` Returns the IDs of all output channels connected to this environment.
`Set<ChannelID>`	`getOutputChannelIDsOfGate(GateID gateID)` Returns the IDs of all the output channels connected to the gate with the given ID.
`Set<GateID>`	`getOutputGateIDs()` Returns the IDs of all output gates connected to this environment.
`Configuration`	`getTaskConfiguration()` Returns the task configuration object which was attached to the original JobVertex.
`String`	`getTaskName()` Returns the name of the task running in this environment.
`ClassLoader`	`getUserClassLoader()` Returns the user code class loader

- Method Detail
  - getJobID
```
JobID getJobID()
```
    Returns the ID of the job from the original job graph. It is used by the library cache manager to find the required libraries for executing the assigned Nephele task.
    
    Returns:
    the ID of the job from the original job graph
  - getJobVertexId
```
JobVertexID getJobVertexId()
```
    Gets the ID of the jobVertex that this task corresponds to.
    
    Returns:
    The JobVertexID of this task.
  - getTaskConfiguration
```
Configuration getTaskConfiguration()
```
    Returns the task configuration object which was attached to the original JobVertex.
    
    Returns:
    the task configuration object which was attached to the original JobVertex.
  - getJobConfiguration
```
Configuration getJobConfiguration()
```
    Returns the job configuration object which was attached to the original JobGraph.
    
    Returns:
    the job configuration object which was attached to the original JobGraph
  - getCurrentNumberOfSubtasks
```
int getCurrentNumberOfSubtasks()
```
    Returns the current number of subtasks the respective task is split into.
    
    Returns:
    the current number of subtasks the respective task is split into
  - getIndexInSubtaskGroup
```
int getIndexInSubtaskGroup()
```
    Returns the index of this subtask in the subtask group.
    
    Returns:
    the index of this subtask in the subtask group
  - getInputSplitProvider
```
InputSplitProvider getInputSplitProvider()
```
    Returns the input split provider assigned to this environment.
    
    Returns:
    the input split provider or null if no such provider has been assigned to this environment.
  - getIOManager
```
IOManager getIOManager()
```
    Returns the current IOManager.
    
    Returns:
    the current IOManager.
  - getMemoryManager
```
MemoryManager getMemoryManager()
```
    Returns the current MemoryManager.
    
    Returns:
    the current MemoryManager.
  - getTaskName
```
String getTaskName()
```
    Returns the name of the task running in this environment.
    
    Returns:
    the name of the task running in this environment
  - getNextUnboundInputGateID
```
GateID getNextUnboundInputGateID()
```
    Returns the next unbound input gate ID or null if no such ID exists
    
    Returns:
    the next unbound input gate ID or null if no such ID exists
  - getNumberOfOutputGates
```
int getNumberOfOutputGates()
```
    Returns the number of output gates registered with this environment.
    
    Returns:
    the number of output gates registered with this environment
  - getNumberOfInputGates
```
int getNumberOfInputGates()
```
    Returns the number of input gates registered with this environment.
    
    Returns:
    the number of input gates registered with this environment
  - getNumberOfOutputChannels
```
int getNumberOfOutputChannels()
```
    Returns the number of output channels attached to this environment.
    
    Returns:
    the number of output channels attached to this environment
  - getNumberOfInputChannels
```
int getNumberOfInputChannels()
```
    Returns the number of input channels attached to this environment.
    
    Returns:
    the number of input channels attached to this environment
  - createAndRegisterOutputGate
```
OutputGate createAndRegisterOutputGate()
```
    Creates a new OutputGate and registers it with the Environment.
    
    Returns:
    the newly created output gate
  - createAndRegisterInputGate
```
<T extends IOReadableWritable> InputGate<T> createAndRegisterInputGate()
```
    Creates a new InputGate and registers it with the Environment.
  - getOutputChannelIDs
```
Set<ChannelID> getOutputChannelIDs()
```
    Returns the IDs of all output channels connected to this environment.
    
    Returns:
    the IDs of all output channels connected to this environment
  - getInputChannelIDs
```
Set<ChannelID> getInputChannelIDs()
```
    Returns the IDs of all input channels connected to this environment.
    
    Returns:
    the IDs of all input channels connected to this environment
  - getOutputGateIDs
```
Set<GateID> getOutputGateIDs()
```
    Returns the IDs of all output gates connected to this environment.
    
    Returns:
    the IDs of all output gates connected to this environment
  - getInputGateIDs
```
Set<GateID> getInputGateIDs()
```
    Returns the IDs of all input gates connected to this environment.
    
    Returns:
    the IDs of all input gates connected to this environment
  - getOutputChannelIDsOfGate
```
Set<ChannelID> getOutputChannelIDsOfGate(GateID gateID)
```
    Returns the IDs of all the output channels connected to the gate with the given ID.
    
    Parameters:
    gateID - the gate ID
    
    Returns:
    the IDs of all the output channels connected to the gate with the given ID
  - getInputChannelIDsOfGate
```
Set<ChannelID> getInputChannelIDsOfGate(GateID gateID)
```
    Returns the IDs of all the input channels connected to the gate with the given ID.
    
    Parameters:
    gateID - the gate ID
    
    Returns:
    the IDs of all the input channels connected to the gate with the given ID
  - getAccumulatorProtocolProxy
```
AccumulatorProtocol getAccumulatorProtocolProxy()
```
    Returns the proxy object for the accumulator protocol.
  - getUserClassLoader
```
ClassLoader getUserClassLoader()
```
    Returns the user code class loader
    
    Returns:
    user code class loader
  - getOutputBufferProvider
```
BufferProvider getOutputBufferProvider()
```
    Returns the buffer provider for this environment.
    The returned buffer provider is used by the output side of the network stack.
    
    Returns:
    Buffer provider for the output side of the network stack
    See Also:
    RecordWriter
  - getCopyTask
```
Map<String,FutureTask<Path>> getCopyTask()
```
  - getBroadcastVariableManager
```
BroadcastVariableManager getBroadcastVariableManager()
```

Interface Environment

Method Summary

Method Detail

getJobID

getJobVertexId

getTaskConfiguration

getJobConfiguration

getCurrentNumberOfSubtasks

getIndexInSubtaskGroup

getInputSplitProvider

getIOManager

getMemoryManager

getTaskName

getNextUnboundInputGateID

getNumberOfOutputGates

getNumberOfInputGates

getNumberOfOutputChannels

getNumberOfInputChannels

createAndRegisterOutputGate

createAndRegisterInputGate

getOutputChannelIDs

getInputChannelIDs

getOutputGateIDs

getInputGateIDs

getOutputChannelIDsOfGate

getInputChannelIDsOfGate

getAccumulatorProtocolProxy

getUserClassLoader

getOutputBufferProvider

getCopyTask

getBroadcastVariableManager