001/*-
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
006 * %%
007 * Licensed under the Apache License, Version 2.0 (the "License");
008 * you may not use this file except in compliance with the License.
009 * You may obtain a copy of the License at
010 *
011 *      http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 * #L%
019 */
020package ca.uhn.fhir.util.adapters;
021
022import java.util.Collection;
023import java.util.Optional;
024
025/**
026 * Interface for external service that builds adaptors for targets.
027 */
028public interface IAdapterFactory {
029        /**
030         * Build an adaptor for the target.
031         * May return empty() even if the target type is listed in getAdapters() when
032         * the factory fails to convert a particular instance.
033         *
034         * @param theObject the object to be adapted.
035         * @param theAdapterType the target type
036         * @return the adapter, if possible.
037         */
038        <T> Optional<T> getAdapter(Object theObject, Class<T> theAdapterType);
039
040        /**
041         * @return the collection of adapter target types handled by this factory.
042         */
043        Collection<Class<?>> getAdapters();
044}