OMXMLParserWrapper


1   /*
2    * Copyright 2004,2005 The Apache Software Foundation.
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.apache.axis2.om;
17  
18  /**
19   * Interface OMXMLParserWrapper
20   */
21  public interface OMXMLParserWrapper {
22      /**
23       * Proceed the parser one step and return the event value
24       *
25       * @return
26       * @throws org.apache.axis2.om.OMException
27       * @throws OMException
28       */
29      int next() throws OMException;
30  
31      /**
32       * Discard the current element
33       * This should remove the given element and its decendants.
34       *
35       * @param el
36       * @throws org.apache.axis2.om.OMException
37       * @throws OMException
38       */
39      void discard(OMElement el) throws OMException;
40  
41      /**
42       * @param b
43       * @throws org.apache.axis2.om.OMException
44       * @throws OMException
45       */
46      void setCache(boolean b) throws OMException;
47  
48      /**
49       * Allows to access the underlying parser. Since the parser
50       * depends on the underlying implementation,an Object is returned
51       * However the implementations may have restrictions in letting access to
52       * the parser
53       *
54       * @return
55       */
56      Object   getParser();
57  
58      /**
59       * @return the complete status
60       */
61      boolean isCompleted();
62  
63      /**
64       * @return the document element
65       */
66      OMElement getDocumentElement();
67  
68      /**
69       * Returns the type of the builder.
70       * Can be either the
71       * PUSH_TYPE_BUILDER or PULL_TYPE_BUILDER
72       *
73       * @return
74       */
75      short getBuilderType();
76  
77      /**
78       * Registers an external content handler. Especially useful for
79       * push type builders. will throw an unsupportedOperationExcveption if
80       * such handler registration is not supported
81       *
82       * @param obj
83       */
84      void registerExternalContentHandler(Object   obj);
85  
86      /**
87       * get the registered external content handler
88       *
89       * @return
90       */
91      Object   getRegisteredContentHandler();
92  }
93
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags