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