View Javadoc
1   package ca.uhn.fhir.model.api.annotation;
2   
3   /*
4    * #%L
5    * HAPI FHIR - Core Library
6    * %%
7    * Copyright (C) 2014 - 2018 University Health Network
8    * %%
9    * Licensed under the Apache License, Version 2.0 (the "License");
10   * you may not use this file except in compliance with the License.
11   * You may obtain a copy of the License at
12   * 
13   *      http://www.apache.org/licenses/LICENSE-2.0
14   * 
15   * Unless required by applicable law or agreed to in writing, software
16   * distributed under the License is distributed on an "AS IS" BASIS,
17   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18   * See the License for the specific language governing permissions and
19   * limitations under the License.
20   * #L%
21   */
22  
23  import java.lang.annotation.Retention;
24  import java.lang.annotation.RetentionPolicy;
25  
26  /**
27   * IResourceProvider and RestfulServer subclasses can use this annotation to designate which custom resources they can provide.
28   * These resources will automatically be added to the resource list used for profile generation.
29   * <pre>
30   * Examples:
31   * {@literal @}ProvidesResources(resource=CustomObservation.class)
32   * class CustomObservationResourceProvider implements IResourceProvider{...}
33   *
34   * {@literal @}ProvidesResources(resource={CustomPatient.class,CustomObservation.class}){...}
35   * class FhirServer extends RestfulServer
36   * }
37   * </pre>
38   * Note that you needn't annotate both the IResourceProvider and the RestfulServer for a given resource; either one will suffice.
39   */
40  @Retention(RetentionPolicy.RUNTIME)
41  public @interface ProvidesResources {
42      Class<?>[] resources();
43  }