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;
020
021/**
022 * An object that can adapt a given object instance to an object of another type A type adapter accepts only one type of
023 * objects and can produce only one type of object.
024 *
025 * @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
026 */
027public interface TypeAdapter {
028
029    /**
030     * Adapt the given object to an instance of the given target type. The input object cannot be null. Throws an
031     * exception if the object cannot be adapted.
032     *
033     * @param ctx
034     * @param objectToAdapt
035     * @throws TypeAdaptException when the object cannot be adapted
036     */
037    Object getAdaptedValue(OperationContext ctx, Object objectToAdapt) throws TypeAdaptException;
038
039}