1 files changed, 124 insertions, 0 deletions
diff --git a/axiom/include/axiom_child_element_iterator.h b/axiom/include/axiom_child_element_iterator.h
new file mode 100644
index 0000000..627a347
--- /dev/null
+++ b/axiom/include/axiom_child_element_iterator.h
@@ -0,0 +1,124 @@
+
+/*
+ * 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_CHILD_ELEMENT_ITERATOR_H
+#define AXIOM_CHILD_ELEMENT_ITERATOR_H
+
+/**
+*@file axiom_child_element_iterator.h
+*@brief this is the iterator for om elemnts
+*/
+
+#include <axiom_node.h>
+#include <axiom_text.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+    typedef struct axiom_child_element_iterator
+                axiom_child_element_iterator_t;
+
+    /**
+     * @defgroup axiom_child_element_iterator child element iterator
+     * @ingroup axiom_om
+     * @{
+     */
+    
+    /**
+     * Free the iterator
+     * @param iterator a pointer to child element iterator struct
+     * @param env environment, MUST NOT be NULL.
+     */
+    
+    AXIS2_EXTERN void AXIS2_CALL
+    axiom_child_element_iterator_free(
+        void *iterator,
+        const axutil_env_t * env);
+
+    /**
+    * Removes from the underlying collection the last element returned by the
+    * iterator (optional op).  This method can be called only once per
+    * call to <tt>next</tt>.  The behavior of an iterator is unspecified if
+    * the underlying collection is modified while the iteration is in
+    * progress in any way other than by calling this method.
+    *  @param iterator a pointer to child element iterator struct
+     * @param env environment, MUST NOT be NULL.
+    */
+    
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
+    axiom_child_element_iterator_remove(
+        axiom_child_element_iterator_t * iterator,
+        const axutil_env_t * env);
+
+    /**
+     * returns true if the iteration has more elements 
+     * in otherwords it returns true if the next() would return an element
+     * rather than null with an error code set to environments error
+     * @param iterator a pointer to child element iterator struct
+     * @param env environment, MUST NOT be NULL.
+     */
+    AXIS2_EXTERN axis2_bool_t AXIS2_CALL
+
+    axiom_child_element_iterator_has_next(
+        axiom_child_element_iterator_t * iterator,
+        const axutil_env_t * env);
+
+    /**
+     * Returns the next element in the iteration. Returns null if there 
+     * is no more elements 
+     * @param iterator a pointer to child element iterator struct
+     * @param env environment, MUST NOT be NULL.
+     */
+    AXIS2_EXTERN axiom_node_t *AXIS2_CALL
+    axiom_child_element_iterator_next(
+        axiom_child_element_iterator_t * iterator,
+        const axutil_env_t * env);
+
+    /**
+     * Create a child element interator for the current child
+     * @param current child
+     * @param env environment, MUST NOT be NULL.
+     * return axiom_child_element_iterator_t
+     */
+
+    AXIS2_EXTERN axiom_child_element_iterator_t *AXIS2_CALL
+    axiom_child_element_iterator_create(
+        const axutil_env_t * env,
+        axiom_node_t * current_child);
+
+#define AXIOM_CHILD_ELEMENT_ITERATOR_FREE(iterator, env) \
+        axiom_child_element_iterator_free(iterator, env)
+
+#define AXIOM_CHILD_ELEMENT_ITERATOR_REMOVE(iterator, env) \
+        axiom_child_element_iterator_remove(iterator, env)
+
+#define AXIOM_CHILD_ELEMENT_ITERATOR_HAS_NEXT(iterator, env) \
+        axiom_child_element_iterator_has_next(iterator, env)
+
+#define AXIOM_CHILD_ELEMENT_ITERATOR_NEXT(iterator, env) \
+        axiom_child_element_iterator_next(iterator, env)
+
+    /** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif                          /* AXIOM_CHILD_ELEMENT_ITERATOR_H */