Main Page | Modules | Class List | Directories | File List | Class Members | File Members | Examples

axis2_array_list_ops Struct Reference
[Array List]

Array List ops struct. More...

#include <axis2_array_list.h>

List of all members.

Public Attributes

axis2_status_t(* ensure_capacity )(struct axis2_array_list *array_list, const axis2_env_t *env, int min_capacity)
int(* size )(struct axis2_array_list *array_list, const axis2_env_t *env)
axis2_bool_t(* is_empty )(struct axis2_array_list *array_list, const axis2_env_t *env)
axis2_bool_t(* contains )(struct axis2_array_list *array_list, const axis2_env_t *env, void *e)
int(* index_of )(struct axis2_array_list *array_list, const axis2_env_t *env, void *e)
int(* last_index_of )(struct axis2_array_list *array_list, const axis2_env_t *env, void *e)
void **(* to_array )(struct axis2_array_list *array_list, const axis2_env_t *env)
void *(* get )(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
void *(* set )(struct axis2_array_list *array_list, const axis2_env_t *env, int index, void *e)
axis2_status_t(* add )(struct axis2_array_list *array_list, const axis2_env_t *env, const void *e)
axis2_status_t(* add_at )(struct axis2_array_list *array_list, const axis2_env_t *env, const int index, const void *e)
void *(* remove )(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
axis2_bool_t(* check_bound_inclusive )(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
axis2_bool_t(* check_bound_exclusive )(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
axis2_status_t(* free )(struct axis2_array_list *array_list, const axis2_env_t *env)


Detailed Description

Array List ops struct.


Member Data Documentation

axis2_status_t( * axis2_array_list_ops::add)(struct axis2_array_list *array_list, const axis2_env_t *env, const void *e)
 

Appends the supplied element to the end of this list. The element, e, can be a pointer of any type or NULL.

Parameters:
e the element to be appended to this list
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t( * axis2_array_list_ops::add_at)(struct axis2_array_list *array_list, const axis2_env_t *env, const int index, const void *e)
 

Adds the supplied element at the specified index, shifting all elements currently at that index or higher one to the right. The element, e, can be a pointer of any type or NULL.

Parameters:
index the index at which the element is being added
e the item being added
Returns:
AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_bool_t( * axis2_array_list_ops::check_bound_exclusive)(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
 

Checks that the index is in the range of existing elements (exclusive).

Parameters:
index the index to check
Returns:
AXIS2_FALSE if index >= size or index < 0, else AXIS2_TRUE

axis2_bool_t( * axis2_array_list_ops::check_bound_inclusive)(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
 

Checks that the index is in the range of possible elements (inclusive).

Parameters:
index the index to check
Returns:
AXIS2_FALSE if index > size or index < 0, else AXIS2_TRUE

axis2_bool_t( * axis2_array_list_ops::contains)(struct axis2_array_list *array_list, const axis2_env_t *env, void *e)
 

Returns true iff element is in this array_list.

Parameters:
e the element whose inclusion in the List is being tested
Returns:
true if the list contains e

axis2_status_t( * axis2_array_list_ops::ensure_capacity)(struct axis2_array_list *array_list, const axis2_env_t *env, int min_capacity)
 

Guarantees that this list will have at least enough capacity to hold min_capacity elements. This implementation will grow the list to max(current * 2, min_capacity)

Parameters:
min_capacity the minimum guaranteed capacity

void*( * axis2_array_list_ops::get)(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
 

Retrieves the element at the user-supplied index.

Parameters:
index the index of the element we are fetching
Returns:
element at the given index

int( * axis2_array_list_ops::index_of)(struct axis2_array_list *array_list, const axis2_env_t *env, void *e)
 

Returns the lowest index at which element appears in this List, or -1 if it does not appear. This looks for the pointer value equality only, does not look into pointer content

Parameters:
e the element whose inclusion in the List is being tested
Returns:
the index where e was found

axis2_bool_t( * axis2_array_list_ops::is_empty)(struct axis2_array_list *array_list, const axis2_env_t *env)
 

Checks if the list is empty.

Returns:
true if there are no elements, else false

int( * axis2_array_list_ops::last_index_of)(struct axis2_array_list *array_list, const axis2_env_t *env, void *e)
 

Returns the highest index at which element appears in this List, or -1 if it does not appear. This looks for the pointer value equality only, does not look into pointer content

Parameters:
e the element whose inclusion in the List is being tested
Returns:
the index where e was found

void*( * axis2_array_list_ops::remove)(struct axis2_array_list *array_list, const axis2_env_t *env, int index)
 

Removes the element at the user-supplied index.

Parameters:
index the index of the element to be removed
Returns:
the removed void* pointer

void*( * axis2_array_list_ops::set)(struct axis2_array_list *array_list, const axis2_env_t *env, int index, void *e)
 

Sets the element at the specified index. The new element, e, can be an object of any type or null.

Parameters:
index the index at which the element is being set
e the element to be set
Returns:
the element previously at the specified index

int( * axis2_array_list_ops::size)(struct axis2_array_list *array_list, const axis2_env_t *env)
 

Returns the number of elements in this list.

Returns:
the list size

void**( * axis2_array_list_ops::to_array)(struct axis2_array_list *array_list, const axis2_env_t *env)
 

Returns a void* array containing all of the elements in this array_list. The array is not independent of this list.

Returns:
array of elements in this list


The documentation for this struct was generated from the following file:
Generated on Fri Jun 16 18:02:40 2006 for Axis2/C by  doxygen 1.4.2