Apache Log4cxx  Version 1.3.1
xml.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _LOG4CXX_HELPERS_XML_H
19 #define _LOG4CXX_HELPERS_XML_H
20 
21 #include <log4cxx/logstring.h>
22 #include <log4cxx/helpers/object.h>
24 
25 namespace LOG4CXX_NS
26 {
27 class File;
28 namespace helpers
29 {
30 class XMLDOMNode;
31 typedef std::shared_ptr<XMLDOMNode> XMLDOMNodePtr;
32 
33 class XMLDOMDocument;
34 typedef std::shared_ptr<XMLDOMDocument> XMLDOMDocumentPtr;
35 
36 class XMLDOMNodeList;
37 typedef std::shared_ptr<XMLDOMNodeList> XMLDOMNodeListPtr;
38 
39 class LOG4CXX_EXPORT DOMException : public RuntimeException
40 {
41  public:
42  DOMException() : RuntimeException(LOG4CXX_STR("DOM exception")) {}
43 };
44 
45 
50 class LOG4CXX_EXPORT XMLDOMNode : virtual public Object
51 {
52  public:
55  {
56  NOT_IMPLEMENTED_NODE = 0,
57  ELEMENT_NODE = 1,
58  DOCUMENT_NODE = 9
59  };
60 
62  virtual XMLDOMNodeType getNodeType() = 0;
64 };
66 
67 
71 class LOG4CXX_EXPORT XMLDOMElement : virtual public XMLDOMNode
72 {
73  public:
75  virtual LogString getTagName() = 0;
76  virtual LogString getAttribute(const LogString& name) = 0;
77 };
79 
86 class LOG4CXX_EXPORT XMLDOMDocument : virtual public XMLDOMNode
87 {
88  public:
90  virtual void load(const File& fileName) = 0;
91  virtual XMLDOMElementPtr getDocumentElement() = 0;
92  virtual XMLDOMElementPtr getElementById(const LogString& tagName,
93  const LogString& elementId) = 0;
94 };
96 
107 class LOG4CXX_EXPORT XMLDOMNodeList : virtual public Object
108 {
109  public:
111  virtual int getLength() = 0;
112  virtual XMLDOMNodePtr item(int index) = 0;
113 };
115 } // namespace helpers
116 } // namespace log4cxx
117 
118 #endif // _LOG4CXX_HELPERS_XML_H
119 
An abstract representation of file and directory path names.
Definition: file.h:41
Definition: xml.h:40
DOMException()
Definition: xml.h:42
base class for java-like objects.
Definition: object.h:106
RuntimeException is the parent class of those exceptions that can be thrown during the normal operati...
Definition: exception.h:54
The XMLDOMDocument interface represents an entire XML document.
Definition: xml.h:87
The XMLDOMElement interface represents an element in an XML document.
Definition: xml.h:72
The XMLDOMNodeList interface provides the abstraction of an ordered collection of nodes,...
Definition: xml.h:108
The XMLDOMNode interface is the primary datatype for the entire Document Object Model.
Definition: xml.h:51
virtual XMLDOMNodeType getNodeType()=0
XMLDOMNodeType
Definition: xml.h:55
virtual XMLDOMNodeListPtr getChildNodes()=0
virtual XMLDOMDocumentPtr getOwnerDocument()=0
std::shared_ptr< XMLDOMDocument > XMLDOMDocumentPtr
Definition: xml.h:33
LOG4CXX_PTR_DEF(XMLDOMNodeList)
std::shared_ptr< XMLDOMNodeList > XMLDOMNodeListPtr
Definition: xml.h:36
std::shared_ptr< XMLDOMNode > XMLDOMNodePtr
Definition: xml.h:30
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define DECLARE_ABSTRACT_LOG4CXX_OBJECT(object)
Definition: object.h:39