tez-api/src/main/java/org/apache/tez/runtime/api/LogicalInput.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.tez.runtime.api;

/**
 * An @link {@link Input} which handles all incoming physical connections on an
 * edge. A {@link LogicalIOProcessor} sees a single Logical Input per incoming
 * edge.
 */
public interface LogicalInput extends Input {

  /**
   * Sets the number of physical inputs that this <code>LogicalInput</code> will
   * receive. This will be called by the Tez framework before initializing the
   * <code>LogicalInput</code>
   * 
   * @param numInputs
   *          the number of physical inputs.
   */
  public void setNumPhysicalInputs(int numInputs);
}