View Javadoc
1   package org.hl7.fhir.instance.model.api;
2   
3   import java.io.Serializable;
4   
5   /*
6    * #%L
7    * HAPI FHIR - Core Library
8    * %%
9    * Copyright (C) 2014 - 2018 University Health Network
10   * %%
11   * Licensed under the Apache License, Version 2.0 (the "License");
12   * you may not use this file except in compliance with the License.
13   * You may obtain a copy of the License at
14   * 
15   *      http://www.apache.org/licenses/LICENSE-2.0
16   * 
17   * Unless required by applicable law or agreed to in writing, software
18   * distributed under the License is distributed on an "AS IS" BASIS,
19   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   * See the License for the specific language governing permissions and
21   * limitations under the License.
22   * #L%
23   */
24  
25  public interface IBaseEnumFactory<T extends Enum<?>> extends Serializable {
26  
27      /**
28       * Read an enumeration value from the string that represents it on the XML or JSON
29       *
30       * @param codeString the value found in the XML or JSON
31       * @return the enumeration value
32       * @throws IllegalArgumentException is the value is not known
33       */
34      public T fromCode(String codeString) throws IllegalArgumentException;
35  
36      /**
37       * Get the XML/JSON representation for an enumerated value
38       *
39       * @param code - the enumeration value
40       * @return the XML/JSON representation
41       */
42      public String toCode(T code);
43  
44  }