MimeType (Java Tool 1.26.2 API)

java.lang.Object
- org.osgl.util.MimeType

public final class MimeType
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MimeType.Trait

Nested Classes
Modifier and Type	Class and Description
`static class`	`MimeType.Trait`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Collection<MimeType>`	`allMimeTypes()` Returns a collection of all managed mime types.
`MimeType`	`createAlias(String name)` Create an new MimeType with traits and type of this MimeType instance and associate it with an new name.
`String`	`fileExtension()` Deprecated.
`static List<MimeType>`	`filterByTrait(MimeType.Trait trait)` Get a list of `MimeType` with each item contains the trait specified.
`static MimeType`	`findByContentType(String contentType)` Find MimeType by content type.
`static MimeType`	`findByFileExtension(String fileExtension)` Deprecated.
`static MimeType`	`findByName(String name)` Return a MimeType by name.
`boolean`	`hasTrait(MimeType.Trait trait)` Check if this `MimeType` has the trait specified.
`boolean`	`isAlias(MimeType mimeType)` Check if the mime type specified is an alias of this mime type.
`boolean`	`isSameTypeWith(MimeType mimeType)` Check if the mime type specified has the same `type` of this mime type.
`boolean`	`isSameTypeWithAny(MimeType... types)` Check if this mime type is same type of any one specified in the var arg list.
`boolean`	`matches(String s)` Check if this `MimeType` matches a string specified.
`String`	`name()` Return name of this MimeType.
`static void`	`registerMimeType(String name, String contentType, MimeType.Trait... traits)` Register an new MimeType with name, contentType and traits.
`boolean`	`test(MimeType.Trait trait)` Deprecated.
`boolean`	`test(String s)` This method is deprecated.
`String`	`toString()`
`String`	`type()`
`static String`	`typeOfName(String name)` Return a content type string corresponding to a given name.
`static String`	`typeOfSuffix(String fileExtension)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fileExtension
```
@Deprecated
public String fileExtension()
```
    Deprecated.
    
    Return file extension of this MimeType.
    
    Note this method is obsolete, please use instead
    
    Returns:
    
    file extension of this MimeType
  - name
```
public String name()
```
    Return name of this MimeType.
    
    Returns:
    
    name of this MimeType
  - type
```
public String type()
```
  - isSameTypeWith
```
public boolean isSameTypeWith(MimeType mimeType)
```
    Check if the mime type specified has the same type of this mime type.
    
    Parameters:
    
    mimeType - the mime type to be test
    
    Returns:
    
    true if the mime type has the same type with this mime type.
  - isSameTypeWithAny
```
public boolean isSameTypeWithAny(MimeType... types)
```
    Check if this mime type is same type of any one specified in the var arg list.
    
    Parameters:
    
    types - a var arg list of mime types.
    
    Returns:
    
    true if this mime type is same type of any one specified in the list.
  - isAlias
```
public boolean isAlias(MimeType mimeType)
```
    Check if the mime type specified is an alias of this mime type. Calling this method has the same effect with calling #isSameType(MimeType).
    
    Parameters:
    
    mimeType - the mime type to be tested.
    
    Returns:
    
    true if the mime type has the same type with this mime type.
  - createAlias
```
public MimeType createAlias(String name)
```
    Create an new MimeType with traits and type of this MimeType instance and associate it with an new name.
    
    If the name specified is already registered, then an IllegalArgumentException will be thrown out.
    
    Parameters:
    
    name - the name to be associated with the new MimeType instance
    
    Returns:
    
    the new MimeType instance.
  - test
```
@Deprecated
public boolean test(MimeType.Trait trait)
```
    Deprecated.
    
    This method is deprecated. Please use hasTrait(Trait) instead.
    
    Check if this MimeType has the trait specified.
    
    Parameters:
    
    trait - the trait to test this mime type.
    
    Returns:
    
    true if this mime type has the trait specified.
  - hasTrait
```
public boolean hasTrait(MimeType.Trait trait)
```
    Check if this MimeType has the trait specified.
    
    Parameters:
    
    trait - the trait to test this mime type.
    
    Returns:
    
    true if this mime type has the trait specified.
  - test
```
public boolean test(String s)
```
    This method is deprecated. Please use matches(String) instead
    
    Check if this MimeType matches a string specified.
    
    This method will
    - check if the string matches the name, if not then
    - check if the string matches the type, if not then
    - check if the string represent a trait and contained in this MimeType.
    Parameters:
    
    s - the string to be tested.
    
    Returns:
    
    true if the s matches as per logic specified above.
  - matches
```
public boolean matches(String s)
```
    Check if this MimeType matches a string specified.
    
    This method will
    - check if the string matches the name, if not then
    - check if the string matches the type, if not then
    - check if the string represent a trait and contained in this MimeType.
    Parameters:
    
    s - the string to be tested.
    
    Returns:
    
    true if the s matches as per logic specified above.
  - findByFileExtension
```
@Deprecated
public static MimeType findByFileExtension(String fileExtension)
```
    Deprecated.
    
    This method is deprecated. Please use findByName(String) instead.
    
    Parameters:
    
    fileExtension - the file extension.
    
    Returns:
    
    the MimeType associated with the file extension (name)
  - findByName
```
public static MimeType findByName(String name)
```
    Return a MimeType by name.
    
    Parameters:
    
    name - the name to locate the MimeType.
    
    Returns:
    
    the MimeType associated with the name specified.
  - findByContentType
```
public static MimeType findByContentType(String contentType)
```
    Find MimeType by content type.
    
    Parameters:
    
    contentType - the content type.
    
    Returns:
    
    MimeType with the content type specified.
  - filterByTrait
```
public static List<MimeType> filterByTrait(MimeType.Trait trait)
```
    Get a list of MimeType with each item contains the trait specified.
    
    Parameters:
    
    trait - the trait to filter MimeType list
    
    Returns:
    
    a list of MimeType matches the trait.
  - allMimeTypes
```
public static Collection<MimeType> allMimeTypes()
```
    Returns a collection of all managed mime types.
    
    Returns:
    
    all managed mime types.
  - typeOfSuffix
```
@Deprecated
public static String typeOfSuffix(String fileExtension)
```
    Deprecated.
    
    This method is deprecated. Please use typeOfName(String) instead.
    
    Return a content type string corresponding to a given file extension suffix.
    
    If there is no MimeType corresponding to the file extension, then returns the file extension string directly.
    
    Parameters:
    
    fileExtension - file extension suffix
    
    Returns:
    
    A content type string corresponding to the file extension suffix or the file extension suffix itself if no corresponding mimetype found.
  - typeOfName
```
public static String typeOfName(String name)
```
    Return a content type string corresponding to a given name.
    
    If there is no MimeType corresponding to the name, then returns the name string directly.
    
    Parameters:
    
    name - the name
    
    Returns:
    
    A content type string corresponding to the file extension suffix or the file extension suffix itself if no corresponding mimetype found.
  - registerMimeType
```
public static void registerMimeType(String name,
                                    String contentType,
                                    MimeType.Trait... traits)
```
    Register an new MimeType with name, contentType and traits.
    
    Note if there are existing MimeType associated with the name, the existing one will be replaced.
    
    Parameters:
    
    name - the name of the new mime type
    
    contentType - the content type of the new mime type
    
    traits - the traits of the new mimetype

Class MimeType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

toString

fileExtension

name

type

isSameTypeWith

isSameTypeWithAny

isAlias

createAlias

test

hasTrait

test

matches

findByFileExtension

findByName

findByContentType

filterByTrait

allMimeTypes

typeOfSuffix

typeOfName

registerMimeType