lang/java/reef-common/src/main/java/org/apache/reef/driver/context/ContextBase.java

/*
 * 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.context;

import org.apache.reef.annotations.Provided;
import org.apache.reef.annotations.audience.DriverSide;
import org.apache.reef.annotations.audience.Public;
import org.apache.reef.driver.evaluator.EvaluatorDescriptor;
import org.apache.reef.io.naming.Identifiable;
import org.apache.reef.util.Optional;

/**
 * A common base interface for all Driver-side representations of Contexts.
 */
@Public
@DriverSide
@Provided
public interface ContextBase extends Identifiable {

  /**
   * @return the ID of the Context.
   */
  @Override
  String getId();

  /**
   * @return the identifier of the Evaluator this Context is instantiated on.
   */
  String getEvaluatorId();

  /**
   * @return the ID of the parent context, if there is one.
   */
  Optional<String> getParentId();

  /**
   * @return the descriptor of the Evaluator this Context is on.
   */
  EvaluatorDescriptor getEvaluatorDescriptor();
}