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