ratpack.registry.RegistrySpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ratpack-core Show documentation
null
There is a newer version: 2.0.0-rc-1
/*
 * Copyright 2014 the original author or authors.
 *
 * 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 ratpack.registry;

import com.google.common.reflect.TypeToken;
import ratpack.func.Factory;

/**
 * An additive specification of a registry.
 *
 * @see RegistryBuilder
 */
public interface RegistrySpec {

  /**
   * Adds a registry entry that is available by the given type.
   *
   * @param type the public type of the registry entry
   * @param object the actual registry entry
   * @param  the public type of the registry entry
   * @return this
   */
   RegistrySpec add(Class type, O object);

  /**
   * Adds a registry entry that is available by the given type.
   *
   * @param type the public type of the registry entry
   * @param object the actual registry entry
   * @param  the public type of the registry entry
   * @return this
   */
   RegistrySpec add(TypeToken type, O object);

  /**
   * Adds a registry entry.
   *
   * @param object the object to add to the registry
   * @return this
   */
  RegistrySpec add(Object object);

  /**
   * Adds a lazily created entry to the registry.
   * 
   * The factory will be invoked exactly once, when a query is made to the registry of a compatible type of the given type.
   *
   * @param type the public type of the registry entry
   * @param factory the factory for creating the object when needed
   * @param  the public type of the registry entry
   * @return this
   */
   RegistrySpec add(Class type, Factory factory);

  /**
   * Adds a lazily created entry to the registry.
   * 
   * The factory will be invoked exactly once, when a query is made to the registry of a compatible type of the given type.
   *
   * @param type the public type of the registry entry
   * @param factory the factory for creating the object when needed
   * @param  the public type of the registry entry
   * @return this
   */
   RegistrySpec add(TypeToken type, Factory factory);

}