org.apache.sling.api.adapter.AdapterManager Maven / Gradle / Ivy

/*
 * 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.sling.api.adapter;

import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.NotNull;

import org.osgi.annotation.versioning.ProviderType;

/**
 * The AdapterManager defines the service interface for a manager
 * for object adaption. The adapter manager coordinates the registered
 * {@link AdapterFactory} services on behalf of clients wishing to adapt objects
 * to other types. One such client is the {@link SlingAdaptable} class, which
 * uses the implementation of this bundle to adapt "itself".
 * 
 * Clients may either extend from the {@link SlingAdaptable} class or access the
 * AdapterManager service from the OSGi service registry to adapt
 * objects to other types.
 * 

 * This interface is not intended to be implemented by clients.
 */
@ProviderType
public interface AdapterManager {

    /**
     * The name under which this service is registered with the OSGi service
     * registry.
     */
    String SERVICE_NAME = "org.apache.sling.api.adapter.AdapterManager";

    /**
     * Returns an adapter object of the requested AdapterType for
     * the given adaptable object.
     * 
     * The adaptable object may be any non-null object
     * and is not required to implement the Adaptable interface.
     *
     * @param  The generic type of the adapter (target) type.
     * @param adaptable The object to adapt to the adapter type.
     * @param type The type to which the object is to be adapted.
     * @return The adapted object or null if no factory exists to
     *         adapt the adaptable to the AdapterType
     *         or if the adaptable cannot be adapted for any other
     *         reason.
     */
    @Nullable  AdapterType getAdapter(@NotNull Object adaptable,
            @NotNull Class type);

}