org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/matching/IEventMatchingKey.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 École Polytechnique de Montréal
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Geneviève Bastien - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.event.matching;
  14
  15 /**
  16  * Interface that classes describing event matching keys should implement. An
  17  * event matching key is a key obtained from an event's data/fields and that
  18  * will be used to match events together.
  19  *
  20  * If you implement this interface, make sure to consider implementing the
  21  * {@link Object#hashCode()} and {@link Object#equals(Object)} as they will be
  22  * used to match 2 keys together. Keys will come from different events and 2
  23  * keys that are identical using the {@link Object#equals(Object)} method will
  24  * create a match.
  25  *
  26  * @author Geneviève Bastien
  27  */
  28 public interface IEventMatchingKey {
  29
  30 }