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
|
/*
* ContentDisposition.java
* Copyright (C) 2002 The Free Software Foundation
*
* This file is part of GNU JavaMail, a library.
*
* GNU JavaMail is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* GNU JavaMail 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* As a special exception, if you link this library with other files to
* produce an executable, this library does not by itself cause the
* resulting executable to be covered by the GNU General Public License.
* This exception does not however invalidate any other reasons why the
* executable file might be covered by the GNU General Public License.
*/
package javax.mail.internet;
/**
* This class represents a MIME Content-Disposition value.
* It provides methods to parse a Content-Disposition string into
* individual components and to generate a MIME style Content-Disposition
* string.
*
* @author <a href="mailto:dog@gnu.org">Chris Burdess</a>
* @version 1.3
*/
public class ContentDisposition
{
/*
* The disposition value.
*/
private String disposition;
/*
* The available parameters.
*/
private ParameterList list;
/**
* No-arg constructor.
*/
public ContentDisposition()
{
}
/**
* Constructor.
* @param disposition disposition
* @param list ParameterList
*/
public ContentDisposition(String disposition, ParameterList list)
{
this.disposition = disposition;
this.list = list;
}
/**
* Constructor that takes a ContentDisposition string.
* The String is parsed into its constituents: disposition and parameters.
* A ParseException is thrown if the parse fails.
* @param s the ContentDisposition string.
* @exception ParseException if the parse fails.
*/
public ContentDisposition(String s)
throws ParseException
{
HeaderTokenizer ht = new HeaderTokenizer(s, HeaderTokenizer.MIME);
HeaderTokenizer.Token token = ht.next();
if (token.getType()!=HeaderTokenizer.Token.ATOM)
throw new ParseException();
disposition = token.getValue();
s = ht.getRemainder();
if (s!=null)
list = new ParameterList(s);
}
/**
* Return the disposition value.
* @return the disposition
*/
public String getDisposition()
{
return disposition;
}
/**
* Return the specified parameter value.
* Returns null if this parameter is absent.
* @param name the name of the parameter
* @return the parameter value
*/
public String getParameter(String name)
{
return (list!=null) ? list.get(name) : null;
}
/**
* Return a ParameterList object that holds all the available parameters.
* Returns null if no parameters are available.
*/
public ParameterList getParameterList()
{
return list;
}
/**
* Set the primary type. Overrides existing primary type.
* @param primaryType the primary type
*/
public void setDisposition(String disposition)
{
this.disposition = disposition;
}
/**
* Set the specified parameter.
* If this parameter already exists, it is replaced by this new value.
* @param name the parameter name
* @param value the parameter value
*/
public void setParameter(String name, String value)
{
if (list == null)
list = new ParameterList();
list.set(name, value);
}
/**
* Set a new ParameterList.
* @param list the ParameterList
*/
public void setParameterList(ParameterList list)
{
this.list = list;
}
/**
* Retrieve a RFC2045 style string representation of this
* ContentDisposition.
* Returns null if the conversion failed.
* @return RFC2045 style string
*/
public String toString()
{
if (disposition==null)
return null;
if (list==null)
return disposition;
else
{
StringBuffer buffer = new StringBuffer();
buffer.append(disposition);
// Add the parameters, using the toString(int) method
// which allows the resulting string to fold properly onto the next
// header line.
int used = buffer.length()+21; // "Content-Disposition: ".length()
buffer.append(list.toString(used));
return buffer.toString();
}
}
}
|
