| |
| /* |
| * 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_CHILDREN_ITERATOR_H |
| #define AXIOM_CHILDREN_ITERATOR_H |
| |
| /** |
| *@file axiom_children_iterator.h |
| *@brief this is the iterator for om nodes |
| */ |
| |
| #include <axiom_node.h> |
| #include <axiom_text.h> |
| |
| #ifdef __cplusplus |
| extern "C" |
| { |
| #endif |
| |
| typedef struct axiom_children_iterator axiom_children_iterator_t; |
| |
| /** |
| * @defgroup axiom_children_iterator children iterator |
| * @ingroup axiom_om |
| * @{ |
| */ |
| |
| /** |
| * @param current child |
| * @param env environment |
| * return axiom_children_iterator_t |
| */ |
| |
| AXIS2_EXTERN axiom_children_iterator_t *AXIS2_CALL |
| axiom_children_iterator_create( |
| const axutil_env_t * env, |
| axiom_node_t * current_child); |
| |
| /** |
| * Free the om_children_iterator struct |
| * |
| * @param iterator a pointer to axiom children iterator struct |
| * @param env environment, MUST NOT be NULL |
| */ |
| AXIS2_EXTERN void AXIS2_CALL |
| axiom_children_iterator_free( |
| axiom_children_iterator_t * 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 axiom children iterator struct |
| * @param env environment, MUST NOT be NULL |
| */ |
| AXIS2_EXTERN axis2_status_t AXIS2_CALL |
| axiom_children_iterator_remove( |
| axiom_children_iterator_t * iterator, |
| const axutil_env_t * env); |
| |
| /** |
| * @returns true if the iteration has more elements. In other |
| * words, returns true if next() would return an om_node_t struct |
| * rather than null with error code set in environment |
| * |
| * @param iterator a pointer to axiom children iterator struct |
| * @param env environment, MUST NOT be NULL |
| */ |
| |
| AXIS2_EXTERN axis2_bool_t AXIS2_CALL |
| axiom_children_iterator_has_next( |
| axiom_children_iterator_t * iterator, |
| const axutil_env_t * env); |
| |
| /** |
| * Returns the next element in the iteration. Returns null if there are |
| * no more elements in the iteration |
| * |
| * @param iterator a pointer to axiom children iterator struct |
| * @param env environment, MUST NOT be NULL |
| */ |
| AXIS2_EXTERN axiom_node_t *AXIS2_CALL |
| axiom_children_iterator_next( |
| axiom_children_iterator_t * iterator, |
| const axutil_env_t * env); |
| |
| /** |
| * Resets the Iterator. This moves the cursor back to the initial. |
| * iterator chidren_iterator to be reset. |
| * |
| * @param iterator a pointer to axiom children iterator struct |
| * @param env environment, MUST NOT be NULL |
| * |
| * @return satus of the op. AXIS2_SUCCESS on success else AXIS2_FAILURE. |
| */ |
| AXIS2_EXTERN axis2_status_t AXIS2_CALL |
| axiom_children_iterator_reset( |
| axiom_children_iterator_t * iterator, |
| const axutil_env_t * env); |
| |
| /** @} */ |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* AXIOM_CHILDREN_ITERATOR_H */ |