org.apache.reef.driver.task.TaskConfigurationOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reef-common Show documentation
There is a newer version: 0.16.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.reef.driver.task;

import org.apache.reef.annotations.Provided;
import org.apache.reef.annotations.audience.DriverSide;
import org.apache.reef.annotations.audience.Public;
import org.apache.reef.runtime.common.evaluator.task.defaults.DefaultCloseHandler;
import org.apache.reef.runtime.common.evaluator.task.defaults.DefaultDriverMessageHandler;
import org.apache.reef.runtime.common.evaluator.task.defaults.DefaultSuspendHandler;
import org.apache.reef.tang.annotations.Name;
import org.apache.reef.tang.annotations.NamedParameter;
import org.apache.reef.task.TaskMessageSource;
import org.apache.reef.task.events.*;
import org.apache.reef.wake.EventHandler;

import java.util.Set;

/**
 * Configuration parameters for the TaskConfiguration class.
 */
@Public
@DriverSide
@Provided
public final class TaskConfigurationOptions {

  /**
   * The Identifier of the Task.
   */
  @NamedParameter(default_value = "Unnamed Task", doc = "The Identifier of the Task")
  public static final class Identifier implements Name {
  }

  /**
   * The memento to be used for the Task.
   */
  @NamedParameter(doc = "The memento to be used for the Task.")
  public final class Memento implements Name {
  }

  /**
   * TaskMessageSource instances.
   */
  @NamedParameter(doc = "TaskMessageSource instances.")
  public final class TaskMessageSources implements Name> {
  }

  /**
   * The set of event handlers for the TaskStart event.
   */
  @NamedParameter(doc = "The set of event handlers for the TaskStart event.")
  public final class StartHandlers implements Name>> {
  }

  /**
   * The set of event handlers for the TaskStop event.
   */
  @NamedParameter(doc = "The set of event handlers for the TaskStop event.")
  public final class StopHandlers implements Name>> {
  }

  /**
   * The event handler that receives the close event.
   */
  @NamedParameter(doc = "The event handler that receives the close event.",
      default_class = DefaultCloseHandler.class)
  public final class CloseHandler implements Name> {
  }

  /**
   * The event handler that receives the suspend event.
   */
  @NamedParameter(doc = "The event handler that receives the suspend event.",
      default_class = DefaultSuspendHandler.class)
  public final class SuspendHandler implements Name> {
  }

  /**
   * The event handler that receives messages from the driver.
   */
  @NamedParameter(doc = "The event handler that receives messages from the driver.",
      default_class = DefaultDriverMessageHandler.class)
  public final class MessageHandler implements Name> {
  }
}