1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AXIOM_STAX_BUILDER_H
#define AXIOM_STAX_BUILDER_H
#include <axiom_node.h>
#include <axiom_xml_reader.h>
#include <axiom_document.h>
#include <axutil_env.h>
#ifdef __cplusplus
extern "C"
{
#endif
/**
* @defgroup axiom_stax_builder stax builder
* @ingroup axiom_om
* @{
*/
typedef struct axiom_stax_builder axiom_stax_builder_t;
/**
* Creates an stax builder
* @param environment Environment. MUST NOT be NULL.
* @param parser parser to be used with builder. The builder will take ownership of the parser.
* @return a pointer to the newly created builder struct.
*/
AXIS2_EXTERN axiom_stax_builder_t *AXIS2_CALL
axiom_stax_builder_create(
const axutil_env_t * env,
axiom_xml_reader_t * parser);
/**
* Free the build struct instance and its associated document,axiom tree.
* @param builder pointer to builder struct
* @param env environment, MUST NOT be NULL
* @return status of the operation AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_stax_builder_free(
axiom_stax_builder_t *builder,
const axutil_env_t * env);
/**
* Free the build struct instance and its associated document.
* Will not free the associated axiom tree.
* @param builder pointer to builder struct
* @param env environment, MUST NOT be NULL
* @return status of the operation AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
*/
AXIS2_EXTERN void AXIS2_CALL
axiom_stax_builder_free_self(
axiom_stax_builder_t *builder,
const axutil_env_t * env);
/**
* Gets the document associated with the builder
* @param builder axiom_stax_builder
* @param env environment
* @return pointer to document struct associated with builder NULL if an error occurred.
*/
AXIS2_EXTERN axiom_document_t *AXIS2_CALL
axiom_stax_builder_get_document(
axiom_stax_builder_t *builder,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIOM_STAX_BUILDER_H */
|
