类 MimeType
- java.lang.Object
- org.springframework.util.MimeType
- 所有已实现的接口:
Serializable
,Comparable<MimeType>
- 直接已知子类:
MediaType
public class MimeType extends Object implements Comparable<MimeType>, Serializable
Represents a MIME Type, as originally defined in RFC 2046 and subsequently used in other Internet protocols including HTTP.This class, however, does not contain support for the q-parameters used in HTTP content negotiation. Those can be found in the subclass
org.springframework.http.MediaType
in thespring-web
module.Consists of a type and a subtype. Also has functionality to parse MIME Type values from a
String
usingvalueOf(String)
. For more parsing options seeMimeTypeUtils
.- 从以下版本开始:
- 4.0
- 作者:
- Arjen Poutsma, Juergen Hoeller, Rossen Stoyanchev, Sam Brannen
- 另请参阅:
MimeTypeUtils
, 序列化表格
嵌套类概要
嵌套类 修饰符和类型 类 说明 static class
MimeType.SpecificityComparator<T extends MimeType>
Comparator to sortMimeTypes
in order of specificity.
字段概要
字段 修饰符和类型 字段 说明 protected static String
WILDCARD_TYPE
构造器概要
构造器 构造器 说明 MimeType(String type)
Create a newMimeType
for the given primary type.MimeType(String type, String subtype)
Create a newMimeType
for the given primary type and subtype.MimeType(String type, String subtype, Charset charset)
Create a newMimeType
for the given type, subtype, and character set.MimeType(String type, String subtype, Map<String,String> parameters)
Create a newMimeType
for the given type, subtype, and parameters.MimeType(MimeType other, Charset charset)
Copy-constructor that copies the type, subtype, parameters of the givenMimeType
, and allows to set the specified character set.MimeType(MimeType other, Map<String,String> parameters)
Copy-constructor that copies the type and subtype of the givenMimeType
, and allows for different parameter.
方法概要
所有方法 静态方法 实例方法 具体方法 修饰符和类型 方法 说明 protected void
appendTo(StringBuilder builder)
protected void
checkParameters(String parameter, String value)
int
compareTo(MimeType other)
Compares this MIME Type to another alphabetically.boolean
equals(Object other)
boolean
equalsTypeAndSubtype(MimeType other)
Similar toequals(Object)
but based on the type and subtype only, i.e. ignoring parameters.Charset
getCharset()
Return the character set, as indicated by acharset
parameter, if any.String
getParameter(String name)
Return a generic parameter value, given a parameter name.Map<String,String>
getParameters()
Return all generic parameter values.String
getSubtype()
Return the subtype.String
getType()
Return the primary type.int
hashCode()
boolean
includes(MimeType other)
Indicate whether this MIME Type includes the given MIME Type.boolean
isCompatibleWith(MimeType other)
Indicate whether this MIME Type is compatible with the given MIME Type.boolean
isConcrete()
Indicates whether this MIME Type is concrete, i.e. whether neither the type nor the subtype is a wildcard character*
.boolean
isPresentIn(Collection<? extends MimeType> mimeTypes)
UnlikeCollection.contains(Object)
which relies onequals(Object)
, this method only checks the type and the subtype, but otherwise ignores parameters.boolean
isWildcardSubtype()
Indicates whether the subtype is the wildcard character*
or the wildcard character followed by a suffix (e.g.boolean
isWildcardType()
Indicates whether the type is the wildcard character*
or not.String
toString()
protected String
unquote(String s)
static MimeType
valueOf(String value)
Parse the given String value into aMimeType
object, with this method name following the 'valueOf' naming convention (as supported byConversionService
.
字段详细资料
WILDCARD_TYPE
protected static final String WILDCARD_TYPE
- 另请参阅:
- 常量字段值
构造器详细资料
MimeType
public MimeType(String type)
Create a newMimeType
for the given primary type.The subtype is set to
"*"
, and the parameters are empty.- 参数:
type
- the primary type- 抛出:
IllegalArgumentException
- if any of the parameters contains illegal characters
MimeType
public MimeType(String type, String subtype)
Create a newMimeType
for the given primary type and subtype.The parameters are empty.
- 参数:
type
- the primary typesubtype
- the subtype- 抛出:
IllegalArgumentException
- if any of the parameters contains illegal characters
MimeType
public MimeType(String type, String subtype, Charset charset)
Create a newMimeType
for the given type, subtype, and character set.- 参数:
type
- the primary typesubtype
- the subtypecharset
- the character set- 抛出:
IllegalArgumentException
- if any of the parameters contains illegal characters
MimeType
public MimeType(MimeType other, Charset charset)
Copy-constructor that copies the type, subtype, parameters of the givenMimeType
, and allows to set the specified character set.- 参数:
other
- the other MimeTypecharset
- the character set- 抛出:
IllegalArgumentException
- if any of the parameters contains illegal characters- 从以下版本开始:
- 4.3
MimeType
public MimeType(MimeType other, @Nullable Map<String,String> parameters)
Copy-constructor that copies the type and subtype of the givenMimeType
, and allows for different parameter.- 参数:
other
- the other MimeTypeparameters
- the parameters (may benull
)- 抛出:
IllegalArgumentException
- if any of the parameters contains illegal characters
MimeType
public MimeType(String type, String subtype, @Nullable Map<String,String> parameters)
Create a newMimeType
for the given type, subtype, and parameters.- 参数:
type
- the primary typesubtype
- the subtypeparameters
- the parameters (may benull
)- 抛出:
IllegalArgumentException
- if any of the parameters contains illegal characters
方法详细资料
checkParameters
protected void checkParameters(String parameter, String value)
isWildcardType
public boolean isWildcardType()
Indicates whether the type is the wildcard character*
or not.
isWildcardSubtype
public boolean isWildcardSubtype()
Indicates whether the subtype is the wildcard character*
or the wildcard character followed by a suffix (e.g.*+xml
).- 返回:
- whether the subtype is a wildcard
isConcrete
public boolean isConcrete()
Indicates whether this MIME Type is concrete, i.e. whether neither the type nor the subtype is a wildcard character*
.- 返回:
- whether this MIME Type is concrete
getSubtype
public String getSubtype()
Return the subtype.
getCharset
@Nullable public Charset getCharset()
Return the character set, as indicated by acharset
parameter, if any.- 返回:
- the character set, or
null
if not available - 从以下版本开始:
- 4.3
getParameter
@Nullable public String getParameter(String name)
Return a generic parameter value, given a parameter name.- 参数:
name
- the parameter name- 返回:
- the parameter value, or
null
if not present
getParameters
public Map<String,String> getParameters()
Return all generic parameter values.- 返回:
- a read-only map (possibly empty, never
null
)
includes
public boolean includes(@Nullable MimeType other)
Indicate whether this MIME Type includes the given MIME Type.For instance,
text/*
includestext/plain
andtext/html
, andapplication/*+xml
includesapplication/soap+xml
, etc. This method is not symmetric.- 参数:
other
- the reference MIME Type with which to compare- 返回:
true
if this MIME Type includes the given MIME Type;false
otherwise
isCompatibleWith
public boolean isCompatibleWith(@Nullable MimeType other)
Indicate whether this MIME Type is compatible with the given MIME Type.For instance,
text/*
is compatible withtext/plain
,text/html
, and vice versa. In effect, this method is similar toincludes(org.springframework.util.MimeType)
, except that it is symmetric.- 参数:
other
- the reference MIME Type with which to compare- 返回:
true
if this MIME Type is compatible with the given MIME Type;false
otherwise
equalsTypeAndSubtype
public boolean equalsTypeAndSubtype(@Nullable MimeType other)
Similar toequals(Object)
but based on the type and subtype only, i.e. ignoring parameters.- 参数:
other
- the other mime type to compare to- 返回:
- whether the two mime types have the same type and subtype
- 从以下版本开始:
- 5.1.4
isPresentIn
public boolean isPresentIn(Collection<? extends MimeType> mimeTypes)
UnlikeCollection.contains(Object)
which relies onequals(Object)
, this method only checks the type and the subtype, but otherwise ignores parameters.- 参数:
mimeTypes
- the list of mime types to perform the check against- 返回:
- whether the list contains the given mime type
- 从以下版本开始:
- 5.1.4
appendTo
protected void appendTo(StringBuilder builder)
compareTo
public int compareTo(MimeType other)
Compares this MIME Type to another alphabetically.- 指定者:
compareTo
在接口中Comparable<MimeType>
- 参数:
other
- the MIME Type to compare to- 另请参阅:
MimeTypeUtils.sortBySpecificity(List)
valueOf
public static MimeType valueOf(String value)
Parse the given String value into aMimeType
object, with this method name following the 'valueOf' naming convention (as supported byConversionService
.