001/*
002 * #%L
003 * HAPI FHIR - Core Library
004 * %%
005 * Copyright (C) 2014 - 2024 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 org.hl7.fhir.instance.model.api;
021
022import java.io.Serializable;
023
024public interface IBaseEnumFactory<T extends Enum<?>> extends Serializable {
025
026        /**
027         * Read an enumeration value from the string that represents it on the XML or JSON
028         *
029         * @param codeString the value found in the XML or JSON
030         * @return the enumeration value
031         * @throws IllegalArgumentException is the value is not known
032         */
033        T fromCode(String codeString) throws IllegalArgumentException;
034
035        /**
036         * Get the XML/JSON representation for an enumerated value
037         *
038         * @param code - the enumeration value
039         * @return the XML/JSON representation
040         */
041        String toCode(T code);
042
043        /**
044         * Get the system for a given enum value
045         */
046        default String toSystem(T theValue) {
047                return null;
048        }
049}