001package org.hl7.fhir.dstu2016may.model;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033import java.io.IOException;
034import java.io.ObjectInput;
035import java.io.ObjectOutput;
036
037import org.hl7.fhir.instance.model.api.IBaseEnumeration;
038
039import ca.uhn.fhir.model.api.annotation.DatatypeDef;
040
041/*
042Copyright (c) 2011+, HL7, Inc
043All rights reserved.
044
045Redistribution and use in source and binary forms, with or without modification,
046are permitted provided that the following conditions are met:
047
048 * Redistributions of source code must retain the above copyright notice, this
049   list of conditions and the following disclaimer.
050 * Redistributions in binary form must reproduce the above copyright notice,
051   this list of conditions and the following disclaimer in the documentation
052   and/or other materials provided with the distribution.
053 * Neither the name of HL7 nor the names of its contributors may be used to
054   endorse or promote products derived from this software without specific
055   prior written permission.
056
057THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
058ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
059WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
060IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
061INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
062NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
063PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
064WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
065ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
066POSSIBILITY OF SUCH DAMAGE.
067
068*/
069
070/**
071 * Primitive type "code" in FHIR, where the code is tied to an enumerated list of possible values
072 *
073 */
074@DatatypeDef(name = "code", isSpecialization = true)
075public class Enumeration<T extends Enum<?>> extends PrimitiveType<T> implements IBaseEnumeration<T> {
076
077  private static final long serialVersionUID = 1L;
078  private EnumFactory<T> myEnumFactory;
079
080  /**
081   * Constructor
082   *
083   * @deprecated This no-arg constructor is provided for serialization only - Do not use
084   */
085  @Deprecated
086  public Enumeration() {
087    // nothing
088  }
089
090  /**
091   * Constructor
092   */
093  public Enumeration(EnumFactory<T> theEnumFactory) {
094    if (theEnumFactory == null)
095      throw new IllegalArgumentException("An enumeration factory must be provided");
096    myEnumFactory = theEnumFactory;
097  }
098
099  /**
100   * Constructor
101   */
102  public Enumeration(EnumFactory<T> theEnumFactory, String theValue) {
103    if (theEnumFactory == null)
104      throw new IllegalArgumentException("An enumeration factory must be provided");
105    myEnumFactory = theEnumFactory;
106    setValueAsString(theValue);
107  }
108
109  /**
110   * Constructor
111   */
112  public Enumeration(EnumFactory<T> theEnumFactory, T theValue) {
113    if (theEnumFactory == null)
114      throw new IllegalArgumentException("An enumeration factory must be provided");
115    myEnumFactory = theEnumFactory;
116    setValue(theValue);
117  }
118
119  @Override
120  public Enumeration<T> copy() {
121    return new Enumeration<T>(myEnumFactory, getValue());
122  }
123
124  @Override
125  protected String encode(T theValue) {
126    return myEnumFactory.toCode(theValue);
127  }
128
129  public String fhirType() {
130    return "code";
131  }
132
133  /**
134   * Provides the enum factory which binds this enumeration to a specific ValueSet
135   */
136  public EnumFactory<T> getEnumFactory() {
137    return myEnumFactory;
138  }
139
140  @Override
141  protected T parse(String theValue) {
142    if (myEnumFactory != null) {
143      return myEnumFactory.fromCode(theValue);
144    }
145    return null;
146  }
147
148  @SuppressWarnings("unchecked")
149  @Override
150  public void readExternal(ObjectInput theIn) throws IOException, ClassNotFoundException {
151    myEnumFactory = (EnumFactory<T>) theIn.readObject();
152    super.readExternal(theIn);
153  }
154
155  public String toSystem() {
156    return getEnumFactory().toSystem(getValue());
157  }
158
159  @Override
160  public void writeExternal(ObjectOutput theOut) throws IOException {
161    theOut.writeObject(myEnumFactory);
162    super.writeExternal(theOut);
163  }
164}