001package ca.uhn.fhir.model.api.annotation;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2019 University Health Network
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025
026/**
027 * IResourceProvider and RestfulServer subclasses can use this annotation to designate which custom resources they can provide.
028 * These resources will automatically be added to the resource list used for profile generation.
029 * <pre>
030 * Examples:
031 * {@literal @}ProvidesResources(resource=CustomObservation.class)
032 * class CustomObservationResourceProvider implements IResourceProvider{...}
033 *
034 * {@literal @}ProvidesResources(resource={CustomPatient.class,CustomObservation.class}){...}
035 * class FhirServer extends RestfulServer
036 * }
037 * </pre>
038 * Note that you needn't annotate both the IResourceProvider and the RestfulServer for a given resource; either one will suffice.
039 */
040@Retention(RetentionPolicy.RUNTIME)
041public @interface ProvidesResources {
042    Class<?>[] resources();
043}