001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.camel;
018
019/**
020 * Interface to be implemented by objects that should be orderable, such as with a {@link java.util.Collection}.
021 */
022public interface Ordered {
023
024    /**
025     * The highest precedence
026     */
027    int HIGHEST = Integer.MIN_VALUE;
028
029    /**
030     * The lowest precedence
031     */
032    int LOWEST = Integer.MAX_VALUE;
033
034    /**
035     * Gets the order.
036     * <p/>
037     * Use low numbers for higher priority. Normally the sorting will start from 0 and move upwards.
038     * So if you want to be last then use {@link Integer#MAX_VALUE} or eg {@link #LOWEST}.
039     *
040     * @return the order
041     */
042    int getOrder();
043}