Package org.apache.poi.poifs.filesystem
Enum Class FileMagic
- All Implemented Interfaces:
Serializable
,Comparable<FileMagic>
,Constable
The file magic number, i.e. the file identification based on the first bytes
of the file
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionBIFF2 raw stream - for Excel 2BIFF3 raw stream - for Excel 3BIFF4 raw stream - for Excel 4Some different HTML documentsOld MS Write raw streamOLE2 / BIFF8+ stream used for Office 97 and higher documentsOOXML / ZIP streamPDF documentRTF documentUNKNOWN magicXML file -
Method Summary
Modifier and TypeMethodDescriptionstatic InputStream
prepareToCheckMagic
(InputStream stream) Checks if anInputStream
can be reset (i.e.static FileMagic
valueOf
(byte[] magic) Returns the enum constant of this class with the specified name.static FileMagic
Get the file magic of the suppliedFile
static FileMagic
valueOf
(InputStream inp) Get the file magic of the supplied InputStream (which MUST support mark and reset).static FileMagic
Returns the enum constant of this class with the specified name.static FileMagic[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OLE2
OLE2 / BIFF8+ stream used for Office 97 and higher documents -
OOXML
OOXML / ZIP stream -
XML
XML file -
BIFF2
BIFF2 raw stream - for Excel 2 -
BIFF3
BIFF3 raw stream - for Excel 3 -
BIFF4
BIFF4 raw stream - for Excel 4 -
MSWRITE
Old MS Write raw stream -
RTF
RTF document -
PDF
PDF document -
HTML
Some different HTML documents -
WORD2
-
UNKNOWN
UNKNOWN magic
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
magic
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOf
Get the file magic of the suppliedFile
Even if this method returns
UNKNOWN
it could potentially mean, that the ZIP stream has leading junk bytes- Parameters:
inp
- a file to be identified- Throws:
IOException
-
valueOf
Get the file magic of the supplied InputStream (which MUST support mark and reset).If unsure if your InputStream does support mark / reset, use
prepareToCheckMagic(InputStream)
to wrap it and make sure to always use that, and not the original!Even if this method returns
UNKNOWN
it could potentially mean, that the ZIP stream has leading junk bytes- Parameters:
inp
- An InputStream which supports either mark/reset- Throws:
IOException
-
prepareToCheckMagic
Checks if anInputStream
can be reset (i.e. used for checking the header magic) and wraps it if not- Parameters:
stream
- stream to be checked for wrapping- Returns:
- a mark enabled stream
-