Thu, 31 Aug 2017 15:18:52 +0800
merge
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | /* |
aoqi@0 | 27 | * @(#)ContentDisposition.java 1.6 02/03/27 |
aoqi@0 | 28 | */ |
aoqi@0 | 29 | |
aoqi@0 | 30 | |
aoqi@0 | 31 | |
aoqi@0 | 32 | package com.sun.xml.internal.messaging.saaj.packaging.mime.internet; |
aoqi@0 | 33 | |
aoqi@0 | 34 | |
aoqi@0 | 35 | /** |
aoqi@0 | 36 | * This class represents a MIME ContentDisposition value. It provides |
aoqi@0 | 37 | * methods to parse a ContentDisposition string into individual components |
aoqi@0 | 38 | * and to generate a MIME style ContentDisposition string. |
aoqi@0 | 39 | * |
aoqi@0 | 40 | * @version 1.6, 02/03/27 |
aoqi@0 | 41 | * @author John Mani |
aoqi@0 | 42 | */ |
aoqi@0 | 43 | |
aoqi@0 | 44 | public class ContentDisposition { |
aoqi@0 | 45 | |
aoqi@0 | 46 | private String disposition; // disposition |
aoqi@0 | 47 | private ParameterList list; // parameter list |
aoqi@0 | 48 | |
aoqi@0 | 49 | /** |
aoqi@0 | 50 | * No-arg Constructor. |
aoqi@0 | 51 | */ |
aoqi@0 | 52 | public ContentDisposition() { } |
aoqi@0 | 53 | |
aoqi@0 | 54 | /** |
aoqi@0 | 55 | * Constructor. |
aoqi@0 | 56 | * |
aoqi@0 | 57 | * @param disposition disposition |
aoqi@0 | 58 | * @param list ParameterList |
aoqi@0 | 59 | * @since JavaMail 1.2 |
aoqi@0 | 60 | */ |
aoqi@0 | 61 | public ContentDisposition(String disposition, ParameterList list) { |
aoqi@0 | 62 | this.disposition = disposition; |
aoqi@0 | 63 | this.list = list; |
aoqi@0 | 64 | } |
aoqi@0 | 65 | |
aoqi@0 | 66 | /** |
aoqi@0 | 67 | * Constructor that takes a ContentDisposition string. The String |
aoqi@0 | 68 | * is parsed into its constituents: dispostion and parameters. |
aoqi@0 | 69 | * A ParseException is thrown if the parse fails. |
aoqi@0 | 70 | * |
aoqi@0 | 71 | * @param s the ContentDisposition string. |
aoqi@0 | 72 | * @exception ParseException if the parse fails. |
aoqi@0 | 73 | * @since JavaMail 1.2 |
aoqi@0 | 74 | */ |
aoqi@0 | 75 | public ContentDisposition(String s) throws ParseException { |
aoqi@0 | 76 | HeaderTokenizer h = new HeaderTokenizer(s, HeaderTokenizer.MIME); |
aoqi@0 | 77 | HeaderTokenizer.Token tk; |
aoqi@0 | 78 | |
aoqi@0 | 79 | // First "disposition" .. |
aoqi@0 | 80 | tk = h.next(); |
aoqi@0 | 81 | if (tk.getType() != HeaderTokenizer.Token.ATOM) |
aoqi@0 | 82 | throw new ParseException(); |
aoqi@0 | 83 | disposition = tk.getValue(); |
aoqi@0 | 84 | |
aoqi@0 | 85 | // Then parameters .. |
aoqi@0 | 86 | String rem = h.getRemainder(); |
aoqi@0 | 87 | if (rem != null) |
aoqi@0 | 88 | list = new ParameterList(rem); |
aoqi@0 | 89 | } |
aoqi@0 | 90 | |
aoqi@0 | 91 | /** |
aoqi@0 | 92 | * Return the disposition value. |
aoqi@0 | 93 | * @return the disposition |
aoqi@0 | 94 | * @since JavaMail 1.2 |
aoqi@0 | 95 | */ |
aoqi@0 | 96 | public String getDisposition() { |
aoqi@0 | 97 | return disposition; |
aoqi@0 | 98 | } |
aoqi@0 | 99 | |
aoqi@0 | 100 | /** |
aoqi@0 | 101 | * Return the specified parameter value. Returns <code>null</code> |
aoqi@0 | 102 | * if this parameter is absent. |
aoqi@0 | 103 | * @return parameter value |
aoqi@0 | 104 | * @since JavaMail 1.2 |
aoqi@0 | 105 | */ |
aoqi@0 | 106 | public String getParameter(String name) { |
aoqi@0 | 107 | if (list == null) |
aoqi@0 | 108 | return null; |
aoqi@0 | 109 | |
aoqi@0 | 110 | return list.get(name); |
aoqi@0 | 111 | } |
aoqi@0 | 112 | |
aoqi@0 | 113 | /** |
aoqi@0 | 114 | * Return a ParameterList object that holds all the available |
aoqi@0 | 115 | * parameters. Returns null if no parameters are available. |
aoqi@0 | 116 | * |
aoqi@0 | 117 | * @return ParameterList |
aoqi@0 | 118 | * @since JavaMail 1.2 |
aoqi@0 | 119 | */ |
aoqi@0 | 120 | public ParameterList getParameterList() { |
aoqi@0 | 121 | return list; |
aoqi@0 | 122 | } |
aoqi@0 | 123 | |
aoqi@0 | 124 | /** |
aoqi@0 | 125 | * Set the primary type. Overrides existing primary type. |
aoqi@0 | 126 | * @param primaryType primary type |
aoqi@0 | 127 | * @since JavaMail 1.2 |
aoqi@0 | 128 | */ |
aoqi@0 | 129 | public void setDisposition(String disposition) { |
aoqi@0 | 130 | this.disposition = disposition; |
aoqi@0 | 131 | } |
aoqi@0 | 132 | |
aoqi@0 | 133 | /** |
aoqi@0 | 134 | * Set the specified parameter. If this parameter already exists, |
aoqi@0 | 135 | * it is replaced by this new value. |
aoqi@0 | 136 | * |
aoqi@0 | 137 | * @param name parameter name |
aoqi@0 | 138 | * @param value parameter value |
aoqi@0 | 139 | * @since JavaMail 1.2 |
aoqi@0 | 140 | */ |
aoqi@0 | 141 | public void setParameter(String name, String value) { |
aoqi@0 | 142 | if (list == null) |
aoqi@0 | 143 | list = new ParameterList(); |
aoqi@0 | 144 | |
aoqi@0 | 145 | list.set(name, value); |
aoqi@0 | 146 | } |
aoqi@0 | 147 | |
aoqi@0 | 148 | /** |
aoqi@0 | 149 | * Set a new ParameterList. |
aoqi@0 | 150 | * @param list ParameterList |
aoqi@0 | 151 | * @since JavaMail 1.2 |
aoqi@0 | 152 | */ |
aoqi@0 | 153 | public void setParameterList(ParameterList list) { |
aoqi@0 | 154 | this.list = list; |
aoqi@0 | 155 | } |
aoqi@0 | 156 | |
aoqi@0 | 157 | /** |
aoqi@0 | 158 | * Retrieve a RFC2045 style string representation of |
aoqi@0 | 159 | * this ContentDisposition. Returns <code>null</code> if |
aoqi@0 | 160 | * the conversion failed. |
aoqi@0 | 161 | * |
aoqi@0 | 162 | * @return RFC2045 style string |
aoqi@0 | 163 | * @since JavaMail 1.2 |
aoqi@0 | 164 | */ |
aoqi@0 | 165 | public String toString() { |
aoqi@0 | 166 | if (disposition == null) |
aoqi@0 | 167 | return null; |
aoqi@0 | 168 | |
aoqi@0 | 169 | if (list == null) |
aoqi@0 | 170 | return disposition; |
aoqi@0 | 171 | |
aoqi@0 | 172 | StringBuffer sb = new StringBuffer(disposition); |
aoqi@0 | 173 | |
aoqi@0 | 174 | // append the parameter list |
aoqi@0 | 175 | // use the length of the string buffer + the length of |
aoqi@0 | 176 | // the header name formatted as follows "Content-Disposition: " |
aoqi@0 | 177 | sb.append(list.toString(sb.length() + 21)); |
aoqi@0 | 178 | return sb.toString(); |
aoqi@0 | 179 | } |
aoqi@0 | 180 | } |