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;
021
022import ca.uhn.fhir.context.BaseRuntimeChildDefinition;
023import ca.uhn.fhir.context.BaseRuntimeElementDefinition;
024import org.hl7.fhir.instance.model.api.IBase;
025import org.hl7.fhir.instance.model.api.IBaseResource;
026
027import java.util.List;
028
029/**
030 * @see FhirTerser#visit(IBaseResource, IModelVisitor)
031 */
032public interface IModelVisitor {
033
034        /**
035         * @param theResource
036         *           The resource being visited (note that generally this will be the resource upon which
037         *           visit was originally called, but in the case of descending into contained resources this will be the contained resource instead)
038         * @param theElement
039         *           The element
040         * @param theChildDefinition
041         *           May be null if this is a root element
042         * @param theDefinition
043         */
044        void acceptElement(
045                        IBaseResource theResource,
046                        IBase theElement,
047                        List<String> thePathToElement,
048                        BaseRuntimeChildDefinition theChildDefinition,
049                        BaseRuntimeElementDefinition<?> theDefinition);
050}