EventService.java

package org.jtheque.events;

import org.jtheque.utils.annotations.ThreadSafe;

import java.util.Collection;

/*
 * Copyright JTheque (Baptiste Wicht)
 *
 * Licensed 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.
 */

/**
 * An event manager specification.
 *
 * @author Baptiste Wicht
 */
@ThreadSafe
public interface EventService {
    String CORE_EVENT_LOG = "JTheque Core";

    /**
     * Return all the logs.
     *
     * @return A Collection containing all the logs. The Collection is unmodifiable.
     */
    Collection<String> getEventLogs();

    /**
     * Return all the events from a log.
     *
     * @param log The event log to get the events from.
     *
     * @return A Collection containing all the events of the log. The Collection is unmodifiable.
     */
    Collection<Event> getEvents(String log);

    /**
     * Add an event.
     *
     * @param event The event to add.
     */
    void addEvent(Event event);
}