1 /*
2 * Copyright 2006-2007 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
17 package org.springframework.batch.item.xml.stax;
18
19 import javax.xml.stream.XMLEventReader;
20
21
22 /**
23 * Interface for event readers which support treating XML fragments as standalone XML documents
24 * by wrapping the fragments with StartDocument and EndDocument events.
25 *
26 * @author Robert Kasanicky
27 */
28 public interface FragmentEventReader extends XMLEventReader {
29
30 /**
31 * Tells the event reader its cursor position is exactly before the fragment.
32 */
33 void markStartFragment();
34
35 /**
36 * Tells the event reader the current fragment has been processed.
37 * If the cursor is still inside the fragment it should be moved
38 * after the end of the fragment.
39 */
40 void markFragmentProcessed();
41
42 /**
43 * Reset the state of the fragment reader - make it forget
44 * it assumptions about current position of cursor
45 * (e.g. in case of rollback of the wrapped reader).
46 */
47 void reset();
48
49 }