Save This Page
1 /* Copyright 2004 The Apache Software Foundation
2 *
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 package org.apache.xmlbeans;
17
18 import javax.xml.namespace.QName;
19
20 /**
21 * This class is used to programatically validate the contents of an
22 * XML element.Call to both {@link #next} and {@link #peek}
23 * will return true if the element
24 * with the provided name is allowed at the current position in the element
25 * content, the difference being that {@link #next} will advance
26 * the current position, while {@link #peek} won't.
27 *
28 * @see SchemaType#getElementSequencer
29 */
30 public interface SchemaTypeElementSequencer
31 {
32 /**
33 * Returns true if the element with the given name is valid at the
34 * current position. Advances the current position.
35 */
36 boolean next(QName elementName);
37
38 /**
39 * Return true if the element with the given name is valid at the
40 * current position. Does not advance the current position.
41 */
42 boolean peek(QName elementName);
43 }