Uses of Package
org.apache.reef.annotations.audience

Packages that use org.apache.reef.annotations.audience

Package	Description
org.apache.reef.bridge.client	Contains the client of the bridge.
org.apache.reef.client	Client APIs for REEF.
org.apache.reef.driver	Driver APIs for REEF in terms of Rx.
org.apache.reef.driver.client	Representations of the Client (i.e.
org.apache.reef.driver.context	Driver Contexts and their configurations.
org.apache.reef.driver.evaluator	Evaluator-related utilities.
org.apache.reef.driver.restart	This package provides restart event service handlers.
org.apache.reef.driver.task	Tasks and their configurations.
org.apache.reef.evaluator.context	Evaluator Contexts.
org.apache.reef.evaluator.context.events	Events signaling change of Evaluator state.
org.apache.reef.evaluator.context.parameters	Named parameters used by the Evaluator.
org.apache.reef.examples.data.loading	A line counter example using data loading service.
org.apache.reef.examples.data.output	Example application using the output service.
org.apache.reef.examples.group.bgd	Runs BGD on the given runtime.
org.apache.reef.examples.group.broadcast	Broadcast Group Communication example.
org.apache.reef.exception	Exceptions thrown to Job Drivers.
org.apache.reef.io	APIs for I/O in REEF: Codecs and Serializers.
org.apache.reef.io.checkpoint.fs	FileSystem based checkpoints.
org.apache.reef.io.data.loading.api	Data Loading Service API.
org.apache.reef.io.data.loading.impl	Implementations of Data Loading Service.
org.apache.reef.io.data.output	Data Output Service.
org.apache.reef.io.naming	Utilities for assigning Identifiers to objects and associating socket addresses with them.
org.apache.reef.io.network.group.api	Elastic Group Communications API.
org.apache.reef.io.network.group.api.config	The operator configurations used by users.
org.apache.reef.io.network.group.api.driver	Elastic Group Communications Driver-side API Interfaces.
org.apache.reef.io.network.group.api.task	Elastic Group Communications Task-side API Interfaces.
org.apache.reef.io.network.group.impl.driver	This package contains the implementation of the driver side of the Group Communication Service using the tree/flat topology.
org.apache.reef.io.watcher.param	Parameters for Watcher.
org.apache.reef.io.watcher.util	Utility classes for Watcher.
org.apache.reef.javabridge	The Java-side of the CLR/Java bridge.
org.apache.reef.javabridge.generic	Generic java bridge driver/client.
org.apache.reef.runtime.common.client	Implementation of the client-side REEF API.
org.apache.reef.runtime.common.client.api	Client-Side Event Handlers to be implemented by a specific resourcemanager.
org.apache.reef.runtime.common.client.defaults	Default implementations for the optional client-side event handlers.
org.apache.reef.runtime.common.client.parameters	Parameters used by client.
org.apache.reef.runtime.common.driver	Implementation of the Driver-side REEF APIs.
org.apache.reef.runtime.common.driver.api	Driver-Side Event Handlers to be implemented by a specific resource manager.
org.apache.reef.runtime.common.driver.catalog	Implementations of descriptors for resources available to a REEF instance (physical nodes, racks etc).
org.apache.reef.runtime.common.driver.client	Objects representing the Client on the Driver.
org.apache.reef.runtime.common.driver.context	Implementations of Driver-Side representations of Contexts running on an Evaluator.
org.apache.reef.runtime.common.driver.evaluator	Driver-Side representations of Evaluators.
org.apache.reef.runtime.common.driver.evaluator.pojos	POJOs in this package encapsulate the content of an EvaluatorHeartbeatProto on the DriverSide.
org.apache.reef.runtime.common.driver.resourcemanager	Classes that interface with the resourcemanager (Local, YARN, ...) in the Driver.
org.apache.reef.runtime.common.driver.task	Driver-Side representations of tasks.
org.apache.reef.runtime.common.evaluator.context	Context implementation of the Evaluator resourcemanager.
org.apache.reef.runtime.common.evaluator.context.defaults	Default implementations for the optional context interfaces.
org.apache.reef.runtime.common.evaluator.task	Task-related implementation of the Evaluator resourcemanager.
org.apache.reef.runtime.common.evaluator.task.defaults	Default implementations for the optional task interfaces.
org.apache.reef.runtime.common.evaluator.task.exceptions	Exceptions thrown by Tasks and Task Handlers.
org.apache.reef.runtime.common.files	This package will contain the implementation of the REEF file system standard.
org.apache.reef.runtime.common.launch	Common launch code between Driver and Evaluator.
org.apache.reef.runtime.common.utils	Runtime utilities used by various REEF modules.
org.apache.reef.runtime.hdinsight.client	The client to submit jobs to HDInsight.
org.apache.reef.runtime.local.driver	The resource manager for the local resourcemanager.
org.apache.reef.runtime.mesos.client	Client-side event handlers for Mesos resourcemanager.
org.apache.reef.runtime.yarn.client	Client-side event handlers for YARN resourcemanager.
org.apache.reef.runtime.yarn.driver	The Driver-Side implementation of the YARN adapter for REEF.
org.apache.reef.runtime.yarn.driver.restart	The package contains classes that are used specifically on restart.
org.apache.reef.runtime.yarn.util	Utility for YARN runtime.
org.apache.reef.task	Tasks.
org.apache.reef.task.events	Task-related events.
org.apache.reef.tests	Tests for REEF implementations.
org.apache.reef.tests.group	Tests for group communication.
org.apache.reef.util	Utilities for using REEF on Hadoop.
org.apache.reef.vortex.api	Vortex user api for running jobs on Vortex.
org.apache.reef.vortex.common	Vortex Code used both in Vortex Driver and Vortex Evaluator.
org.apache.reef.vortex.driver	Vortex Code that runs as part of REEF Driver.
org.apache.reef.vortex.evaluator	Vortex Code that runs as part of REEF Evaluator.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.bridge.client

Class and Description
Interop Indicates that a class, function, or instance variable is used at the Interop layer, and should not be modified or removed without testing, knowing its consequences, and making corresponding changes in C# and C++ code.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.client

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.driver

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.driver.client

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.driver.context

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.driver.evaluator

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.driver.restart

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
Public Annotates code for public consumption.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.driver.task

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.evaluator.context

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.evaluator.context.events

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.evaluator.context.parameters

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.examples.data.loading

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.examples.data.output

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.examples.group.bgd

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.examples.group.broadcast

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
DriverSide Annotates interfaces that are meant to be used in the Job Driver.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.exception

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io

Class and Description
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.checkpoint.fs

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.data.loading.api

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.data.loading.impl

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.data.output

Class and Description
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.naming

Class and Description
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.network.group.api

Class and Description
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.network.group.api.config

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.network.group.api.driver

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.network.group.api.task

Class and Description
Private Annotates code that is meant to be private to the project it is in.
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.network.group.impl.driver

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.watcher.param

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.io.watcher.util

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.javabridge

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Interop Indicates that a class, function, or instance variable is used at the Interop layer, and should not be modified or removed without testing, knowing its consequences, and making corresponding changes in C# and C++ code.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.javabridge.generic

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Interop Indicates that a class, function, or instance variable is used at the Interop layer, and should not be modified or removed without testing, knowing its consequences, and making corresponding changes in C# and C++ code.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.client

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Private Annotates code that is meant to be private to the project it is in.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.client.api

Class and Description
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.client.defaults

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.client.parameters

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.api

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.catalog

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.client

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.context

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.evaluator

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.evaluator.pojos

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.resourcemanager

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.driver.task

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.evaluator.context

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.evaluator.context.defaults

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.evaluator.task

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.evaluator.task.defaults

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.evaluator.task.exceptions

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.files

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Private Annotates code that is meant to be private to the project it is in.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.launch

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.common.utils

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.hdinsight.client

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.local.driver

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.mesos.client

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.yarn.client

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.yarn.driver

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
Public Annotates code for public consumption.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.yarn.driver.restart

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.
RuntimeAuthor Indicates that an interface or API to be consumed or used by authors of additional REEF runtimes, not authors of REEF jobs.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.runtime.yarn.util

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.task

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Public Annotates code for public consumption.
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.task.events

Class and Description
EvaluatorSide Annotates interfaces meant to be used by Evaluators.
Public Annotates code for public consumption.
TaskSide Annotates interfaces meant to be used by Tasks.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.tests

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.tests.group

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.util

Class and Description
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.vortex.api

Class and Description
ClientSide Annotates interface meant to be used by REEF clients.
Private Annotates code that is meant to be private to the project it is in.
Public Annotates code for public consumption.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.vortex.common

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.vortex.driver

Class and Description
DriverSide Annotates interfaces that are meant to be used in the Job Driver.
Private Annotates code that is meant to be private to the project it is in.

Classes in org.apache.reef.annotations.audience used by org.apache.reef.vortex.evaluator

Class and Description
TaskSide Annotates interfaces meant to be used by Tasks.