001/*
002 * (C) Copyright 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.ecm.automation.client;
020
021/**
022 * A factory for adapters. Adapters can be used to adapt client and session objects. For example you can contribute an
023 * adapter on the session to have an API suited for your needs.
024 * <p>
025 * To register adapters use {@link AutomationClient#registerAdapter(AdapterFactory)}.
026 *
027 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
028 */
029public interface AdapterFactory<T> {
030
031    /**
032     * Adapt the given object and return the adapter instance.
033     *
034     * @param toAdapt
035     * @return
036     */
037    T getAdapter(Session session, Class<T> clazz);
038
039}