001package org.hl7.fhir.instance.model.api;
002
003import java.io.Serializable;
004
005/*
006 * #%L
007 * HAPI FHIR - Core Library
008 * %%
009 * Copyright (C) 2014 - 2021 Smile CDR, Inc.
010 * %%
011 * Licensed under the Apache License, Version 2.0 (the "License");
012 * you may not use this file except in compliance with the License.
013 * You may obtain a copy of the License at
014 *
015 *      http://www.apache.org/licenses/LICENSE-2.0
016 *
017 * Unless required by applicable law or agreed to in writing, software
018 * distributed under the License is distributed on an "AS IS" BASIS,
019 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020 * See the License for the specific language governing permissions and
021 * limitations under the License.
022 * #L%
023 */
024
025public interface IBaseEnumFactory<T extends Enum<?>> extends Serializable {
026
027        /**
028         * Read an enumeration value from the string that represents it on the XML or JSON
029         *
030         * @param codeString the value found in the XML or JSON
031         * @return the enumeration value
032         * @throws IllegalArgumentException is the value is not known
033         */
034        T fromCode(String codeString) throws IllegalArgumentException;
035
036        /**
037         * Get the XML/JSON representation for an enumerated value
038         *
039         * @param code - the enumeration value
040         * @return the XML/JSON representation
041         */
042        String toCode(T code);
043
044        /**
045         * Get the system for a given enum value
046         */
047        default String toSystem(T theValue) { return null; }
048
049}