View Javadoc
1   /*
2    * Copyright 2016 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *       http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.openehealth.ipf.commons.ihe.hl7v2.storage;
17  
18  /**
19   * Interface for storages of of HL7 v2 unsolicited fragmentation accumulators.
20   *
21   * @author Dmytro Rud
22   */
23  public interface UnsolicitedFragmentationStorage {
24  
25      /**
26       * Puts a fragment accumulator into the storage.
27       * @param key
28       *      Key consisting of MSH-14/DSC-1, MSH-3-1, MSH-3-2, MSH-3-3.
29       * @param accumulator
30       *      Accumulator to be stored.
31       */
32      void put(String key, StringBuilder accumulator);
33  
34      /**
35       * Returns the fragment accumulator which corresponds to the given key
36       * and removes it from the storage.
37       * @param key
38       *      Key consisting of MSH-14/DCS-1, MSH-3-1, MSH-3-2, MSH-3-3.
39       * @return
40       *      Accumulator or <code>null</code> when none found.
41       */
42      StringBuilder getAndRemove(String key);
43  }