com.speedment.runtime.core.component.ManagerComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime-deploy Show documentation
Show all versions of runtime-deploy Show documentation
A Speedment bundle that shades all dependencies into one jar. This is
useful when deploying an application on a server.
/**
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* 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.
*/
package com.speedment.runtime.core.component;
import com.speedment.common.injector.annotation.InjectKey;
import com.speedment.runtime.core.exception.SpeedmentException;
import com.speedment.runtime.core.manager.Manager;
import java.util.stream.Stream;
/**
* The {@code ManagerComponent} provides the mapping between entities and their
* corresponding managers. Custom managers may be plugged into the Speedment
* framework.
*
* @author Emil Forslund
* @since 2.0.0
*/
@InjectKey(ManagerComponent.class)
public interface ManagerComponent {
/**
* Puts (associates) a {@link Manager} implementation into the
* {@code ManagerComponent}. If a previous {@link Manager} was associated
* with an Entity class, table or interface, that association(s) is/are
* replaced.
*
* @param the entity interface type
* @param manager to associate
*/
void put(Manager manager);
/**
* Obtains and returns the currently associated {@link Manager}
* implementation for the given Entity interface Class. If no Manager exists
* for the given entityClass, a SpeedmentException will be thrown.
*
* @param the entity interface type
* @param entityClass the entity interface {@code Class}
* @return the currently associated {@link Manager}
* implementation for the given Entity interface Class
*
* @throws SpeedmentException if no Manager exists for the given entityClass
*/
Manager managerOf(Class entityClass) throws SpeedmentException;
/**
* Returns a {@link Stream} of all {@link Manager Managers} associated with
* this ManagerComponent.
*
* @return a {@link Stream} of all {@link Manager Managers} associated with
* this ManagerComponent
*/
Stream> stream();
}