001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: /*
038: * @(#)ContentDisposition.java 1.9 07/05/04
039: */
040:
041: package javax.mail.internet;
042:
043: import javax.mail.*;
044: import java.util.*;
045: import java.io.*;
046:
047: /**
048: * This class represents a MIME ContentDisposition value. It provides
049: * methods to parse a ContentDisposition string into individual components
050: * and to generate a MIME style ContentDisposition string.
051: *
052: * @version 1.9, 07/05/04
053: * @author John Mani
054: */
055:
056: public class ContentDisposition {
057:
058: private String disposition; // disposition
059: private ParameterList list; // parameter list
060:
061: /**
062: * No-arg Constructor.
063: */
064: public ContentDisposition() {
065: }
066:
067: /**
068: * Constructor.
069: *
070: * @param disposition disposition
071: * @param list ParameterList
072: * @since JavaMail 1.2
073: */
074: public ContentDisposition(String disposition, ParameterList list) {
075: this .disposition = disposition;
076: this .list = list;
077: }
078:
079: /**
080: * Constructor that takes a ContentDisposition string. The String
081: * is parsed into its constituents: dispostion and parameters.
082: * A ParseException is thrown if the parse fails.
083: *
084: * @param s the ContentDisposition string.
085: * @exception ParseException if the parse fails.
086: * @since JavaMail 1.2
087: */
088: public ContentDisposition(String s) throws ParseException {
089: HeaderTokenizer h = new HeaderTokenizer(s, HeaderTokenizer.MIME);
090: HeaderTokenizer.Token tk;
091:
092: // First "disposition" ..
093: tk = h.next();
094: if (tk.getType() != HeaderTokenizer.Token.ATOM)
095: throw new ParseException();
096: disposition = tk.getValue();
097:
098: // Then parameters ..
099: String rem = h.getRemainder();
100: if (rem != null)
101: list = new ParameterList(rem);
102: }
103:
104: /**
105: * Return the disposition value.
106: * @return the disposition
107: * @since JavaMail 1.2
108: */
109: public String getDisposition() {
110: return disposition;
111: }
112:
113: /**
114: * Return the specified parameter value. Returns <code>null</code>
115: * if this parameter is absent.
116: * @return parameter value
117: * @since JavaMail 1.2
118: */
119: public String getParameter(String name) {
120: if (list == null)
121: return null;
122:
123: return list.get(name);
124: }
125:
126: /**
127: * Return a ParameterList object that holds all the available
128: * parameters. Returns null if no parameters are available.
129: *
130: * @return ParameterList
131: * @since JavaMail 1.2
132: */
133: public ParameterList getParameterList() {
134: return list;
135: }
136:
137: /**
138: * Set the disposition. Replaces the existing disposition.
139: * @param disposition the disposition
140: * @since JavaMail 1.2
141: */
142: public void setDisposition(String disposition) {
143: this .disposition = disposition;
144: }
145:
146: /**
147: * Set the specified parameter. If this parameter already exists,
148: * it is replaced by this new value.
149: *
150: * @param name parameter name
151: * @param value parameter value
152: * @since JavaMail 1.2
153: */
154: public void setParameter(String name, String value) {
155: if (list == null)
156: list = new ParameterList();
157:
158: list.set(name, value);
159: }
160:
161: /**
162: * Set a new ParameterList.
163: * @param list ParameterList
164: * @since JavaMail 1.2
165: */
166: public void setParameterList(ParameterList list) {
167: this .list = list;
168: }
169:
170: /**
171: * Retrieve a RFC2045 style string representation of
172: * this ContentDisposition. Returns <code>null</code> if
173: * the conversion failed.
174: *
175: * @return RFC2045 style string
176: * @since JavaMail 1.2
177: */
178: public String toString() {
179: if (disposition == null)
180: return null;
181:
182: if (list == null)
183: return disposition;
184:
185: StringBuffer sb = new StringBuffer(disposition);
186:
187: // append the parameter list
188: // use the length of the string buffer + the length of
189: // the header name formatted as follows "Content-Disposition: "
190: sb.append(list.toString(sb.length() + 21));
191: return sb.toString();
192: }
193: }
|