FlowletConnection.java

/*
 * Copyright © 2014 Cask Data, Inc.
 *
 * Licensed 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 co.cask.cdap.api.flow;

/**
 * Defines a connection between two {@link co.cask.cdap.api.flow.flowlet.Flowlet Flowlets} or
 * from a {@link co.cask.cdap.api.data.stream.Stream Stream} to a
 * {@link co.cask.cdap.api.flow.flowlet.Flowlet Flowlet}.
 */
public final class FlowletConnection {

  /**
   * Defines different types of sources a flowlet can be connected to.
   */
  public enum Type {
    STREAM,
    FLOWLET
  }

  private final Type sourceType;
  private final String sourceName;
  private final String targetName;

  public FlowletConnection(Type sourceType, String sourceName, String targetName) {
    this.sourceType = sourceType;
    this.sourceName = sourceName;
    this.targetName = targetName;
  }

  /**
   * @return Type of source.
   */
  public Type getSourceType() {
    return sourceType;
  }

  /**
   * @return Name of the source.
   */
  public String getSourceName() {
    return sourceName;
  }

  /**
   * @return Name of the flowlet the connection is connected to.
   */
  public String getTargetName() {
    return targetName;
  }
}