org.lenskit.LenskitConfigContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lenskit-core Show documentation
The core of LensKit, providing basic implementations and algorithm support.
The newest version!
/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2016 LensKit Contributors.  See CONTRIBUTORS.md.
 * Work on LensKit has been funded by the National Science Foundation under
 * grants IIS 05-34939, 08-08692, 08-12148, and 10-17697.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.lenskit;

import org.grouplens.grapht.Binding;
import org.grouplens.grapht.Context;
import org.grouplens.grapht.context.ContextPattern;
import org.lenskit.inject.Parameter;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.annotation.Annotation;

/**
 * LensKit-specific augmentations of the Grapht context interface.
 *
 * @author GroupLens Research
 * @compat Public
 * @since 1.0
 */
public interface LenskitConfigContext extends Context {
    @Override
     LenskitBinding bind(Class type);
    @Override
     LenskitBinding bind(Class qual, Class type);
    @Override
     LenskitBinding bindAny(Class type);

    /**
     * Start a binding that sets a parameter. Parameters are qualifiers that
     * bear the {@link Parameter} annotation.
     *
     * @param param The parameter to set.
     * @return The binding for this parameter. It is untyped, as many types will
     *         be accepted and attempted.
     */
    @SuppressWarnings("rawtypes")
    Binding set(Class param);

    /**
     * Add a component object to the injector.  This is the equivalent of:
     * {@code
     * this.bind(obj.getClass()).to(obj);
     * }
     * It has the result of making {@code obj} available satisfy dependencies on its class or,
     * via supertype binding generation, any of its supertypes.  Explicit bindings for those
     * supertypes will override this binding.
     *
     * @param obj The object to register.
     */
    void addComponent(@Nonnull Object obj);

    /**
     * Add a component type to the injector.  This is the equivalent of:
     * {@code
     * this.bind(type).to(type);
     * }
     * It has the result of making {@code type} available satisfy dependencies on itself or,
     * via supertype binding generation, any of its supertypes.  Explicit bindings for those
     * supertypes will override this binding.
     *
     * @param type The type to register.
     */
    void addComponent(@Nonnull Class type);
    
    @Override
    @Deprecated
    LenskitConfigContext in(Class type);
    
    @Override
    @Deprecated
    LenskitConfigContext in(@Nullable Class qualifier,
                                Class type);
    
    @Override
    @Deprecated
    LenskitConfigContext in(@Nullable Annotation qualifier, Class type);

    @Override
    LenskitConfigContext within(Class type);

    @Override
    LenskitConfigContext within(@Nullable Class qualifier,
                            Class type);

    @Override
    LenskitConfigContext within(@Nullable Annotation qualifier, Class type);

    @Override
    LenskitConfigContext matching(ContextPattern pattern);

    @Override
    LenskitConfigContext at(Class type);

    @Override
    LenskitConfigContext at(@Nullable Class qualifier,
                                Class type);

    @Override
    LenskitConfigContext at(@Nullable Annotation qualifier, Class type);
}