001package org.hl7.fhir.r4.model.annotations;
002
003/*
004 * #%L
005 * HAPI FHIR Structures - HL7.org DSTU2
006 * %%
007 * Copyright (C) 2014 - 2015 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
023/*
024Copyright (c) 2011+, HL7, Inc.
025All rights reserved.
026
027Redistribution and use in source and binary forms, with or without modification, 
028are permitted provided that the following conditions are met:
029
030 * Redistributions of source code must retain the above copyright notice, this 
031   list of conditions and the following disclaimer.
032 * Redistributions in binary form must reproduce the above copyright notice, 
033   this list of conditions and the following disclaimer in the documentation 
034   and/or other materials provided with the distribution.
035 * Neither the name of HL7 nor the names of its contributors may be used to 
036   endorse or promote products derived from this software without specific 
037   prior written permission.
038
039THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
040ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
041WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
042IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
043INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
044NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
045PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
046WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
047ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
048POSSIBILITY OF SUCH DAMAGE.
049
050*/
051
052import java.lang.annotation.ElementType;
053import java.lang.annotation.Retention;
054import java.lang.annotation.RetentionPolicy;
055import java.lang.annotation.Target;
056
057import org.hl7.fhir.r4.model.api.IBaseDatatype;
058
059import ca.uhn.fhir.model.primitive.BoundCodeDt;
060import ca.uhn.fhir.model.primitive.CodeDt;
061
062/**
063 * Class annotation to note a class which defines a datatype
064 */
065@Retention(RetentionPolicy.RUNTIME)
066@Target(value= {ElementType.TYPE})
067public @interface DatatypeDef {
068
069        /**
070         * The defined name of this datatype
071         */
072        String name();
073        
074        /**
075         * Set this to true (default is false) for any types that are
076         * really only a specialization of another type. For example,
077         * {@link BoundCodeDt} is really just a specific type of 
078         * {@link CodeDt} and not a separate datatype, so it should
079         * have this set to true.
080         */
081        boolean isSpecialization() default false;
082        
083        /**
084         * Indicates that this datatype is a profile of the given datatype, which
085         * implies certain parsing/encoding rules (e.g. a choice element named
086         * foo[x] which allows a Markdown value will still be encoded as
087         * fooString because Markdown is a profile of string.
088         */
089        Class<? extends IBaseDatatype> profileOf() default IBaseDatatype.class;
090        
091}