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
|
/*
* Copyright (C) 2011 Collabora Ltd.
*
* This library is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
* Authors:
* Marco Barisione <marco.barisione@collabora.co.uk>
*/
using GLib;
using Gee;
/**
* Object representing a string value that can have some parameters
* associated with it.
*
* Some contact details, like phone numbers or URLs, can have some
* extra details associated with them.
* For instance, a phone number expressed in vcard notation as
* `tel;type=work,voice:(111) 555-1234` would be represented as
* a FieldDetails with value "(111) 555-1234" and with parameters
* `['type': ('work', 'voice')]`.
*
* @since 0.3.5
*/
public class Folks.FieldDetails : Object
{
/* The value of the field.
*
* The value of the field, the exact content depends on what the structure is
* used for.
*
* @since 0.3.5
*/
public string value { get; set; }
/**
* The parameters associated with the value.
*
* A hash table of the parameters associated with
* {@link Folks.FieldDetails.value}. The keys are the names of the
* parameters, while the values are a list of strings.
*
* @since 0.5.1
*/
public MultiMap<string, string> parameters { get; set; }
/**
* Create a new FieldDetails.
*
* @param value the value of the field
* @return a new FieldDetails
*
* @since 0.3.5
*/
public FieldDetails (string value)
{
this.value = value;
this.parameters = new HashMultiMap<string, string> ();
}
/**
* Get the values for a parameter
*
* @param parameter_name the parameter name
* @return a collection of values for `parameter_name` or `null` (i.e. no
* collection) if there are no such parameters.
*
* @since 0.5.1
*/
public Collection<string>? get_parameter_values (string parameter_name)
{
if (this.parameters.contains (parameter_name) == false)
{
return null;
}
return this.parameters.get (parameter_name).read_only_view;
}
/**
* Add a new value for a parameter.
*
* If there is already a parameter called `parameter_name` then
* `parameter_value` is added to the existing ones.
*
* @param parameter_name the name of the parameter
* @param parameter_value the value to add
*
* @since 0.3.5
*/
public void add_parameter (string parameter_name, string parameter_value)
{
this.parameters.set (parameter_name, parameter_value);
}
/**
* Set the value of a parameter.
*
* Sets the parameter called `parameter_name` to be `parameter_value`.
* If there were already parameters with the same name they are replaced.
*
* @param parameter_name the name of the parameter
* @param parameter_value the value to add
*
* @since 0.3.5
*/
public void set_parameter (string parameter_name, string parameter_value)
{
this.parameters.remove_all (parameter_name);
this.parameters.set (parameter_name, parameter_value);
}
/**
* Extend the existing parameters.
*
* Merge the parameters from `additional` into the existing ones.
*
* @param additional the parameters to add
*
* @since 0.5.1
*/
public void extend_parameters (MultiMap<string, string> additional)
{
foreach (var name in additional.get_keys ())
{
var values = additional.get (name);
foreach (var val in values)
{
this.add_parameter (name, val);
}
}
}
/**
* Remove all instances of a parameter.
*
* @param parameter_name the name of the parameter
*
* @since 0.3.5
*/
public void remove_parameter_all (string parameter_name)
{
this.parameters.remove_all (parameter_name);
}
}
|
