View Javadoc
1   package org.hl7.fhir.instance.model.api;
2   
3   import java.io.Serializable;
4   import java.util.List;
5   
6   /*
7    * #%L
8    * HAPI FHIR - Core Library
9    * %%
10   * Copyright (C) 2014 - 2018 University Health Network
11   * %%
12   * Licensed under the Apache License, Version 2.0 (the "License");
13   * you may not use this file except in compliance with the License.
14   * You may obtain a copy of the License at
15   * 
16   *      http://www.apache.org/licenses/LICENSE-2.0
17   * 
18   * Unless required by applicable law or agreed to in writing, software
19   * distributed under the License is distributed on an "AS IS" BASIS,
20   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21   * See the License for the specific language governing permissions and
22   * limitations under the License.
23   * #L%
24   */
25  
26  /**
27   * This interface is a simple marker for anything which is an HL7
28   * structure of some kind. It is provided mostly to simplify convergence
29   * between the HL7.org structures and the HAPI ones. 
30   */
31  public interface IBase extends Serializable {
32  
33  	boolean isEmpty();
34  
35  	/**
36  	 * Returns <code>true</code> if any comments would be returned by {@link #getFormatCommentsPre()}
37  	 * or {@link #getFormatCommentsPost()}
38  	 * 
39  	 * @since 1.5
40  	 */
41  	boolean hasFormatComment();
42  
43  	/**
44  	 * Returns a list of comments appearing immediately before this element within the serialized
45  	 * form of the resource. Creates the list if it does not exist, so this method will not return <code>null</code>
46  	 * 
47  	 * @since 1.5
48  	 */
49  	List<String> getFormatCommentsPre();
50  
51  	/**
52  	 * Returns a list of comments appearing immediately after this element within the serialized
53  	 * form of the resource. Creates the list if it does not exist, so this method will not return <code>null</code>
54  	 * 
55  	 * @since 1.5
56  	 */
57  	List<String> getFormatCommentsPost();
58  
59  }