001package org.hl7.fhir.r4.model;
002
003/*-
004 * #%L
005 * org.hl7.fhir.r4
006 * %%
007 * Copyright (C) 2014 - 2019 Health Level 7
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
024import org.hl7.fhir.instance.model.api.IBaseEnumFactory;
025
026
027/*
028Copyright (c) 2011+, HL7, Inc
029All rights reserved.
030
031Redistribution and use in source and binary forms, with or without modification, 
032are permitted provided that the following conditions are met:
033
034 * Redistributions of source code must retain the above copyright notice, this 
035   list of conditions and the following disclaimer.
036 * Redistributions in binary form must reproduce the above copyright notice, 
037   this list of conditions and the following disclaimer in the documentation 
038   and/or other materials provided with the distribution.
039 * Neither the name of HL7 nor the names of its contributors may be used to 
040   endorse or promote products derived from this software without specific 
041   prior written permission.
042
043THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
044ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
045WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
046IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
047INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
048NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
049PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
050WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
051ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
052POSSIBILITY OF SUCH DAMAGE.
053
054*/
055
056/**
057 * Helper class to help manage generic enumerated types
058 */
059public interface EnumFactory<T extends Enum<?>> extends IBaseEnumFactory<T> {
060
061        /**
062         * Read an enumeration value from the string that represents it on the XML or JSON
063         * @param codeString the value found in the XML or JSON
064         * @return the enumeration value
065         * @throws Exception is the value is not known
066         */
067  public T fromCode(String codeString) throws IllegalArgumentException;
068  
069  /**
070   * Get the XML/JSON representation for an enumerated value
071   * @param code - the enumeration value
072   * @return the XML/JSON representation
073   */
074  public String toCode(T code);
075
076  /**
077   * Get the system URI for an enumerated value
078   * @param code - the enumeration value
079   * @return the XML/JSON representation
080   */
081  public String toSystem(T code);
082
083}