org.apache.tapestry5.services.Alias Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tapestry-core Show documentation

Central module for Tapestry, containing interfaces to the Java Servlet API and all core services and components.

There is a newer version: 5.8.6

// Copyright 2006, 2007, 2008, 2010 The Apache Software Foundation
//
// 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.apache.tapestry5.services;

import org.apache.tapestry5.ioc.ObjectProvider;
import org.apache.tapestry5.ioc.annotations.UsesConfiguration;
import org.apache.tapestry5.ioc.services.ServiceOverride;

/**
 * The Alias service provides an ObjectProvider that fits into the MasterObjectProvider command chain and disambiguates
 * injections based on type. {@linkplain org.apache.tapestry5.services.AliasContribution Contibutions} to the Alias
 * service identify the desired service to inject for a particular service interface; this is only necessary when there
 * is more than one service implementing the same interface.
 * 
 * The {@linkplain AliasManager} service also takes an unordered configuration of
 * {@link org.apache.tapestry5.services.AliasContribution}; such contributions override the "factory" contributions to
 * the Alias service itself. This is often used to replace built-in service implementations with ones that are specific
 * to a particular application.
 * 
 * @deprecated Use {@link ServiceOverride} instead
 */
@UsesConfiguration(AliasContribution.class)
public interface Alias
{
    /**
     * Returns an object provider that checks the desired type against the service's contributions.
     */
    ObjectProvider getObjectProvider();
}