org.ehcache.spi.service.ServiceProvider Maven / Gradle / Ivy

Go to download

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

The API module of Ehcache 3

There is a newer version: 3.10.8

/*
 * Copyright Terracotta, Inc.
 *
 * 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 org.ehcache.spi.service;

import java.util.Collection;
import java.util.Optional;

/**
 * A repository of {@link Service} instances that can be used to look them up by type.
 *
 * @param  The type of services this provider returns
 */
public interface ServiceProvider {

  /**
   * Looks up the {@link Service} of the given {@code serviceType}.
   * 
   * There is no guarantee that services returned here will be started.
   *
   * @param serviceType the {@code class} of the service being looked up
   * @param  the {@link Service} type
   * @return a service instance of type {@code T}, or {@code null} if it couldn't be located
   *
   * @throws IllegalArgumentException if {@code serviceType} is marked with the
   *        {@link org.ehcache.spi.service.PluralService PluralService} annotation
   *
   * @see Service#start(ServiceProvider)
   */
   U getService(Class serviceType);

  /**
   * Looks up all {@link Service} instances that are subtypes of the given {@code serviceType} supplied.
   * 
   * This method must be used to retrieves service types marked with the
   * {@link org.ehcache.spi.service.PluralService PluralService} annotation.
   *
   * @param serviceType the {@code class} of the service being looked up
   * @param  the {@link Service} type
   * @return all the service instances assignable to {@code serviceType}
   */
   Collection getServicesOfType(Class serviceType);
}