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

// @formatter:off
/**
 * There are 4 kinds of comparators
 *   for the combinations of comparing
 *     - with or without the "id"
 *     - with or without type order (with only includes typeOrder if there is such a key included) 
 */
//@formatter:on
public enum FSComparators {
  WITH_ID, // include the id in the comparator
  WITHOUT_ID, // no id in the comparator
  WITH_TYPE_ORDER, // include the typeOrder in the comparator
  WITHOUT_TYPE_ORDER // no typeOrder in the comparator
}
