Class ZipArchiveXMLMagicNumber
- java.lang.Object
-
- org.arakhne.afc.inputoutput.filetype.MagicNumber
-
- org.arakhne.afc.inputoutput.filetype.ZipArchiveMagicNumber
-
- org.arakhne.afc.inputoutput.filetype.ZipArchiveXMLMagicNumber
-
- All Implemented Interfaces:
Comparable<MagicNumber>
- Direct Known Subclasses:
DTDBasedZipArchiveXMLMagicNumber
,XSLBasedZipArchiveXMLMagicNumber
public abstract class ZipArchiveXMLMagicNumber extends ZipArchiveMagicNumber
This class defines a set of informations that could distinguish a file content from another one. It is also known as Magic Number on several operating systems.This magic number supports an XML file inside a zip archive.
- Since:
- 14.0
- Version:
- 17.0 2020-01-04 14:41:40
- Author:
- Stéphane GALLAND
- Maven Group Id:
- org.arakhne.afc.core
- Maven Artifact Id:
- inputoutput
-
-
Constructor Summary
Constructors Constructor Description ZipArchiveXMLMagicNumber(javax.activation.MimeType mimeType, File innerFile, String rootNode)
Constructor.ZipArchiveXMLMagicNumber(javax.activation.MimeType mimeType, String formatVersion, File innerFile, String rootNode)
Constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract boolean
isContentType(String schemaId, String schemaVersion, String systemId, String publicId)
Replies if the specified stream contains data that corresponds to this magic number.protected boolean
isContentType(ZipInputStream zipStream, ZipEntry zipEntry, InputStream zipEntryStream)
Replies if the specified stream contains data that corresponds to this magic number.-
Methods inherited from class org.arakhne.afc.inputoutput.filetype.ZipArchiveMagicNumber
doStreamEncoding, isContentType, undoStreamEncoding
-
Methods inherited from class org.arakhne.afc.inputoutput.filetype.MagicNumber
compareTo, getFormatVersion, getHostMimeTypes, getMimeType
-
-
-
-
Constructor Detail
-
ZipArchiveXMLMagicNumber
public ZipArchiveXMLMagicNumber(javax.activation.MimeType mimeType, String formatVersion, File innerFile, String rootNode)
Constructor.- Parameters:
mimeType
- is the MIME type associated to this magic number.formatVersion
- is the version of the supported format.innerFile
- is the file to open from the inside of the Zip archive to test the type. The filename is relative to the root of the zip file content.rootNode
- is the name of the XML root node from which XLS information may be extracted.
-
ZipArchiveXMLMagicNumber
public ZipArchiveXMLMagicNumber(javax.activation.MimeType mimeType, File innerFile, String rootNode)
Constructor.- Parameters:
mimeType
- is the MIME type associated to this magic number.innerFile
- is the file to open from the inside of the Zip archive to test the type. The filename is relative to the root of the zip file content.rootNode
- is the name of the XML root node from which XLS information may be extracted.
-
-
Method Detail
-
isContentType
protected final boolean isContentType(ZipInputStream zipStream, ZipEntry zipEntry, InputStream zipEntryStream)
Description copied from class:ZipArchiveMagicNumber
Replies if the specified stream contains data that corresponds to this magic number.- Specified by:
isContentType
in classZipArchiveMagicNumber
- Parameters:
zipStream
- is the stream of the Zip archivezipEntry
- is the zip entry that is corresponding to the innerFile given as parameter of the constructor, ornull
not significant.zipEntryStream
- is the stream on the data of the given zip entry, ornull
not significant.- Returns:
true
if the stream is containing this magic number, otherwisefalse
-
isContentType
protected abstract boolean isContentType(String schemaId, String schemaVersion, String systemId, String publicId)
Replies if the specified stream contains data that corresponds to this magic number.- Parameters:
schemaId
- is the ID of the XSL schema associated to this magic number.schemaVersion
- is the ID of the XSL schema associated to this magic number.systemId
- is the DTD system ID associated to this magic number.publicId
- is the DTD system ID associated to this magic number.- Returns:
true
if this magic number is corresponding to the given XML document, otherwisefalse
-
-