org.hl7.fhir.r4.model.Enumeration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.hl7.fhir.r4 Show documentation
Builds the hapi fhir r4. Requires hapi-fhir-base and hapi-fhir-utilities be built first and be excluded from any other poms requiring it.
The newest version!
package org.hl7.fhir.r4.model;

/*
  Copyright (c) 2011+, HL7, Inc.
  All rights reserved.

  Redistribution and use in source and binary forms, with or without modification,
  are permitted provided that the following conditions are met:

   * Redistributions of source code must retain the above copyright notice, this
     list of conditions and the following disclaimer.
   * Redistributions in binary form must reproduce the above copyright notice,
     this list of conditions and the following disclaimer in the documentation
     and/or other materials provided with the distribution.
   * Neither the name of HL7 nor the names of its contributors may be used to
     endorse or promote products derived from this software without specific
     prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  POSSIBILITY OF SUCH DAMAGE.

 */

import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.ArrayList;

import org.hl7.fhir.instance.model.api.IBaseEnumeration;

import ca.uhn.fhir.model.api.annotation.DatatypeDef;

/*
Copyright (c) 2011+, HL7, Inc
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 * Neither the name of HL7 nor the names of its contributors may be used to
   endorse or promote products derived from this software without specific
   prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

*/

/**
 * Primitive type "code" in FHIR, where the code is tied to an enumerated list
 * of possible values
 *
 */
@DatatypeDef(name = "code", isSpecialization = true)
public class Enumeration> extends PrimitiveType implements IBaseEnumeration, ICoding {

  private static final long serialVersionUID = 1L;
  private EnumFactory myEnumFactory;

  /**
   * Constructor
   *
   * @deprecated This no-arg constructor is provided for serialization only - Do
   *             not use
   */
  @Deprecated
  public Enumeration() {
    // nothing
  }

  /**
   * Constructor
   */
  public Enumeration(EnumFactory theEnumFactory) {
    if (theEnumFactory == null)
      throw new IllegalArgumentException("An enumeration factory must be provided");
    myEnumFactory = theEnumFactory;
  }

  /**
   * Constructor
   */
  public Enumeration(EnumFactory theEnumFactory, String theValue) {
    if (theEnumFactory == null)
      throw new IllegalArgumentException("An enumeration factory must be provided");
    myEnumFactory = theEnumFactory;
    setValueAsString(theValue);
  }

  /**
   * Constructor
   */
  public Enumeration(EnumFactory theEnumFactory, T theValue) {
    if (theEnumFactory == null)
      throw new IllegalArgumentException("An enumeration factory must be provided");
    myEnumFactory = theEnumFactory;
    setValue(theValue);
  }

  /**
   * Constructor
   */
  public Enumeration(EnumFactory theEnumFactory, T theValue, Element source) {
    if (theEnumFactory == null)
      throw new IllegalArgumentException("An enumeration factory must be provided");
    myEnumFactory = theEnumFactory;
    setValue(theValue);
    setId(source.getId());
    getExtension().addAll(source.getExtension());
  }

  @Override
  public Enumeration copy() {
    Enumeration dst = new Enumeration(this.myEnumFactory, (Enum) this.getValue());
    // Copy the Extension
    if (extension != null) {
      dst.extension = new ArrayList();
      for (Extension i : extension)
        dst.extension.add(i.copy());
    }
    ;
    return dst;
  }

  @Override
  protected String encode(T theValue) {
    return myEnumFactory.toCode(theValue);
  }

  public String fhirType() {
    return "code";
  }

  /**
   * Provides the enum factory which binds this enumeration to a specific ValueSet
   */
  public EnumFactory getEnumFactory() {
    return myEnumFactory;
  }

  @Override
  protected T parse(String theValue) {
    if (myEnumFactory != null) {
      return myEnumFactory.fromCode(theValue);
    }
    return null;
  }

  @SuppressWarnings("unchecked")
  @Override
  public void readExternal(ObjectInput theIn) throws IOException, ClassNotFoundException {
    myEnumFactory = (EnumFactory) theIn.readObject();
    super.readExternal(theIn);
  }

  public String toSystem() {
    return getEnumFactory().toSystem(getValue());
  }

  @Override
  public void writeExternal(ObjectOutput theOut) throws IOException {
    theOut.writeObject(myEnumFactory);
    super.writeExternal(theOut);
  }

  @Override
  public String getSystem() {
    return myEnumFactory.toSystem(myEnumFactory.fromCode(asStringValue()));
  }

  @Override
  public boolean hasSystem() {
    return myEnumFactory.toSystem(myEnumFactory.fromCode(asStringValue())) != null;
  }

  @Override
  public String getVersion() {
    return null;
  }

  @Override
  public boolean hasVersion() {
    return false;
  }

  @Override
  public boolean supportsVersion() {
    return false;
  }

  @Override
  public String getCode() {
    return asStringValue();
  }

  @Override
  public boolean hasCode() {
    return asStringValue() != null;
  }

  @Override
  public String getDisplay() {
    return null;
  }

  @Override
  public boolean hasDisplay() {
    return false;
  }

  @Override
  public boolean supportsDisplay() {
    return false;
  }
}