org.apache.camel.clock.EventClock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation

The Camel API

The newest version!

/*
 * 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.camel.clock;

/**
 * A specialized clock that tracks the pass of time for one or more types of events
 *
 * @param  The event type as an Enum
 */
public interface EventClock> extends Clock {

    /**
     * Add the event to be tracked
     *
     * @param event the event to track
     * @param clock the clock associated with the event
     */
    void add(T event, Clock clock);

    /**
     * Get the clock for the event
     *
     * @param  event the event to get the clock for
     * @return       the clock instance or null if not set
     */
    Clock get(T event);
}