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