org.apache.cayenne.di.BindingBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cayenne-client
There is a newer version: 4.2.1
/*****************************************************************
 *   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 org.apache.cayenne.di;

import org.apache.cayenne.ConfigurationException;

/**
 * A binding builder that helps with fluent binding creation.
 * 
 * @param  An interface type of the service being bound.
 * @since 3.1
 */
public interface BindingBuilder {

    BindingBuilder to(Class implementation) throws ConfigurationException;

    BindingBuilder toInstance(T instance) throws ConfigurationException;

    BindingBuilder toProvider(Class> providerType)
            throws ConfigurationException;

    BindingBuilder toProviderInstance(Provider provider)
            throws ConfigurationException;

    /**
     * Sets the scope of a bound instance. This method is used to change the default scope
     * which is usually a singleton to a custom scope.
     */
    void in(Scope scope);

    /**
     * Sets the scope of a bound instance to singleton. Singleton is normally the default,
     * so calling this method explicitly is rarely needed.
     */
    void inSingletonScope();

    /**
     * Sets the scope of a bound instance to "no scope". This means that a new instance of
     * an object will be created on every call to {@link Injector#getInstance(Class)}.
     */
    void withoutScope();
}