1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
/*
* 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 AXUTIL_PROPERTIES_H
#define AXUTIL_PROPERTIES_H
#include <axutil_utils_defines.h>
#include <axutil_error.h>
#include <axutil_env.h>
#include <axutil_hash.h>
#include <stdio.h>
#ifdef __cplusplus
extern "C"
{
#endif
/**
* @defgroup axutil_properties properties
* @ingroup axis2_util
* @{
*/
typedef struct axutil_properties axutil_properties_t;
/**
* create new properties
* @return properties newly created properties
*/
AXIS2_EXTERN axutil_properties_t *AXIS2_CALL
axutil_properties_create(
const axutil_env_t * env);
/**
* free w2c_properties.
* @param properties pointer to properties struct
* @param env Environment. MUST NOT be NULL
* @return status of the op. AXIS2_SUCCESS on success
* else AXIS2_FAILURE
*/
AXIS2_EXTERN void AXIS2_CALL
axutil_properties_free(
axutil_properties_t * properties,
const axutil_env_t * env);
/**
* get string value for property with specified key.
* @param properties pointer to properties struct
* @param env Environment. MUST NOT be NULL
* @param key MUST NOT be NULL
* @return value of the property
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axutil_properties_get_property(
axutil_properties_t * properties,
const axutil_env_t * env,
axis2_char_t * key);
/**
* set a property ( key, value) pair.
* @param properties pointer to properties struct
* @param env Environment. MUST NOT be NULL
* @param key Property Key. MUST NOT be NULL
* @param value Property Value
* @return status of the op. AXIS2_SUCCESS on success
* else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_properties_set_property(
axutil_properties_t * properties,
const axutil_env_t * env,
axis2_char_t * key,
axis2_char_t * value);
/**
* retrieve the hash with all the properties
* @param properties pointer to properties struct
* @param env Environment. MUST NOT be NULL
* @return hash (key,value)
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axutil_properties_get_all(
axutil_properties_t * properties,
const axutil_env_t * env);
/**
* load properties
* @param properties pointer to properties struct
* @param env Environment. MUST NOT be NULL
* @param input Input Stream. MUST NOT be NULL
* @return status of the op. AXIS2_SUCCESS on success
* else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_properties_load(
axutil_properties_t * properties,
const axutil_env_t * env,
axis2_char_t * input_filename);
/**
* store properties
* @param properties pointer to properties struct
* @param env Environment. MUST NOT be NULL
* @param ouput Output Stream. MUST NOT be NULL
* @return status of the op. AXIS2_SUCCESS on success
* else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axutil_properties_store(
axutil_properties_t * properites,
const axutil_env_t * env,
FILE * output);
/*************************** End of function macros ***************************/
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_PROPERTIES_H */
|
