1 | /**************************************************************** |
---|
2 | * Licensed to the Apache Software Foundation (ASF) under one * |
---|
3 | * or more contributor license agreements. See the NOTICE file * |
---|
4 | * distributed with this work for additional information * |
---|
5 | * regarding copyright ownership. The ASF licenses this file * |
---|
6 | * to you under the Apache License, Version 2.0 (the * |
---|
7 | * "License"); you may not use this file except in compliance * |
---|
8 | * with the License. You may obtain a copy of the License at * |
---|
9 | * * |
---|
10 | * http://www.apache.org/licenses/LICENSE-2.0 * |
---|
11 | * * |
---|
12 | * Unless required by applicable law or agreed to in writing, * |
---|
13 | * software distributed under the License is distributed on an * |
---|
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * |
---|
15 | * KIND, either express or implied. See the License for the * |
---|
16 | * specific language governing permissions and limitations * |
---|
17 | * under the License. * |
---|
18 | ****************************************************************/ |
---|
19 | |
---|
20 | package org.apache.james.mime4j.message; |
---|
21 | |
---|
22 | import java.util.Collections; |
---|
23 | import java.util.HashMap; |
---|
24 | import java.util.Iterator; |
---|
25 | import java.util.LinkedList; |
---|
26 | import java.util.List; |
---|
27 | import java.util.Map; |
---|
28 | |
---|
29 | import org.apache.james.mime4j.dom.Header; |
---|
30 | import org.apache.james.mime4j.dom.field.Field; |
---|
31 | |
---|
32 | /** |
---|
33 | * The header of an entity (see RFC 2045). |
---|
34 | */ |
---|
35 | public abstract class AbstractHeader implements Header { |
---|
36 | |
---|
37 | private List<Field> fields = new LinkedList<Field>(); |
---|
38 | private Map<String, List<Field>> fieldMap = new HashMap<String, List<Field>>(); |
---|
39 | |
---|
40 | /** |
---|
41 | * Creates a new empty <code>Header</code>. |
---|
42 | */ |
---|
43 | public AbstractHeader() { |
---|
44 | } |
---|
45 | |
---|
46 | /** |
---|
47 | * Creates a new <code>Header</code> from the specified |
---|
48 | * <code>Header</code>. The <code>Header</code> instance is initialized |
---|
49 | * with a copy of the list of {@link Field}s of the specified |
---|
50 | * <code>Header</code>. The <code>Field</code> objects are not copied |
---|
51 | * because they are immutable and can safely be shared between headers. |
---|
52 | * |
---|
53 | * @param other |
---|
54 | * header to copy. |
---|
55 | */ |
---|
56 | public AbstractHeader(Header other) { |
---|
57 | for (Field otherField : other.getFields()) { |
---|
58 | addField(otherField); |
---|
59 | } |
---|
60 | } |
---|
61 | |
---|
62 | /** |
---|
63 | * Adds a field to the end of the list of fields. |
---|
64 | * |
---|
65 | * @param field the field to add. |
---|
66 | */ |
---|
67 | public void addField(Field field) { |
---|
68 | List<Field> values = fieldMap.get(field.getName().toLowerCase()); |
---|
69 | if (values == null) { |
---|
70 | values = new LinkedList<Field>(); |
---|
71 | fieldMap.put(field.getName().toLowerCase(), values); |
---|
72 | } |
---|
73 | values.add(field); |
---|
74 | fields.add(field); |
---|
75 | } |
---|
76 | |
---|
77 | /** |
---|
78 | * Gets the fields of this header. The returned list will not be |
---|
79 | * modifiable. |
---|
80 | * |
---|
81 | * @return the list of <code>Field</code> objects. |
---|
82 | */ |
---|
83 | public List<Field> getFields() { |
---|
84 | return Collections.unmodifiableList(fields); |
---|
85 | } |
---|
86 | |
---|
87 | /** |
---|
88 | * Gets a <code>Field</code> given a field name. If there are multiple |
---|
89 | * such fields defined in this header the first one will be returned. |
---|
90 | * |
---|
91 | * @param name the field name (e.g. From, Subject). |
---|
92 | * @return the field or <code>null</code> if none found. |
---|
93 | */ |
---|
94 | public Field getField(String name) { |
---|
95 | List<Field> l = fieldMap.get(name.toLowerCase()); |
---|
96 | if (l != null && !l.isEmpty()) { |
---|
97 | return l.get(0); |
---|
98 | } |
---|
99 | return null; |
---|
100 | } |
---|
101 | |
---|
102 | /** |
---|
103 | * Gets all <code>Field</code>s having the specified field name. |
---|
104 | * |
---|
105 | * @param name the field name (e.g. From, Subject). |
---|
106 | * @return the list of fields. |
---|
107 | */ |
---|
108 | public List<Field> getFields(final String name) { |
---|
109 | final String lowerCaseName = name.toLowerCase(); |
---|
110 | final List<Field> l = fieldMap.get(lowerCaseName); |
---|
111 | final List<Field> results; |
---|
112 | if (l == null || l.isEmpty()) { |
---|
113 | results = Collections.emptyList(); |
---|
114 | } else { |
---|
115 | results = Collections.unmodifiableList(l); |
---|
116 | } |
---|
117 | return results; |
---|
118 | } |
---|
119 | |
---|
120 | /** |
---|
121 | * Returns an iterator over the list of fields of this header. |
---|
122 | * |
---|
123 | * @return an iterator. |
---|
124 | */ |
---|
125 | public Iterator<Field> iterator() { |
---|
126 | return Collections.unmodifiableList(fields).iterator(); |
---|
127 | } |
---|
128 | |
---|
129 | /** |
---|
130 | * Removes all <code>Field</code>s having the specified field name. |
---|
131 | * |
---|
132 | * @param name |
---|
133 | * the field name (e.g. From, Subject). |
---|
134 | * @return number of fields removed. |
---|
135 | */ |
---|
136 | public int removeFields(String name) { |
---|
137 | final String lowerCaseName = name.toLowerCase(); |
---|
138 | List<Field> removed = fieldMap.remove(lowerCaseName); |
---|
139 | if (removed == null || removed.isEmpty()) |
---|
140 | return 0; |
---|
141 | |
---|
142 | for (Iterator<Field> iterator = fields.iterator(); iterator.hasNext();) { |
---|
143 | Field field = iterator.next(); |
---|
144 | if (field.getName().equalsIgnoreCase(name)) |
---|
145 | iterator.remove(); |
---|
146 | } |
---|
147 | |
---|
148 | return removed.size(); |
---|
149 | } |
---|
150 | |
---|
151 | /** |
---|
152 | * Sets or replaces a field. This method is useful for header fields such as |
---|
153 | * Subject or Message-ID that should not occur more than once in a message. |
---|
154 | * |
---|
155 | * If this <code>Header</code> does not already contain a header field of |
---|
156 | * the same name as the given field then it is added to the end of the list |
---|
157 | * of fields (same behavior as {@link #addField(Field)}). Otherwise the |
---|
158 | * first occurrence of a field with the same name is replaced by the given |
---|
159 | * field and all further occurrences are removed. |
---|
160 | * |
---|
161 | * @param field the field to set. |
---|
162 | */ |
---|
163 | public void setField(Field field) { |
---|
164 | final String lowerCaseName = field.getName().toLowerCase(); |
---|
165 | List<Field> l = fieldMap.get(lowerCaseName); |
---|
166 | if (l == null || l.isEmpty()) { |
---|
167 | addField(field); |
---|
168 | return; |
---|
169 | } |
---|
170 | |
---|
171 | l.clear(); |
---|
172 | l.add(field); |
---|
173 | |
---|
174 | int firstOccurrence = -1; |
---|
175 | int index = 0; |
---|
176 | for (Iterator<Field> iterator = fields.iterator(); iterator.hasNext(); index++) { |
---|
177 | Field f = iterator.next(); |
---|
178 | if (f.getName().equalsIgnoreCase(field.getName())) { |
---|
179 | iterator.remove(); |
---|
180 | |
---|
181 | if (firstOccurrence == -1) |
---|
182 | firstOccurrence = index; |
---|
183 | } |
---|
184 | } |
---|
185 | |
---|
186 | fields.add(firstOccurrence, field); |
---|
187 | } |
---|
188 | |
---|
189 | /** |
---|
190 | * Return Header Object as String representation. Each headerline is |
---|
191 | * seperated by "\r\n" |
---|
192 | * |
---|
193 | * @return headers |
---|
194 | */ |
---|
195 | @Override |
---|
196 | public String toString() { |
---|
197 | StringBuilder str = new StringBuilder(128); |
---|
198 | for (Field field : fields) { |
---|
199 | str.append(field.toString()); |
---|
200 | str.append("\r\n"); |
---|
201 | } |
---|
202 | return str.toString(); |
---|
203 | } |
---|
204 | |
---|
205 | } |
---|