Package org.springframework.boot.web.server

Class MimeMappings

java.lang.Object
org.springframework.boot.web.server.MimeMappings
All Implemented Interfaces:
Iterable<MimeMappings.Mapping>
public sealed class MimeMappings extends Object implements Iterable<MimeMappings.Mapping>
Simple server-independent abstraction for mime mappings. Roughly equivalent to the &lt;mime-mapping&gt; element traditionally found in web.xml.
Since:
2.0.0
Author:
Phillip Webb, Guirong Hu

  • Field Details

    • DEFAULT

      public static final MimeMappings DEFAULT
      Default mime mapping commonly used.

  • Constructor Details

    • MimeMappings

      public MimeMappings()
      Create a new empty MimeMappings instance.

    • MimeMappings

      public MimeMappings(MimeMappings mappings)
      Create a new MimeMappings instance from the specified mappings.
      Parameters:
      mappings - the source mappings

    • MimeMappings

      public MimeMappings(Map<String,String> mappings)
      Create a new MimeMappings from the specified mappings.
      Parameters:
      mappings - the source mappings with extension as the key and mime-type as the value

  • Method Details

    • add

      public String add(String extension, String mimeType)
      Add a new mime mapping.
      Parameters:
      extension - the file extension (excluding '.')
      mimeType - the mime type to map
      Returns:
      any previous mapping or null

    • remove

      public String remove(String extension)
      Remove an existing mapping.
      Parameters:
      extension - the file extension (excluding '.')
      Returns:
      the removed mime mapping or null if no item was removed

    • get

      public String get(String extension)
      Get a mime mapping for the given extension.
      Parameters:
      extension - the file extension (excluding '.')
      Returns:
      a mime mapping or null

    • getAll

      public Collection<MimeMappings.Mapping> getAll()
      Returns all defined mappings.
      Returns:
      the mappings.

    • iterator

      public final Iterator<MimeMappings.Mapping> iterator()
      Specified by:
      iterator in interface Iterable<MimeMappings.Mapping>

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • unmodifiableMappings

      public static MimeMappings unmodifiableMappings(MimeMappings mappings)
      Create a new unmodifiable view of the specified mapping. Methods that attempt to modify the returned map will throw UnsupportedOperationExceptions.
      Parameters:
      mappings - the mappings
      Returns:
      an unmodifiable view of the specified mappings.

    • lazyCopy

      public static MimeMappings lazyCopy(MimeMappings mappings)
      Create a new lazy copy of the given mappings that will only copy entries if the mappings are mutated.
      Parameters:
      mappings - the source mappings
      Returns:
      a new mappings instance
      Since:
      3.0.0