Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Visitable |
|
| 1.0;1 |
1 | /* | |
2 | The contents of this file are subject to the Mozilla Public License Version 1.1 | |
3 | (the "License"); you may not use this file except in compliance with the License. | |
4 | You may obtain a copy of the License at http://www.mozilla.org/MPL/ | |
5 | Software distributed under the License is distributed on an "AS IS" basis, | |
6 | WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the | |
7 | specific language governing rights and limitations under the License. | |
8 | ||
9 | The Original Code is "Visitable.java ". Description: | |
10 | "Callback method for the visitor" | |
11 | ||
12 | The Initial Developer of the Original Code is University Health Network. Copyright (C) | |
13 | 2013. All Rights Reserved. | |
14 | ||
15 | Contributor(s): ______________________________________. | |
16 | ||
17 | Alternatively, the contents of this file may be used under the terms of the | |
18 | GNU General Public License (the "GPL"), in which case the provisions of the GPL are | |
19 | applicable instead of those above. If you wish to allow use of your version of this | |
20 | file only under the terms of the GPL and not to allow others to use your version | |
21 | of this file under the MPL, indicate your decision by deleting the provisions above | |
22 | and replace them with the notice and other provisions required by the GPL License. | |
23 | If you do not delete the provisions above, a recipient may use your version of | |
24 | this file under either the MPL or the GPL. | |
25 | */ | |
26 | ||
27 | package ca.uhn.hl7v2.model; | |
28 | ||
29 | import ca.uhn.hl7v2.HL7Exception; | |
30 | import ca.uhn.hl7v2.Location; | |
31 | ||
32 | /** | |
33 | * Interface that marks implementing classes as being capable to be visited by a | |
34 | * {@link MessageVisitor} | |
35 | */ | |
36 | public interface Visitable { | |
37 | ||
38 | /** | |
39 | * Callback method for the visitor. This method is supposed to either directly | |
40 | * call one of the visitors methods, passing <code>this</code> as parameter, or | |
41 | * traverse through a hierarchical substructure and call accept(MessageVisitor) | |
42 | * for each visited element. | |
43 | * | |
44 | * @param visitor MessageVisitor instance to be called back | |
45 | * @param currentLocation location of this object | |
46 | * @return <code>true</code> if the visit process shall continue | |
47 | * @throws HL7Exception if a problem occurred during visiting | |
48 | */ | |
49 | boolean accept(MessageVisitor visitor, Location currentLocation) throws HL7Exception; | |
50 | ||
51 | /** | |
52 | * Reusing the location of this object's parent, this method returns its own | |
53 | * location within the message. | |
54 | * | |
55 | * @param parentLocation the parents location | |
56 | * @param index index of this object | |
57 | * @param repetition repetition of this object | |
58 | * @return this objects location | |
59 | */ | |
60 | Location provideLocation(Location parentLocation, int index, int repetition); | |
61 | ||
62 | /** | |
63 | * Returns true if this Visitable has actual content | |
64 | * | |
65 | * @return true if Visitable is empty | |
66 | * @throws HL7Exception if an error occurred while determining emptiness | |
67 | */ | |
68 | boolean isEmpty() throws HL7Exception; | |
69 | } |