com.datatorrent.lib.join.TimeEvent Maven / Gradle / Ivy

Go to download
/**
 * 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 com.datatorrent.lib.join;

import org.apache.hadoop.classification.InterfaceStability;

@InterfaceStability.Unstable
/**
 * @since 3.4.0
 */
public interface TimeEvent
{
  /**
   * Returns the time of the event
   *
   * @return the time of event
   */
  long getTime();

  /**
   * Returns the key of the event
   *
   * @return the key
   */
  Object getEventKey();

  Object getValue();

  /**
   * Returns whether the event has matched tuples or not
   *
   * @return whether the event has matched tuples or not
   */
  boolean isMatch();

  void setMatch(boolean match);
}