001/* 002 * Copyright (C) 2011 The Guava Authors 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 005 * in compliance with the License. You may obtain a copy of the License at 006 * 007 * http://www.apache.org/licenses/LICENSE-2.0 008 * 009 * Unless required by applicable law or agreed to in writing, software distributed under the License 010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 011 * or implied. See the License for the specific language governing permissions and limitations under 012 * the License. 013 */ 014 015package com.google.common.net; 016 017import static com.google.common.base.CharMatcher.ascii; 018import static com.google.common.base.CharMatcher.javaIsoControl; 019import static com.google.common.base.Charsets.UTF_8; 020import static com.google.common.base.Preconditions.checkArgument; 021import static com.google.common.base.Preconditions.checkNotNull; 022import static com.google.common.base.Preconditions.checkState; 023 024import com.google.common.annotations.GwtCompatible; 025import com.google.common.base.Ascii; 026import com.google.common.base.CharMatcher; 027import com.google.common.base.Joiner; 028import com.google.common.base.Joiner.MapJoiner; 029import com.google.common.base.MoreObjects; 030import com.google.common.base.Objects; 031import com.google.common.base.Optional; 032import com.google.common.collect.ImmutableListMultimap; 033import com.google.common.collect.ImmutableMultiset; 034import com.google.common.collect.ImmutableSet; 035import com.google.common.collect.Maps; 036import com.google.common.collect.Multimap; 037import com.google.common.collect.Multimaps; 038import com.google.errorprone.annotations.CanIgnoreReturnValue; 039import com.google.errorprone.annotations.Immutable; 040import com.google.errorprone.annotations.concurrent.LazyInit; 041import java.nio.charset.Charset; 042import java.nio.charset.IllegalCharsetNameException; 043import java.nio.charset.UnsupportedCharsetException; 044import java.util.Map; 045import java.util.Map.Entry; 046import javax.annotation.CheckForNull; 047 048/** 049 * Represents an <a href="http://en.wikipedia.org/wiki/Internet_media_type">Internet Media Type</a> 050 * (also known as a MIME Type or Content Type). This class also supports the concept of media ranges 051 * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1">defined by HTTP/1.1</a>. 052 * As such, the {@code *} character is treated as a wildcard and is used to represent any acceptable 053 * type or subtype value. A media type may not have wildcard type with a declared subtype. The 054 * {@code *} character has no special meaning as part of a parameter. All values for type, subtype, 055 * parameter attributes or parameter values must be valid according to RFCs <a 056 * href="https://tools.ietf.org/html/rfc2045">2045</a> and <a 057 * href="https://tools.ietf.org/html/rfc2046">2046</a>. 058 * 059 * <p>All portions of the media type that are case-insensitive (type, subtype, parameter attributes) 060 * are normalized to lowercase. The value of the {@code charset} parameter is normalized to 061 * lowercase, but all others are left as-is. 062 * 063 * <p>Note that this specifically does <strong>not</strong> represent the value of the MIME {@code 064 * Content-Type} header and as such has no support for header-specific considerations such as line 065 * folding and comments. 066 * 067 * <p>For media types that take a charset the predefined constants default to UTF-8 and have a 068 * "_UTF_8" suffix. To get a version without a character set, use {@link #withoutParameters}. 069 * 070 * @since 12.0 071 * @author Gregory Kick 072 */ 073@GwtCompatible 074@Immutable 075@ElementTypesAreNonnullByDefault 076public final class MediaType { 077 private static final String CHARSET_ATTRIBUTE = "charset"; 078 private static final ImmutableListMultimap<String, String> UTF_8_CONSTANT_PARAMETERS = 079 ImmutableListMultimap.of(CHARSET_ATTRIBUTE, Ascii.toLowerCase(UTF_8.name())); 080 081 /** Matcher for type, subtype and attributes. */ 082 private static final CharMatcher TOKEN_MATCHER = 083 ascii() 084 .and(javaIsoControl().negate()) 085 .and(CharMatcher.isNot(' ')) 086 .and(CharMatcher.noneOf("()<>@,;:\\\"/[]?=")); 087 088 private static final CharMatcher QUOTED_TEXT_MATCHER = ascii().and(CharMatcher.noneOf("\"\\\r")); 089 090 /* 091 * This matches the same characters as linear-white-space from RFC 822, but we make no effort to 092 * enforce any particular rules with regards to line folding as stated in the class docs. 093 */ 094 private static final CharMatcher LINEAR_WHITE_SPACE = CharMatcher.anyOf(" \t\r\n"); 095 096 // TODO(gak): make these public? 097 private static final String APPLICATION_TYPE = "application"; 098 private static final String AUDIO_TYPE = "audio"; 099 private static final String IMAGE_TYPE = "image"; 100 private static final String TEXT_TYPE = "text"; 101 private static final String VIDEO_TYPE = "video"; 102 private static final String FONT_TYPE = "font"; 103 104 private static final String WILDCARD = "*"; 105 106 private static final Map<MediaType, MediaType> KNOWN_TYPES = Maps.newHashMap(); 107 108 private static MediaType createConstant(String type, String subtype) { 109 MediaType mediaType = 110 addKnownType(new MediaType(type, subtype, ImmutableListMultimap.<String, String>of())); 111 mediaType.parsedCharset = Optional.absent(); 112 return mediaType; 113 } 114 115 private static MediaType createConstantUtf8(String type, String subtype) { 116 MediaType mediaType = addKnownType(new MediaType(type, subtype, UTF_8_CONSTANT_PARAMETERS)); 117 mediaType.parsedCharset = Optional.of(UTF_8); 118 return mediaType; 119 } 120 121 private static MediaType addKnownType(MediaType mediaType) { 122 KNOWN_TYPES.put(mediaType, mediaType); 123 return mediaType; 124 } 125 126 /* 127 * The following constants are grouped by their type and ordered alphabetically by the constant 128 * name within that type. The constant name should be a sensible identifier that is closest to the 129 * "common name" of the media. This is often, but not necessarily the same as the subtype. 130 * 131 * Be sure to declare all constants with the type and subtype in all lowercase. For types that 132 * take a charset (e.g. all text/* types), default to UTF-8 and suffix the constant name with 133 * "_UTF_8". 134 */ 135 136 public static final MediaType ANY_TYPE = createConstant(WILDCARD, WILDCARD); 137 public static final MediaType ANY_TEXT_TYPE = createConstant(TEXT_TYPE, WILDCARD); 138 public static final MediaType ANY_IMAGE_TYPE = createConstant(IMAGE_TYPE, WILDCARD); 139 public static final MediaType ANY_AUDIO_TYPE = createConstant(AUDIO_TYPE, WILDCARD); 140 public static final MediaType ANY_VIDEO_TYPE = createConstant(VIDEO_TYPE, WILDCARD); 141 public static final MediaType ANY_APPLICATION_TYPE = createConstant(APPLICATION_TYPE, WILDCARD); 142 143 /** 144 * Wildcard matching any "font" top-level media type. 145 * 146 * @since 30.0 147 */ 148 public static final MediaType ANY_FONT_TYPE = createConstant(FONT_TYPE, WILDCARD); 149 150 /* text types */ 151 public static final MediaType CACHE_MANIFEST_UTF_8 = 152 createConstantUtf8(TEXT_TYPE, "cache-manifest"); 153 public static final MediaType CSS_UTF_8 = createConstantUtf8(TEXT_TYPE, "css"); 154 public static final MediaType CSV_UTF_8 = createConstantUtf8(TEXT_TYPE, "csv"); 155 public static final MediaType HTML_UTF_8 = createConstantUtf8(TEXT_TYPE, "html"); 156 public static final MediaType I_CALENDAR_UTF_8 = createConstantUtf8(TEXT_TYPE, "calendar"); 157 public static final MediaType PLAIN_TEXT_UTF_8 = createConstantUtf8(TEXT_TYPE, "plain"); 158 159 /** 160 * <a href="http://www.rfc-editor.org/rfc/rfc4329.txt">RFC 4329</a> declares {@link 161 * #JAVASCRIPT_UTF_8 application/javascript} to be the correct media type for JavaScript, but this 162 * may be necessary in certain situations for compatibility. 163 */ 164 public static final MediaType TEXT_JAVASCRIPT_UTF_8 = createConstantUtf8(TEXT_TYPE, "javascript"); 165 /** 166 * <a href="http://www.iana.org/assignments/media-types/text/tab-separated-values">Tab separated 167 * values</a>. 168 * 169 * @since 15.0 170 */ 171 public static final MediaType TSV_UTF_8 = createConstantUtf8(TEXT_TYPE, "tab-separated-values"); 172 173 public static final MediaType VCARD_UTF_8 = createConstantUtf8(TEXT_TYPE, "vcard"); 174 175 /** 176 * UTF-8 encoded <a href="https://en.wikipedia.org/wiki/Wireless_Markup_Language">Wireless Markup 177 * Language</a>. 178 * 179 * @since 13.0 180 */ 181 public static final MediaType WML_UTF_8 = createConstantUtf8(TEXT_TYPE, "vnd.wap.wml"); 182 183 /** 184 * As described in <a href="http://www.ietf.org/rfc/rfc3023.txt">RFC 3023</a>, this constant 185 * ({@code text/xml}) is used for XML documents that are "readable by casual users." {@link 186 * #APPLICATION_XML_UTF_8} is provided for documents that are intended for applications. 187 */ 188 public static final MediaType XML_UTF_8 = createConstantUtf8(TEXT_TYPE, "xml"); 189 190 /** 191 * As described in <a href="https://w3c.github.io/webvtt/#iana-text-vtt">the VTT spec</a>, this is 192 * used for Web Video Text Tracks (WebVTT) files, used with the HTML5 track element. 193 * 194 * @since 20.0 195 */ 196 public static final MediaType VTT_UTF_8 = createConstantUtf8(TEXT_TYPE, "vtt"); 197 198 /* image types */ 199 /** 200 * <a href="https://en.wikipedia.org/wiki/BMP_file_format">Bitmap file format</a> ({@code bmp} 201 * files). 202 * 203 * @since 13.0 204 */ 205 public static final MediaType BMP = createConstant(IMAGE_TYPE, "bmp"); 206 207 /** 208 * The <a href="https://en.wikipedia.org/wiki/Camera_Image_File_Format">Canon Image File 209 * Format</a> ({@code crw} files), a widely-used "raw image" format for cameras. It is found in 210 * {@code /etc/mime.types}, e.g. in <a href= 211 * "http://anonscm.debian.org/gitweb/?p=collab-maint/mime-support.git;a=blob;f=mime.types;hb=HEAD" 212 * >Debian 3.48-1</a>. 213 * 214 * @since 15.0 215 */ 216 public static final MediaType CRW = createConstant(IMAGE_TYPE, "x-canon-crw"); 217 218 public static final MediaType GIF = createConstant(IMAGE_TYPE, "gif"); 219 public static final MediaType ICO = createConstant(IMAGE_TYPE, "vnd.microsoft.icon"); 220 public static final MediaType JPEG = createConstant(IMAGE_TYPE, "jpeg"); 221 public static final MediaType PNG = createConstant(IMAGE_TYPE, "png"); 222 223 /** 224 * The Photoshop File Format ({@code psd} files) as defined by <a 225 * href="http://www.iana.org/assignments/media-types/image/vnd.adobe.photoshop">IANA</a>, and 226 * found in {@code /etc/mime.types}, e.g. <a 227 * href="http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types"></a> of the 228 * Apache <a href="http://httpd.apache.org/">HTTPD project</a>; for the specification, see <a 229 * href="http://www.adobe.com/devnet-apps/photoshop/fileformatashtml/PhotoshopFileFormats.htm"> 230 * Adobe Photoshop Document Format</a> and <a 231 * href="http://en.wikipedia.org/wiki/Adobe_Photoshop#File_format">Wikipedia</a>; this is the 232 * regular output/input of Photoshop (which can also export to various image formats; note that 233 * files with extension "PSB" are in a distinct but related format). 234 * 235 * <p>This is a more recent replacement for the older, experimental type {@code x-photoshop}: <a 236 * href="http://tools.ietf.org/html/rfc2046#section-6">RFC-2046.6</a>. 237 * 238 * @since 15.0 239 */ 240 public static final MediaType PSD = createConstant(IMAGE_TYPE, "vnd.adobe.photoshop"); 241 242 public static final MediaType SVG_UTF_8 = createConstantUtf8(IMAGE_TYPE, "svg+xml"); 243 public static final MediaType TIFF = createConstant(IMAGE_TYPE, "tiff"); 244 245 /** 246 * <a href="https://en.wikipedia.org/wiki/WebP">WebP image format</a>. 247 * 248 * @since 13.0 249 */ 250 public static final MediaType WEBP = createConstant(IMAGE_TYPE, "webp"); 251 252 /** 253 * <a href="https://www.iana.org/assignments/media-types/image/heif">HEIF image format</a>. 254 * 255 * @since 28.1 256 */ 257 public static final MediaType HEIF = createConstant(IMAGE_TYPE, "heif"); 258 259 /** 260 * <a href="https://tools.ietf.org/html/rfc3745">JP2K image format</a>. 261 * 262 * @since 28.1 263 */ 264 public static final MediaType JP2K = createConstant(IMAGE_TYPE, "jp2"); 265 266 /* audio types */ 267 public static final MediaType MP4_AUDIO = createConstant(AUDIO_TYPE, "mp4"); 268 public static final MediaType MPEG_AUDIO = createConstant(AUDIO_TYPE, "mpeg"); 269 public static final MediaType OGG_AUDIO = createConstant(AUDIO_TYPE, "ogg"); 270 public static final MediaType WEBM_AUDIO = createConstant(AUDIO_TYPE, "webm"); 271 272 /** 273 * L16 audio, as defined by <a href="https://tools.ietf.org/html/rfc2586">RFC 2586</a>. 274 * 275 * @since 24.1 276 */ 277 public static final MediaType L16_AUDIO = createConstant(AUDIO_TYPE, "l16"); 278 279 /** 280 * L24 audio, as defined by <a href="https://tools.ietf.org/html/rfc3190">RFC 3190</a>. 281 * 282 * @since 20.0 283 */ 284 public static final MediaType L24_AUDIO = createConstant(AUDIO_TYPE, "l24"); 285 286 /** 287 * Basic Audio, as defined by <a href="http://tools.ietf.org/html/rfc2046#section-4.3">RFC 288 * 2046</a>. 289 * 290 * @since 20.0 291 */ 292 public static final MediaType BASIC_AUDIO = createConstant(AUDIO_TYPE, "basic"); 293 294 /** 295 * Advanced Audio Coding. For more information, see <a 296 * href="https://en.wikipedia.org/wiki/Advanced_Audio_Coding">Advanced Audio Coding</a>. 297 * 298 * @since 20.0 299 */ 300 public static final MediaType AAC_AUDIO = createConstant(AUDIO_TYPE, "aac"); 301 302 /** 303 * Vorbis Audio, as defined by <a href="http://tools.ietf.org/html/rfc5215">RFC 5215</a>. 304 * 305 * @since 20.0 306 */ 307 public static final MediaType VORBIS_AUDIO = createConstant(AUDIO_TYPE, "vorbis"); 308 309 /** 310 * Windows Media Audio. For more information, see <a 311 * href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd562994(v=vs.85).aspx">file 312 * name extensions for Windows Media metafiles</a>. 313 * 314 * @since 20.0 315 */ 316 public static final MediaType WMA_AUDIO = createConstant(AUDIO_TYPE, "x-ms-wma"); 317 318 /** 319 * Windows Media metafiles. For more information, see <a 320 * href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd562994(v=vs.85).aspx">file 321 * name extensions for Windows Media metafiles</a>. 322 * 323 * @since 20.0 324 */ 325 public static final MediaType WAX_AUDIO = createConstant(AUDIO_TYPE, "x-ms-wax"); 326 327 /** 328 * Real Audio. For more information, see <a 329 * href="http://service.real.com/help/faq/rp8/configrp8win.html">this link</a>. 330 * 331 * @since 20.0 332 */ 333 public static final MediaType VND_REAL_AUDIO = createConstant(AUDIO_TYPE, "vnd.rn-realaudio"); 334 335 /** 336 * WAVE format, as defined by <a href="https://tools.ietf.org/html/rfc2361">RFC 2361</a>. 337 * 338 * @since 20.0 339 */ 340 public static final MediaType VND_WAVE_AUDIO = createConstant(AUDIO_TYPE, "vnd.wave"); 341 342 /* video types */ 343 public static final MediaType MP4_VIDEO = createConstant(VIDEO_TYPE, "mp4"); 344 public static final MediaType MPEG_VIDEO = createConstant(VIDEO_TYPE, "mpeg"); 345 public static final MediaType OGG_VIDEO = createConstant(VIDEO_TYPE, "ogg"); 346 public static final MediaType QUICKTIME = createConstant(VIDEO_TYPE, "quicktime"); 347 public static final MediaType WEBM_VIDEO = createConstant(VIDEO_TYPE, "webm"); 348 public static final MediaType WMV = createConstant(VIDEO_TYPE, "x-ms-wmv"); 349 350 /** 351 * Flash video. For more information, see <a href= 352 * "http://help.adobe.com/en_US/ActionScript/3.0_ProgrammingAS3/WS5b3ccc516d4fbf351e63e3d118a9b90204-7d48.html" 353 * >this link</a>. 354 * 355 * @since 20.0 356 */ 357 public static final MediaType FLV_VIDEO = createConstant(VIDEO_TYPE, "x-flv"); 358 359 /** 360 * The 3GP multimedia container format. For more information, see <a 361 * href="ftp://www.3gpp.org/tsg_sa/TSG_SA/TSGS_23/Docs/PDF/SP-040065.pdf#page=10">3GPP TS 362 * 26.244</a>. 363 * 364 * @since 20.0 365 */ 366 public static final MediaType THREE_GPP_VIDEO = createConstant(VIDEO_TYPE, "3gpp"); 367 368 /** 369 * The 3G2 multimedia container format. For more information, see <a 370 * href="http://www.3gpp2.org/Public_html/specs/C.S0050-B_v1.0_070521.pdf#page=16">3GPP2 371 * C.S0050-B</a>. 372 * 373 * @since 20.0 374 */ 375 public static final MediaType THREE_GPP2_VIDEO = createConstant(VIDEO_TYPE, "3gpp2"); 376 377 /* application types */ 378 /** 379 * As described in <a href="http://www.ietf.org/rfc/rfc3023.txt">RFC 3023</a>, this constant 380 * ({@code application/xml}) is used for XML documents that are "unreadable by casual users." 381 * {@link #XML_UTF_8} is provided for documents that may be read by users. 382 * 383 * @since 14.0 384 */ 385 public static final MediaType APPLICATION_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xml"); 386 387 public static final MediaType ATOM_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "atom+xml"); 388 public static final MediaType BZIP2 = createConstant(APPLICATION_TYPE, "x-bzip2"); 389 390 /** 391 * Files in the <a href="https://www.dartlang.org/articles/embedding-in-html/">dart</a> 392 * programming language. 393 * 394 * @since 19.0 395 */ 396 public static final MediaType DART_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "dart"); 397 398 /** 399 * <a href="https://goo.gl/2QoMvg">Apple Passbook</a>. 400 * 401 * @since 19.0 402 */ 403 public static final MediaType APPLE_PASSBOOK = 404 createConstant(APPLICATION_TYPE, "vnd.apple.pkpass"); 405 406 /** 407 * <a href="http://en.wikipedia.org/wiki/Embedded_OpenType">Embedded OpenType</a> fonts. This is 408 * <a href="http://www.iana.org/assignments/media-types/application/vnd.ms-fontobject">registered 409 * </a> with the IANA. 410 * 411 * @since 17.0 412 */ 413 public static final MediaType EOT = createConstant(APPLICATION_TYPE, "vnd.ms-fontobject"); 414 415 /** 416 * As described in the <a href="http://idpf.org/epub">International Digital Publishing Forum</a> 417 * EPUB is the distribution and interchange format standard for digital publications and 418 * documents. This media type is defined in the <a 419 * href="http://www.idpf.org/epub/30/spec/epub30-ocf.html">EPUB Open Container Format</a> 420 * specification. 421 * 422 * @since 15.0 423 */ 424 public static final MediaType EPUB = createConstant(APPLICATION_TYPE, "epub+zip"); 425 426 public static final MediaType FORM_DATA = 427 createConstant(APPLICATION_TYPE, "x-www-form-urlencoded"); 428 429 /** 430 * As described in <a href="https://www.rsa.com/rsalabs/node.asp?id=2138">PKCS #12: Personal 431 * Information Exchange Syntax Standard</a>, PKCS #12 defines an archive file format for storing 432 * many cryptography objects as a single file. 433 * 434 * @since 15.0 435 */ 436 public static final MediaType KEY_ARCHIVE = createConstant(APPLICATION_TYPE, "pkcs12"); 437 438 /** 439 * This is a non-standard media type, but is commonly used in serving hosted binary files as it is 440 * <a href="http://code.google.com/p/browsersec/wiki/Part2#Survey_of_content_sniffing_behaviors"> 441 * known not to trigger content sniffing in current browsers</a>. It <i>should not</i> be used in 442 * other situations as it is not specified by any RFC and does not appear in the <a 443 * href="http://www.iana.org/assignments/media-types">/IANA MIME Media Types</a> list. Consider 444 * {@link #OCTET_STREAM} for binary data that is not being served to a browser. 445 * 446 * @since 14.0 447 */ 448 public static final MediaType APPLICATION_BINARY = createConstant(APPLICATION_TYPE, "binary"); 449 450 /** 451 * Media type for the <a href="https://tools.ietf.org/html/rfc7946">GeoJSON Format</a>, a 452 * geospatial data interchange format based on JSON. 453 * 454 * @since 28.0 455 */ 456 public static final MediaType GEO_JSON = createConstant(APPLICATION_TYPE, "geo+json"); 457 458 public static final MediaType GZIP = createConstant(APPLICATION_TYPE, "x-gzip"); 459 460 /** 461 * <a href="https://tools.ietf.org/html/draft-kelly-json-hal-08#section-3">JSON Hypertext 462 * Application Language (HAL) documents</a>. 463 * 464 * @since 26.0 465 */ 466 public static final MediaType HAL_JSON = createConstant(APPLICATION_TYPE, "hal+json"); 467 468 /** 469 * <a href="http://www.rfc-editor.org/rfc/rfc4329.txt">RFC 4329</a> declares this to be the 470 * correct media type for JavaScript, but {@link #TEXT_JAVASCRIPT_UTF_8 text/javascript} may be 471 * necessary in certain situations for compatibility. 472 */ 473 public static final MediaType JAVASCRIPT_UTF_8 = 474 createConstantUtf8(APPLICATION_TYPE, "javascript"); 475 476 /** 477 * For <a href="https://tools.ietf.org/html/rfc7515">JWS or JWE objects using the Compact 478 * Serialization</a>. 479 * 480 * @since 27.1 481 */ 482 public static final MediaType JOSE = createConstant(APPLICATION_TYPE, "jose"); 483 484 /** 485 * For <a href="https://tools.ietf.org/html/rfc7515">JWS or JWE objects using the JSON 486 * Serialization</a>. 487 * 488 * @since 27.1 489 */ 490 public static final MediaType JOSE_JSON = createConstant(APPLICATION_TYPE, "jose+json"); 491 492 public static final MediaType JSON_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "json"); 493 494 /** 495 * The <a href="http://www.w3.org/TR/appmanifest/">Manifest for a web application</a>. 496 * 497 * @since 19.0 498 */ 499 public static final MediaType MANIFEST_JSON_UTF_8 = 500 createConstantUtf8(APPLICATION_TYPE, "manifest+json"); 501 502 /** 503 * <a href="http://www.opengeospatial.org/standards/kml/">OGC KML (Keyhole Markup Language)</a>. 504 */ 505 public static final MediaType KML = createConstant(APPLICATION_TYPE, "vnd.google-earth.kml+xml"); 506 507 /** 508 * <a href="http://www.opengeospatial.org/standards/kml/">OGC KML (Keyhole Markup Language)</a>, 509 * compressed using the ZIP format into KMZ archives. 510 */ 511 public static final MediaType KMZ = createConstant(APPLICATION_TYPE, "vnd.google-earth.kmz"); 512 513 /** 514 * The <a href="https://tools.ietf.org/html/rfc4155">mbox database format</a>. 515 * 516 * @since 13.0 517 */ 518 public static final MediaType MBOX = createConstant(APPLICATION_TYPE, "mbox"); 519 520 /** 521 * <a href="http://goo.gl/1pGBFm">Apple over-the-air mobile configuration profiles</a>. 522 * 523 * @since 18.0 524 */ 525 public static final MediaType APPLE_MOBILE_CONFIG = 526 createConstant(APPLICATION_TYPE, "x-apple-aspen-config"); 527 528 /** <a href="http://goo.gl/XDQ1h2">Microsoft Excel</a> spreadsheets. */ 529 public static final MediaType MICROSOFT_EXCEL = createConstant(APPLICATION_TYPE, "vnd.ms-excel"); 530 531 /** 532 * <a href="http://goo.gl/XrTEqG">Microsoft Outlook</a> items. 533 * 534 * @since 27.1 535 */ 536 public static final MediaType MICROSOFT_OUTLOOK = 537 createConstant(APPLICATION_TYPE, "vnd.ms-outlook"); 538 539 /** <a href="http://goo.gl/XDQ1h2">Microsoft Powerpoint</a> presentations. */ 540 public static final MediaType MICROSOFT_POWERPOINT = 541 createConstant(APPLICATION_TYPE, "vnd.ms-powerpoint"); 542 543 /** <a href="http://goo.gl/XDQ1h2">Microsoft Word</a> documents. */ 544 public static final MediaType MICROSOFT_WORD = createConstant(APPLICATION_TYPE, "msword"); 545 546 /** 547 * Media type for <a 548 * href="https://en.wikipedia.org/wiki/Dynamic_Adaptive_Streaming_over_HTTP">Dynamic Adaptive 549 * Streaming over HTTP (DASH)</a>. This is <a 550 * href="https://www.iana.org/assignments/media-types/application/dash+xml">registered</a> with 551 * the IANA. 552 * 553 * @since 28.2 554 */ 555 public static final MediaType MEDIA_PRESENTATION_DESCRIPTION = 556 createConstant(APPLICATION_TYPE, "dash+xml"); 557 558 /** 559 * WASM applications. For more information see <a href="https://webassembly.org/">the Web Assembly 560 * overview</a>. 561 * 562 * @since 27.0 563 */ 564 public static final MediaType WASM_APPLICATION = createConstant(APPLICATION_TYPE, "wasm"); 565 566 /** 567 * NaCl applications. For more information see <a 568 * href="https://developer.chrome.com/native-client/devguide/coding/application-structure">the 569 * Developer Guide for Native Client Application Structure</a>. 570 * 571 * @since 20.0 572 */ 573 public static final MediaType NACL_APPLICATION = createConstant(APPLICATION_TYPE, "x-nacl"); 574 575 /** 576 * NaCl portable applications. For more information see <a 577 * href="https://developer.chrome.com/native-client/devguide/coding/application-structure">the 578 * Developer Guide for Native Client Application Structure</a>. 579 * 580 * @since 20.0 581 */ 582 public static final MediaType NACL_PORTABLE_APPLICATION = 583 createConstant(APPLICATION_TYPE, "x-pnacl"); 584 585 public static final MediaType OCTET_STREAM = createConstant(APPLICATION_TYPE, "octet-stream"); 586 587 public static final MediaType OGG_CONTAINER = createConstant(APPLICATION_TYPE, "ogg"); 588 public static final MediaType OOXML_DOCUMENT = 589 createConstant( 590 APPLICATION_TYPE, "vnd.openxmlformats-officedocument.wordprocessingml.document"); 591 public static final MediaType OOXML_PRESENTATION = 592 createConstant( 593 APPLICATION_TYPE, "vnd.openxmlformats-officedocument.presentationml.presentation"); 594 public static final MediaType OOXML_SHEET = 595 createConstant(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.spreadsheetml.sheet"); 596 public static final MediaType OPENDOCUMENT_GRAPHICS = 597 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.graphics"); 598 public static final MediaType OPENDOCUMENT_PRESENTATION = 599 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.presentation"); 600 public static final MediaType OPENDOCUMENT_SPREADSHEET = 601 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.spreadsheet"); 602 public static final MediaType OPENDOCUMENT_TEXT = 603 createConstant(APPLICATION_TYPE, "vnd.oasis.opendocument.text"); 604 605 /** 606 * <a href="https://tools.ietf.org/id/draft-ellermann-opensearch-01.html">OpenSearch</a> 607 * Description files are XML files that describe how a website can be used as a search engine by 608 * consumers (e.g. web browsers). 609 * 610 * @since 28.2 611 */ 612 public static final MediaType OPENSEARCH_DESCRIPTION_UTF_8 = 613 createConstantUtf8(APPLICATION_TYPE, "opensearchdescription+xml"); 614 615 public static final MediaType PDF = createConstant(APPLICATION_TYPE, "pdf"); 616 public static final MediaType POSTSCRIPT = createConstant(APPLICATION_TYPE, "postscript"); 617 618 /** 619 * <a href="http://tools.ietf.org/html/draft-rfernando-protocol-buffers-00">Protocol buffers</a> 620 * 621 * @since 15.0 622 */ 623 public static final MediaType PROTOBUF = createConstant(APPLICATION_TYPE, "protobuf"); 624 625 /** 626 * <a href="https://en.wikipedia.org/wiki/RDF/XML">RDF/XML</a> documents, which are XML 627 * serializations of <a 628 * href="https://en.wikipedia.org/wiki/Resource_Description_Framework">Resource Description 629 * Framework</a> graphs. 630 * 631 * @since 14.0 632 */ 633 public static final MediaType RDF_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "rdf+xml"); 634 635 public static final MediaType RTF_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "rtf"); 636 637 /** 638 * <a href="https://tools.ietf.org/html/rfc8081">RFC 8081</a> declares {@link #FONT_SFNT 639 * font/sfnt} to be the correct media type for SFNT, but this may be necessary in certain 640 * situations for compatibility. 641 * 642 * @since 17.0 643 */ 644 public static final MediaType SFNT = createConstant(APPLICATION_TYPE, "font-sfnt"); 645 646 public static final MediaType SHOCKWAVE_FLASH = 647 createConstant(APPLICATION_TYPE, "x-shockwave-flash"); 648 649 /** 650 * {@code skp} files produced by the 3D Modeling software <a 651 * href="https://www.sketchup.com/">SketchUp</a> 652 * 653 * @since 13.0 654 */ 655 public static final MediaType SKETCHUP = createConstant(APPLICATION_TYPE, "vnd.sketchup.skp"); 656 657 /** 658 * As described in <a href="http://www.ietf.org/rfc/rfc3902.txt">RFC 3902</a>, this constant 659 * ({@code application/soap+xml}) is used to identify SOAP 1.2 message envelopes that have been 660 * serialized with XML 1.0. 661 * 662 * <p>For SOAP 1.1 messages, see {@code XML_UTF_8} per <a 663 * href="http://www.w3.org/TR/2000/NOTE-SOAP-20000508/">W3C Note on Simple Object Access Protocol 664 * (SOAP) 1.1</a> 665 * 666 * @since 20.0 667 */ 668 public static final MediaType SOAP_XML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "soap+xml"); 669 670 public static final MediaType TAR = createConstant(APPLICATION_TYPE, "x-tar"); 671 672 /** 673 * <a href="https://tools.ietf.org/html/rfc8081">RFC 8081</a> declares {@link #FONT_WOFF 674 * font/woff} to be the correct media type for WOFF, but this may be necessary in certain 675 * situations for compatibility. 676 * 677 * @since 17.0 678 */ 679 public static final MediaType WOFF = createConstant(APPLICATION_TYPE, "font-woff"); 680 681 /** 682 * <a href="https://tools.ietf.org/html/rfc8081">RFC 8081</a> declares {@link #FONT_WOFF2 683 * font/woff2} to be the correct media type for WOFF2, but this may be necessary in certain 684 * situations for compatibility. 685 * 686 * @since 20.0 687 */ 688 public static final MediaType WOFF2 = createConstant(APPLICATION_TYPE, "font-woff2"); 689 690 public static final MediaType XHTML_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xhtml+xml"); 691 692 /** 693 * Extensible Resource Descriptors. This is not yet registered with the IANA, but it is specified 694 * by OASIS in the <a href="http://docs.oasis-open.org/xri/xrd/v1.0/cd02/xrd-1.0-cd02.html">XRD 695 * definition</a> and implemented in projects such as <a 696 * href="http://code.google.com/p/webfinger/">WebFinger</a>. 697 * 698 * @since 14.0 699 */ 700 public static final MediaType XRD_UTF_8 = createConstantUtf8(APPLICATION_TYPE, "xrd+xml"); 701 702 public static final MediaType ZIP = createConstant(APPLICATION_TYPE, "zip"); 703 704 /* font types */ 705 706 /** 707 * A collection of font outlines as defined by <a href="https://tools.ietf.org/html/rfc8081">RFC 708 * 8081</a>. 709 * 710 * @since 30.0 711 */ 712 public static final MediaType FONT_COLLECTION = createConstant(FONT_TYPE, "collection"); 713 714 /** 715 * <a href="https://en.wikipedia.org/wiki/OpenType">Open Type Font Format</a> (OTF) as defined by 716 * <a href="https://tools.ietf.org/html/rfc8081">RFC 8081</a>. 717 * 718 * @since 30.0 719 */ 720 public static final MediaType FONT_OTF = createConstant(FONT_TYPE, "otf"); 721 722 /** 723 * <a href="https://en.wikipedia.org/wiki/SFNT">Spline or Scalable Font Format</a> (SFNT). <a 724 * href="https://tools.ietf.org/html/rfc8081">RFC 8081</a> declares this to be the correct media 725 * type for SFNT, but {@link #SFNT application/font-sfnt} may be necessary in certain situations 726 * for compatibility. 727 * 728 * @since 30.0 729 */ 730 public static final MediaType FONT_SFNT = createConstant(FONT_TYPE, "sfnt"); 731 732 /** 733 * <a href="https://en.wikipedia.org/wiki/TrueType">True Type Font Format</a> (TTF) as defined by 734 * <a href="https://tools.ietf.org/html/rfc8081">RFC 8081</a>. 735 * 736 * @since 30.0 737 */ 738 public static final MediaType FONT_TTF = createConstant(FONT_TYPE, "ttf"); 739 740 /** 741 * <a href="http://en.wikipedia.org/wiki/Web_Open_Font_Format">Web Open Font Format</a> (WOFF). <a 742 * href="https://tools.ietf.org/html/rfc8081">RFC 8081</a> declares this to be the correct media 743 * type for SFNT, but {@link #WOFF application/font-woff} may be necessary in certain situations 744 * for compatibility. 745 * 746 * @since 30.0 747 */ 748 public static final MediaType FONT_WOFF = createConstant(FONT_TYPE, "woff"); 749 750 /** 751 * <a href="http://en.wikipedia.org/wiki/Web_Open_Font_Format">Web Open Font Format</a> (WOFF2). 752 * <a href="https://tools.ietf.org/html/rfc8081">RFC 8081</a> declares this to be the correct 753 * media type for SFNT, but {@link #WOFF2 application/font-woff2} may be necessary in certain 754 * situations for compatibility. 755 * 756 * @since 30.0 757 */ 758 public static final MediaType FONT_WOFF2 = createConstant(FONT_TYPE, "woff2"); 759 760 private final String type; 761 private final String subtype; 762 private final ImmutableListMultimap<String, String> parameters; 763 764 @LazyInit @CheckForNull private String toString; 765 766 @LazyInit private int hashCode; 767 768 @LazyInit @CheckForNull private Optional<Charset> parsedCharset; 769 770 private MediaType(String type, String subtype, ImmutableListMultimap<String, String> parameters) { 771 this.type = type; 772 this.subtype = subtype; 773 this.parameters = parameters; 774 } 775 776 /** Returns the top-level media type. For example, {@code "text"} in {@code "text/plain"}. */ 777 public String type() { 778 return type; 779 } 780 781 /** Returns the media subtype. For example, {@code "plain"} in {@code "text/plain"}. */ 782 public String subtype() { 783 return subtype; 784 } 785 786 /** Returns a multimap containing the parameters of this media type. */ 787 public ImmutableListMultimap<String, String> parameters() { 788 return parameters; 789 } 790 791 private Map<String, ImmutableMultiset<String>> parametersAsMap() { 792 return Maps.transformValues(parameters.asMap(), ImmutableMultiset::copyOf); 793 } 794 795 /** 796 * Returns an optional charset for the value of the charset parameter if it is specified. 797 * 798 * @throws IllegalStateException if multiple charset values have been set for this media type 799 * @throws IllegalCharsetNameException if a charset value is present, but illegal 800 * @throws UnsupportedCharsetException if a charset value is present, but no support is available 801 * in this instance of the Java virtual machine 802 */ 803 public Optional<Charset> charset() { 804 // racy single-check idiom, this is safe because Optional is immutable. 805 Optional<Charset> local = parsedCharset; 806 if (local == null) { 807 String value = null; 808 local = Optional.absent(); 809 for (String currentValue : parameters.get(CHARSET_ATTRIBUTE)) { 810 if (value == null) { 811 value = currentValue; 812 local = Optional.of(Charset.forName(value)); 813 } else if (!value.equals(currentValue)) { 814 throw new IllegalStateException( 815 "Multiple charset values defined: " + value + ", " + currentValue); 816 } 817 } 818 parsedCharset = local; 819 } 820 return local; 821 } 822 823 /** 824 * Returns a new instance with the same type and subtype as this instance, but without any 825 * parameters. 826 */ 827 public MediaType withoutParameters() { 828 return parameters.isEmpty() ? this : create(type, subtype); 829 } 830 831 /** 832 * <em>Replaces</em> all parameters with the given parameters. 833 * 834 * @throws IllegalArgumentException if any parameter or value is invalid 835 */ 836 public MediaType withParameters(Multimap<String, String> parameters) { 837 return create(type, subtype, parameters); 838 } 839 840 /** 841 * <em>Replaces</em> all parameters with the given attribute with parameters using the given 842 * values. If there are no values, any existing parameters with the given attribute are removed. 843 * 844 * @throws IllegalArgumentException if either {@code attribute} or {@code values} is invalid 845 * @since 24.0 846 */ 847 public MediaType withParameters(String attribute, Iterable<String> values) { 848 checkNotNull(attribute); 849 checkNotNull(values); 850 String normalizedAttribute = normalizeToken(attribute); 851 ImmutableListMultimap.Builder<String, String> builder = ImmutableListMultimap.builder(); 852 for (Entry<String, String> entry : parameters.entries()) { 853 String key = entry.getKey(); 854 if (!normalizedAttribute.equals(key)) { 855 builder.put(key, entry.getValue()); 856 } 857 } 858 for (String value : values) { 859 builder.put(normalizedAttribute, normalizeParameterValue(normalizedAttribute, value)); 860 } 861 MediaType mediaType = new MediaType(type, subtype, builder.build()); 862 // if the attribute isn't charset, we can just inherit the current parsedCharset 863 if (!normalizedAttribute.equals(CHARSET_ATTRIBUTE)) { 864 mediaType.parsedCharset = this.parsedCharset; 865 } 866 // Return one of the constants if the media type is a known type. 867 return MoreObjects.firstNonNull(KNOWN_TYPES.get(mediaType), mediaType); 868 } 869 870 /** 871 * <em>Replaces</em> all parameters with the given attribute with a single parameter with the 872 * given value. If multiple parameters with the same attributes are necessary use {@link 873 * #withParameters(String, Iterable)}. Prefer {@link #withCharset} for setting the {@code charset} 874 * parameter when using a {@link Charset} object. 875 * 876 * @throws IllegalArgumentException if either {@code attribute} or {@code value} is invalid 877 */ 878 public MediaType withParameter(String attribute, String value) { 879 return withParameters(attribute, ImmutableSet.of(value)); 880 } 881 882 /** 883 * Returns a new instance with the same type and subtype as this instance, with the {@code 884 * charset} parameter set to the {@link Charset#name name} of the given charset. Only one {@code 885 * charset} parameter will be present on the new instance regardless of the number set on this 886 * one. 887 * 888 * <p>If a charset must be specified that is not supported on this JVM (and thus is not 889 * representable as a {@link Charset} instance, use {@link #withParameter}. 890 */ 891 public MediaType withCharset(Charset charset) { 892 checkNotNull(charset); 893 MediaType withCharset = withParameter(CHARSET_ATTRIBUTE, charset.name()); 894 // precache the charset so we don't need to parse it 895 withCharset.parsedCharset = Optional.of(charset); 896 return withCharset; 897 } 898 899 /** Returns true if either the type or subtype is the wildcard. */ 900 public boolean hasWildcard() { 901 return WILDCARD.equals(type) || WILDCARD.equals(subtype); 902 } 903 904 /** 905 * Returns {@code true} if this instance falls within the range (as defined by <a 906 * href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">the HTTP Accept header</a>) given 907 * by the argument according to three criteria: 908 * 909 * <ol> 910 * <li>The type of the argument is the wildcard or equal to the type of this instance. 911 * <li>The subtype of the argument is the wildcard or equal to the subtype of this instance. 912 * <li>All of the parameters present in the argument are present in this instance. 913 * </ol> 914 * 915 * <p>For example: 916 * 917 * <pre>{@code 918 * PLAIN_TEXT_UTF_8.is(PLAIN_TEXT_UTF_8) // true 919 * PLAIN_TEXT_UTF_8.is(HTML_UTF_8) // false 920 * PLAIN_TEXT_UTF_8.is(ANY_TYPE) // true 921 * PLAIN_TEXT_UTF_8.is(ANY_TEXT_TYPE) // true 922 * PLAIN_TEXT_UTF_8.is(ANY_IMAGE_TYPE) // false 923 * PLAIN_TEXT_UTF_8.is(ANY_TEXT_TYPE.withCharset(UTF_8)) // true 924 * PLAIN_TEXT_UTF_8.withoutParameters().is(ANY_TEXT_TYPE.withCharset(UTF_8)) // false 925 * PLAIN_TEXT_UTF_8.is(ANY_TEXT_TYPE.withCharset(UTF_16)) // false 926 * }</pre> 927 * 928 * <p>Note that while it is possible to have the same parameter declared multiple times within a 929 * media type this method does not consider the number of occurrences of a parameter. For example, 930 * {@code "text/plain; charset=UTF-8"} satisfies {@code "text/plain; charset=UTF-8; 931 * charset=UTF-8"}. 932 */ 933 public boolean is(MediaType mediaTypeRange) { 934 return (mediaTypeRange.type.equals(WILDCARD) || mediaTypeRange.type.equals(this.type)) 935 && (mediaTypeRange.subtype.equals(WILDCARD) || mediaTypeRange.subtype.equals(this.subtype)) 936 && this.parameters.entries().containsAll(mediaTypeRange.parameters.entries()); 937 } 938 939 /** 940 * Creates a new media type with the given type and subtype. 941 * 942 * @throws IllegalArgumentException if type or subtype is invalid or if a wildcard is used for the 943 * type, but not the subtype. 944 */ 945 public static MediaType create(String type, String subtype) { 946 MediaType mediaType = create(type, subtype, ImmutableListMultimap.<String, String>of()); 947 mediaType.parsedCharset = Optional.absent(); 948 return mediaType; 949 } 950 951 private static MediaType create( 952 String type, String subtype, Multimap<String, String> parameters) { 953 checkNotNull(type); 954 checkNotNull(subtype); 955 checkNotNull(parameters); 956 String normalizedType = normalizeToken(type); 957 String normalizedSubtype = normalizeToken(subtype); 958 checkArgument( 959 !WILDCARD.equals(normalizedType) || WILDCARD.equals(normalizedSubtype), 960 "A wildcard type cannot be used with a non-wildcard subtype"); 961 ImmutableListMultimap.Builder<String, String> builder = ImmutableListMultimap.builder(); 962 for (Entry<String, String> entry : parameters.entries()) { 963 String attribute = normalizeToken(entry.getKey()); 964 builder.put(attribute, normalizeParameterValue(attribute, entry.getValue())); 965 } 966 MediaType mediaType = new MediaType(normalizedType, normalizedSubtype, builder.build()); 967 // Return one of the constants if the media type is a known type. 968 return MoreObjects.firstNonNull(KNOWN_TYPES.get(mediaType), mediaType); 969 } 970 971 /** 972 * Creates a media type with the "application" type and the given subtype. 973 * 974 * @throws IllegalArgumentException if subtype is invalid 975 */ 976 static MediaType createApplicationType(String subtype) { 977 return create(APPLICATION_TYPE, subtype); 978 } 979 980 /** 981 * Creates a media type with the "audio" type and the given subtype. 982 * 983 * @throws IllegalArgumentException if subtype is invalid 984 */ 985 static MediaType createAudioType(String subtype) { 986 return create(AUDIO_TYPE, subtype); 987 } 988 989 /** 990 * Creates a media type with the "font" type and the given subtype. 991 * 992 * @throws IllegalArgumentException if subtype is invalid 993 */ 994 static MediaType createFontType(String subtype) { 995 return create(FONT_TYPE, subtype); 996 } 997 998 /** 999 * Creates a media type with the "image" type and the given subtype. 1000 * 1001 * @throws IllegalArgumentException if subtype is invalid 1002 */ 1003 static MediaType createImageType(String subtype) { 1004 return create(IMAGE_TYPE, subtype); 1005 } 1006 1007 /** 1008 * Creates a media type with the "text" type and the given subtype. 1009 * 1010 * @throws IllegalArgumentException if subtype is invalid 1011 */ 1012 static MediaType createTextType(String subtype) { 1013 return create(TEXT_TYPE, subtype); 1014 } 1015 1016 /** 1017 * Creates a media type with the "video" type and the given subtype. 1018 * 1019 * @throws IllegalArgumentException if subtype is invalid 1020 */ 1021 static MediaType createVideoType(String subtype) { 1022 return create(VIDEO_TYPE, subtype); 1023 } 1024 1025 private static String normalizeToken(String token) { 1026 checkArgument(TOKEN_MATCHER.matchesAllOf(token)); 1027 checkArgument(!token.isEmpty()); 1028 return Ascii.toLowerCase(token); 1029 } 1030 1031 private static String normalizeParameterValue(String attribute, String value) { 1032 checkNotNull(value); // for GWT 1033 checkArgument(ascii().matchesAllOf(value), "parameter values must be ASCII: %s", value); 1034 return CHARSET_ATTRIBUTE.equals(attribute) ? Ascii.toLowerCase(value) : value; 1035 } 1036 1037 /** 1038 * Parses a media type from its string representation. 1039 * 1040 * @throws IllegalArgumentException if the input is not parsable 1041 */ 1042 @CanIgnoreReturnValue // TODO(b/219820829): consider removing 1043 public static MediaType parse(String input) { 1044 checkNotNull(input); 1045 Tokenizer tokenizer = new Tokenizer(input); 1046 try { 1047 String type = tokenizer.consumeToken(TOKEN_MATCHER); 1048 tokenizer.consumeCharacter('/'); 1049 String subtype = tokenizer.consumeToken(TOKEN_MATCHER); 1050 ImmutableListMultimap.Builder<String, String> parameters = ImmutableListMultimap.builder(); 1051 while (tokenizer.hasMore()) { 1052 tokenizer.consumeTokenIfPresent(LINEAR_WHITE_SPACE); 1053 tokenizer.consumeCharacter(';'); 1054 tokenizer.consumeTokenIfPresent(LINEAR_WHITE_SPACE); 1055 String attribute = tokenizer.consumeToken(TOKEN_MATCHER); 1056 tokenizer.consumeCharacter('='); 1057 String value; 1058 if ('"' == tokenizer.previewChar()) { 1059 tokenizer.consumeCharacter('"'); 1060 StringBuilder valueBuilder = new StringBuilder(); 1061 while ('"' != tokenizer.previewChar()) { 1062 if ('\\' == tokenizer.previewChar()) { 1063 tokenizer.consumeCharacter('\\'); 1064 valueBuilder.append(tokenizer.consumeCharacter(ascii())); 1065 } else { 1066 valueBuilder.append(tokenizer.consumeToken(QUOTED_TEXT_MATCHER)); 1067 } 1068 } 1069 value = valueBuilder.toString(); 1070 tokenizer.consumeCharacter('"'); 1071 } else { 1072 value = tokenizer.consumeToken(TOKEN_MATCHER); 1073 } 1074 parameters.put(attribute, value); 1075 } 1076 return create(type, subtype, parameters.build()); 1077 } catch (IllegalStateException e) { 1078 throw new IllegalArgumentException("Could not parse '" + input + "'", e); 1079 } 1080 } 1081 1082 private static final class Tokenizer { 1083 final String input; 1084 int position = 0; 1085 1086 Tokenizer(String input) { 1087 this.input = input; 1088 } 1089 1090 @CanIgnoreReturnValue 1091 String consumeTokenIfPresent(CharMatcher matcher) { 1092 checkState(hasMore()); 1093 int startPosition = position; 1094 position = matcher.negate().indexIn(input, startPosition); 1095 return hasMore() ? input.substring(startPosition, position) : input.substring(startPosition); 1096 } 1097 1098 String consumeToken(CharMatcher matcher) { 1099 int startPosition = position; 1100 String token = consumeTokenIfPresent(matcher); 1101 checkState(position != startPosition); 1102 return token; 1103 } 1104 1105 char consumeCharacter(CharMatcher matcher) { 1106 checkState(hasMore()); 1107 char c = previewChar(); 1108 checkState(matcher.matches(c)); 1109 position++; 1110 return c; 1111 } 1112 1113 @CanIgnoreReturnValue 1114 char consumeCharacter(char c) { 1115 checkState(hasMore()); 1116 checkState(previewChar() == c); 1117 position++; 1118 return c; 1119 } 1120 1121 char previewChar() { 1122 checkState(hasMore()); 1123 return input.charAt(position); 1124 } 1125 1126 boolean hasMore() { 1127 return (position >= 0) && (position < input.length()); 1128 } 1129 } 1130 1131 @Override 1132 public boolean equals(@CheckForNull Object obj) { 1133 if (obj == this) { 1134 return true; 1135 } else if (obj instanceof MediaType) { 1136 MediaType that = (MediaType) obj; 1137 return this.type.equals(that.type) 1138 && this.subtype.equals(that.subtype) 1139 // compare parameters regardless of order 1140 && this.parametersAsMap().equals(that.parametersAsMap()); 1141 } else { 1142 return false; 1143 } 1144 } 1145 1146 @Override 1147 public int hashCode() { 1148 // racy single-check idiom 1149 int h = hashCode; 1150 if (h == 0) { 1151 h = Objects.hashCode(type, subtype, parametersAsMap()); 1152 hashCode = h; 1153 } 1154 return h; 1155 } 1156 1157 private static final MapJoiner PARAMETER_JOINER = Joiner.on("; ").withKeyValueSeparator("="); 1158 1159 /** 1160 * Returns the string representation of this media type in the format described in <a 1161 * href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>. 1162 */ 1163 @Override 1164 public String toString() { 1165 // racy single-check idiom, safe because String is immutable 1166 String result = toString; 1167 if (result == null) { 1168 result = computeToString(); 1169 toString = result; 1170 } 1171 return result; 1172 } 1173 1174 private String computeToString() { 1175 StringBuilder builder = new StringBuilder().append(type).append('/').append(subtype); 1176 if (!parameters.isEmpty()) { 1177 builder.append("; "); 1178 Multimap<String, String> quotedParameters = 1179 Multimaps.transformValues( 1180 parameters, 1181 (String value) -> 1182 (TOKEN_MATCHER.matchesAllOf(value) && !value.isEmpty()) 1183 ? value 1184 : escapeAndQuote(value)); 1185 PARAMETER_JOINER.appendTo(builder, quotedParameters.entries()); 1186 } 1187 return builder.toString(); 1188 } 1189 1190 private static String escapeAndQuote(String value) { 1191 StringBuilder escaped = new StringBuilder(value.length() + 16).append('"'); 1192 for (int i = 0; i < value.length(); i++) { 1193 char ch = value.charAt(i); 1194 if (ch == '\r' || ch == '\\' || ch == '"') { 1195 escaped.append('\\'); 1196 } 1197 escaped.append(ch); 1198 } 1199 return escaped.append('"').toString(); 1200 } 1201}