axis2_param_container.h

Go to the documentation of this file.
00001 /*
00002  * Licensed to the Apache Software Foundation (ASF) under one or more
00003  * contributor license agreements.  See the NOTICE file distributed with
00004  * this work for additional information regarding copyright ownership.
00005  * The ASF licenses this file to You under the Apache License, Version 2.0
00006  * (the "License"); you may not use this file except in compliance with
00007  * the License.  You may obtain a copy of the License at
00008  *
00009  *      http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 #ifndef AXIS2_PARAM_CONTAINER_H
00019 #define AXIS2_PARAM_CONTAINER_H
00020 
00031 #include <axis2_utils.h>
00032 #include <axis2_error.h>
00033 #include <axis2_utils_defines.h>
00034 #include <axis2_env.h>
00035 #include <axis2_allocator.h>
00036 #include <axis2_string.h>
00037 #include <axis2_array_list.h>
00038 #include <axis2_hash.h>
00039 
00040 /*#include <axiom_element.h>*/
00041 #include <axis2_qname.h>
00042 #include <axis2_param.h>
00043 
00044 #ifdef __cplusplus
00045 extern "C"
00046 {
00047 #endif
00048 
00049 struct axis2_param_container;
00050 struct axis2_param_container_ops;
00051  
00057 typedef axis2_status_t (AXIS2_CALL *AXIS2_PARAM_VALUE_FREE)(void *param, const axis2_env_t *env);    
00058 
00063  typedef struct axis2_param_container_ops
00064 {
00068    axis2_status_t (AXIS2_CALL *
00069    free)(struct axis2_param_container *param_container,
00070         const axis2_env_t *env);
00071 
00076    axis2_status_t (AXIS2_CALL *
00077    add_param)(struct axis2_param_container *param_container,
00078             const axis2_env_t *env,
00079             axis2_param_t *param);
00080 
00085    axis2_param_t *(AXIS2_CALL *
00086    get_param) (struct axis2_param_container *param_container, 
00087             const axis2_env_t *env,
00088             const axis2_char_t *name);
00089 
00090 
00094    axis2_array_list_t *(AXIS2_CALL *
00095    get_params)(struct axis2_param_container *param_container, 
00096             const axis2_env_t *env);
00097 
00102    axis2_bool_t (AXIS2_CALL *
00103    is_param_locked)(struct axis2_param_container *param_container, 
00104                 const axis2_env_t *env,
00105                 const axis2_char_t *param_name) ;
00106 
00107 }axis2_param_container_ops_t;
00108 
00113  typedef struct axis2_param_container
00114 {
00115    axis2_param_container_ops_t *ops;
00116 }axis2_param_container_t;
00117 
00122 AXIS2_EXTERN axis2_param_container_t * AXIS2_CALL 
00123 axis2_param_container_create (const axis2_env_t *env);
00124 
00130 AXIS2_EXTERN axis2_status_t AXIS2_CALL 
00131 axis2_param_container_free_void_arg (void *param_container,
00132                                         const axis2_env_t *env);
00133                                     
00134 /*************************** Function macros **********************************/
00135 
00136 #define AXIS2_PARAM_CONTAINER_FREE(param_container, env) \
00137       ((param_container)->ops->free (param_container, env))
00138 
00139 #define AXIS2_PARAM_CONTAINER_ADD_PARAM(param_container, env, param) \
00140       ((param_container)->ops->add_param (param_container, env, param))
00141 
00142 #define AXIS2_PARAM_CONTAINER_GET_PARAM(param_container, env, name) \
00143       ((param_container)->ops->get_param (param_container, env, name))
00144 
00145 #define AXIS2_PARAM_CONTAINER_GET_PARAMS(param_container, env) \
00146       ((param_container)->ops->get_params (param_container, env))
00147 
00148 #define AXIS2_PARAM_CONTAINER_IS_PARAM_LOCKED(param_container, env, param_name) \
00149       ((param_container)->ops->is_param_locked (param_container, env, \
00150       param_name))
00151 
00152 /*************************** End of function macros ***************************/
00153 
00156 #ifdef __cplusplus
00157 }
00158 #endif
00159 #endif  /* AXIS2_PARAM_CONTAINER_H */

Generated on Wed Dec 20 20:14:10 2006 for Axis2/C by  doxygen 1.5.1