io.microsphere.event.EventDispatcher Maven / Gradle / Ivy
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 io.microsphere.event;
import java.util.concurrent.Executor;
/**
* {@link Event Event} Dispatcher
*
* @see Event
* @see EventListener
* @see DirectEventDispatcher
* @since 1.0.0
*/
public interface EventDispatcher extends Listenable> {
/**
* Direct {@link Executor} uses sequential execution model
*/
Executor DIRECT_EXECUTOR = Runnable::run;
/**
* The default implementation of {@link EventDispatcher}
*
* @return the default implementation of {@link EventDispatcher}
*/
static EventDispatcher newDefault() {
return new DirectEventDispatcher();
}
/**
* The parallel implementation of {@link EventDispatcher} with the specified {@link Executor}
*
* @param executor {@link Executor}
* @return the default implementation of {@link EventDispatcher}
*/
static EventDispatcher parallel(Executor executor) {
return new ParallelEventDispatcher(executor);
}
/**
* Dispatch a event to the registered {@link EventListener event listeners}
*
* @param event a {@link Event event}
*/
void dispatch(Event event);
/**
* The {@link Executor} to dispatch a {@link Event event}
*
* @return default implementation directly invoke {@link Runnable#run()} method, rather than multiple-threaded
* {@link Executor}. If the return value is null, the behavior is same as default.
* @see #DIRECT_EXECUTOR
*/
default Executor getExecutor() {
return DIRECT_EXECUTOR;
}
}