org.springframework.boot.web.server

Class MimeMappings

java.lang.Object

org.springframework.boot.web.server.MimeMappings

All Implemented Interfaces:

Iterable<MimeMappings.Mapping>

public final 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MimeMappings.Mapping A single mime mapping.

Field Summary

Fields

Modifier and Type	Field and Description
static MimeMappings	DEFAULT Default mime mapping commonly used.

Constructor Summary

Constructors

Constructor and Description
MimeMappings() Create a new empty MimeMappings instance.
MimeMappings(Map<String,String> mappings) Create a new MimeMappings from the specified mappings.
MimeMappings(MimeMappings mappings) Create a new MimeMappings instance from the specified mappings.

Method Summary

Modifier and Type	Method and Description
String	add(String extension, String mimeType) Add a new mime mapping.
boolean	equals(Object obj)
String	get(String extension) Get a mime mapping for the given extension.
Collection<MimeMappings.Mapping>	getAll() Returns all defined mappings.
int	hashCode()
Iterator<MimeMappings.Mapping>	iterator()
String	remove(String extension) Remove an existing mapping.
static MimeMappings	unmodifiableMappings(MimeMappings mappings) Create a new unmodifiable view of the specified mapping.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT

public static final MimeMappings DEFAULT

Default mime mapping commonly used.

Constructor Detail

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 Detail

iterator

public Iterator<MimeMappings.Mapping> iterator()

Specified by:

iterator in interface Iterable<MimeMappings.Mapping>

getAll

public Collection<MimeMappings.Mapping> getAll()

Returns all defined mappings.

Returns:

the mappings.

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

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

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

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.