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.model.api.annotation; 021 022import ca.uhn.fhir.model.primitive.BoundCodeDt; 023import ca.uhn.fhir.model.primitive.CodeDt; 024import org.hl7.fhir.instance.model.api.IBaseDatatype; 025 026import java.lang.annotation.ElementType; 027import java.lang.annotation.Retention; 028import java.lang.annotation.RetentionPolicy; 029import java.lang.annotation.Target; 030 031/** 032 * Class annotation to note a class which defines a datatype 033 */ 034@Retention(RetentionPolicy.RUNTIME) 035@Target(value = {ElementType.TYPE}) 036public @interface DatatypeDef { 037 038 /** 039 * The defined name of this datatype 040 */ 041 String name(); 042 043 /** 044 * Set this to true (default is false) for any types that are 045 * really only a specialization of another type. For example, 046 * {@link BoundCodeDt} is really just a specific type of 047 * {@link CodeDt} and not a separate datatype, so it should 048 * have this set to true. 049 */ 050 boolean isSpecialization() default false; 051 052 /** 053 * Indicates that this datatype is a profile of the given datatype, which 054 * implies certain parsing/encoding rules (e.g. a choice element named 055 * foo[x] which allows a Markdown value will still be encoded as 056 * fooString because Markdown is a profile of string. 057 */ 058 Class<? extends IBaseDatatype> profileOf() default IBaseDatatype.class; 059}