axiom_stax_builder_ops Struct Reference
[stax builder]

stax builder ops struct Encapsulator struct for ops of axiom_stax_builder More...

#include <axiom_stax_builder.h>

List of all members.

Public Attributes

axiom_node_t *(* next )(struct axiom_stax_builder *builder, const axis2_env_t *env)
axis2_status_t(* discard_current_element )(struct axiom_stax_builder *builder, const axis2_env_t *env)
axis2_status_t(* free )(struct axiom_stax_builder *builder, const axis2_env_t *env)
axiom_document_t *(* get_document )(struct axiom_stax_builder *builder, const axis2_env_t *env)
axis2_bool_t(* is_complete )(struct axiom_stax_builder *builder, const axis2_env_t *env)
int(* next_with_token )(struct axiom_stax_builder *builder, const axis2_env_t *env)


Detailed Description

stax builder ops struct Encapsulator struct for ops of axiom_stax_builder


Member Data Documentation

axis2_status_t( * axiom_stax_builder_ops::discard_current_element)(struct axiom_stax_builder *builder, const axis2_env_t *env)
 

Discards the element that is being built currently.

Parameters:
environment Environment. MUST NOT be NULL, .
builder pointer to stax builder struct to be used
Returns:
satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE.

axis2_status_t( * axiom_stax_builder_ops::free)(struct axiom_stax_builder *builder, const axis2_env_t *env)
 

Free op

Parameters:
builder pointer to builder struct
env environment, MUST NOT be NULL
Returns:
status of the op AXIS2_SUCCESS on success, AXIS2_FAILURE on error.

axiom_document_t*( * axiom_stax_builder_ops::get_document)(struct axiom_stax_builder *builder, const axis2_env_t *env)
 

get the document associated with the builder

Parameters:
builder axiom_stax_builder
env environment
Returns:
pointer to document struct associated with builder NULL if there is no document associated with the builder, NULL if an error occured.

axis2_bool_t( * axiom_stax_builder_ops::is_complete)(struct axiom_stax_builder *builder, const axis2_env_t *env)
 

builder is finished building om structure

axiom_node_t*( * axiom_stax_builder_ops::next)(struct axiom_stax_builder *builder, const axis2_env_t *env)
 

Builds the next node from stream. Moves pull parser forward and reacts to events.

Parameters:
environment Environment. MUST NOT be NULL.
builder pointer to stax builder struct to be used
Returns:
a pointer to the next node, or NULL if there are no more nodes. On erros sets the error and returns NULL.

int( * axiom_stax_builder_ops::next_with_token)(struct axiom_stax_builder *builder, const axis2_env_t *env)
 

moves the reader to next event and returns the token returned by the xml_reader , returns -1 on error


The documentation for this struct was generated from the following file:
Generated on Thu Aug 31 17:32:39 2006 for Axis2/C by  doxygen 1.4.6