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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
classdef Properties < IceInternal.WrapperObject
% Properties Summary of Properties
%
% A property set used to configure Ice and Ice applications.
% Properties are key/value pairs, with both keys and values
% being strings. By convention, property keys should have the
% form application-name[.category[.sub-category]].name.
%
% Property Methods:
% getProperty - Get a property by key.
% getPropertyWithDefault - Get a property by key.
% getPropertyAsInt - Get a property as an integer.
% getPropertyAsIntWithDefault - Get a property as an integer.
% getPropertyAsList - Get a property as a list of strings.
% getPropertyAsListWithDefault - Get a property as a list of strings.
% getPropertiesForPrefix - Get all properties whose keys begins with
% a prefix.
% setProperty - Set a property.
% getCommandLineOptions - Get a sequence of command-line options that
% is equivalent to this property set.
% parseCommandLineOptions - Convert a sequence of command-line options
% into properties.
% parseIceCommandLineOptions - Convert a sequence of command-line options
% into properties.
% load - Load properties from a file.
% clone - Create a copy of this property set.
% Copyright (c) ZeroC, Inc. All rights reserved.
methods
function obj = Properties(impl)
if ~isa(impl, 'lib.pointer')
throw(MException('Ice:ArgumentException', 'invalid argument'));
end
obj = obj@IceInternal.WrapperObject(impl);
end
function r = getProperty(obj, key)
% getProperty - Get a property by key. If the property is not set,
% an empty string is returned.
%
% Parameters:
% key (char) - The property key.
%
% Returns (char) - The property value.
r = obj.iceCallWithResult('getProperty', key);
end
function r = getPropertyWithDefault(obj, key, def)
% getPropertyWithDefault - Get a property by key. If the property
% is not set, the given default value is returned.
%
% Parameters:
% key (char) - The property key.
% def (char) - The default value to use if the property does not
% exist.
%
% Returns (char) - The property value or the default value.
r = obj.iceCallWithResult('getPropertyWithDefault', key, def);
end
function r = getPropertyAsInt(obj, key)
% getPropertyAsInt - Get a property as an integer. If the property
% is not set, 0 is returned.
%
% Parameters:
% key (char) - The property key.
%
% Returns (int32) - The property value interpreted as an integer.
v = libpointer('int32Ptr', 0);
obj.iceCall('getPropertyAsInt', key, v);
r = v.Value;
end
function r = getPropertyAsIntWithDefault(obj, key, def)
% getPropertyAsIntWithDefault - Get a property as an integer. If
% the property is not set, the given default value is returned.
%
% Parameters:
% key (char) - The property key.
% def (int32) - The default value to use if the property does
% not exist.
%
% Returns (int32) - The property value interpreted as an integer,
% or the default value.
v = libpointer('int32Ptr', 0);
obj.iceCall('getPropertyAsIntWithDefault', key, def, v);
r = v.Value;
end
function r = getPropertyAsList(obj, key)
% getPropertyAsList - Get a property as a list of strings. The
% strings must be separated by whitespace or comma. If the
% property is not set, an empty list is returned. The strings
% in the list can contain whitespace and commas if they are
% enclosed in single or double quotes. If quotes are mismatched,
% an empty list is returned. Within single quotes or double
% quotes, you can escape the quote in question with \, e.g.
% O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
%
% Parameters:
% key (char) - The property key.
%
% Returns (cell arry of char) - The property value interpreted as
% a list of strings.
r = obj.iceCallWithResult('getPropertyAsList', key);
end
function r = getPropertyAsListWithDefault(obj, key, def)
% getPropertyAsListWithDefault - Get a property as a list of
% strings. The strings must be separated by whitespace or comma.
% If the property is not set, the given default value is returned.
% The strings in the list can contain whitespace and commas if
% they are enclosed in single or double quotes. If quotes are
% mismatched, an empty list is returned. Within single quotes or
% double quotes, you can escape the quote in question with \, e.g.
% O'Reilly can be written as O'Reilly, "O'Reilly" or 'O\'Reilly'.
%
% Parameters:
% key (char) - The property key.
% def (cell array of char) - The default value to use if the
% property is not set.
%
% Returns (cell arry of char) - The property value interpreted as
% a list of strings, or the default value.
r = obj.iceCallWithResult('getPropertyAsListWithDefault', key, def);
end
function r = getPropertiesForPrefix(obj, prefix)
% getPropertiesForPrefix - Get all properties whose keys begins with
% prefix. If prefix is an empty string, then all properties are
% returned.
%
% Parameters:
% prefix (char) - The prefix to search for (empty string if none).
%
% Returns (containers.Map) - The matching property set.
r = obj.iceCallWithResult('getPropertiesForPrefix', prefix);
end
function setProperty(obj, key, value)
% setProperty - Set a property. To unset a property, set it to
% the empty string.
%
% Parameters:
% key (char) - The property key.
% value (char) - The property value.
obj.iceCall('setProperty', key, value);
end
function r = getCommandLineOptions(obj)
% getCommandLineOptions - Get a sequence of command-line options
% that is equivalent to this property set. Each element of the
% returned sequence is a command-line option of the form
% --key=value.
%
% Returns (cell array of char) - The command line options for this
% property set.
r = obj.iceCallWithResult('getCommandLineOptions');
end
function r = parseCommandLineOptions(obj, prefix, options)
% parseCommandLineOptions - Convert a sequence of command-line
% options into properties. All options that begin with
% "--prefix." are converted into properties. If the prefix is
% empty, all options that begin with "--" are converted to
% properties.
%
% Parameters:
% prefix (char) - The property prefix, or an empty string to
% convert all options starting with "--".
% options (cell array of char) - The command-line options.
%
% Returns (cell array of char) The command-line options that do
% not start with the specified prefix, in their original order.
r = obj.iceCallWithResult('parseCommandLineOptions', prefix, options);
end
function r = parseIceCommandLineOptions(obj, options)
% parseIceCommandLineOptions - Convert a sequence of command-line
% options into properties. All options that begin with one of the
% following prefixes are converted into properties: "--Ice",
% "--IceBox", "--IceGrid", "--IceSSL", "--IceStorm", and "--Glacier2".
%
% Parameters:
% options (cell array of char) - The command-line options.
%
% Returns (cell array of char) - The command-line options that do
% not start with one of the listed prefixes, in their original
% order.
r = obj.iceCallWithResult('parseIceCommandLineOptions', options);
end
function load(obj, file)
% load - Load properties from a file.
%
% Parameters:
% file (char) - The property file.
obj.iceCall('load', file);
end
function r = clone(obj)
% clone - Create a copy of this property set.
%
% Returns (Ice.Properties) - A copy of this property set.
impl = libpointer('voidPtr');
obj.iceCall('clone', impl);
r = Ice.Properties(impl);
end
end
end
|
