Index

A B C E F G I L N P R T V 
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractFileFormatDescriptor - Class in com.helger.phive.binary
Abstract implementation of IFileFormatDescriptor.
AbstractFileFormatDescriptor(String, String, Collection<String>, Collection<String>, Map<EPhiveContentValidationMode, IPhiveContentValidator>) - Constructor for class com.helger.phive.binary.AbstractFileFormatDescriptor
 
allowedFileExtensions() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 

B

BUILD_TIMESTAMP - Static variable in class com.helger.phive.binary.CPhiveBinaryVersion
Build timestamp - from properties file
BUILD_VERSION - Static variable in class com.helger.phive.binary.CPhiveBinaryVersion
Current version - from properties file

C

com.helger.phive.binary - package com.helger.phive.binary
 
com.helger.phive.binary.impl - package com.helger.phive.binary.impl
 
CPhiveBinaryVersion - Class in com.helger.phive.binary
Contains the version constants of phive-binary.

E

EPhiveContentValidationMode - Enum Class in com.helger.phive.binary
This enum defines how content validation should take place

F

FileFormatDescriptorCSV - Class in com.helger.phive.binary.impl
File format descriptor for CSV
FileFormatDescriptorCSV() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorCSV
 
FileFormatDescriptorGIF - Class in com.helger.phive.binary.impl
File format descriptor for GIF
FileFormatDescriptorGIF() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorGIF
 
FileFormatDescriptorJPG - Class in com.helger.phive.binary.impl
File format descriptor for JPG/JPEG
FileFormatDescriptorJPG() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorJPG
 
FileFormatDescriptorPDF - Class in com.helger.phive.binary.impl
File format descriptor for PDF
FileFormatDescriptorPDF() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorPDF
 
FileFormatDescriptorPNG - Class in com.helger.phive.binary.impl
File format descriptor for PNG
FileFormatDescriptorPNG() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorPNG
 
FileFormatDescriptorPSD - Class in com.helger.phive.binary.impl
File format descriptor for PSD
FileFormatDescriptorPSD() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorPSD
 
FileFormatDescriptorTIFF - Class in com.helger.phive.binary.impl
File format descriptor for TIFF
FileFormatDescriptorTIFF() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorTIFF
 
FileFormatDescriptorXLS - Class in com.helger.phive.binary.impl
File format descriptor for Excel XLS files
FileFormatDescriptorXLS() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorXLS
 
FileFormatDescriptorXLSX - Class in com.helger.phive.binary.impl
File format descriptor for Excel XLSX files
FileFormatDescriptorXLSX() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorXLSX
 
FileFormatDescriptorXML - Class in com.helger.phive.binary.impl
File format descriptor for XML documents
FileFormatDescriptorXML() - Constructor for class com.helger.phive.binary.impl.FileFormatDescriptorXML
 
FileFormatRegistrarDefaultSPI - Class in com.helger.phive.binary.impl
The default implementation of IFileFormatRegistrarSPI
FileFormatRegistrarDefaultSPI() - Constructor for class com.helger.phive.binary.impl.FileFormatRegistrarDefaultSPI
 
FileFormatRegistry - Class in com.helger.phive.binary
This is a central file format registry that should be used to started detection processes.
findContentValidator(EPhiveContentValidationMode...) - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
findContentValidator(EPhiveContentValidationMode...) - Method in interface com.helger.phive.binary.IFileFormatDescriptor
Find the best matching content validator, based on the provided validation modes.
FULL_PARSE - Enum constant in enum class com.helger.phive.binary.EPhiveContentValidationMode
The file format is detected by doing a full parse of the document to verify its correctness.

G

getAllAllowedFileExtensions() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
getAllAllowedFileExtensions() - Method in interface com.helger.phive.binary.IFileFormatDescriptor
 
getAllAllowedMimeTypes() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
getAllAllowedMimeTypes() - Method in interface com.helger.phive.binary.IFileFormatDescriptor
 
getAllContentValidators() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
getAllContentValidators() - Method in interface com.helger.phive.binary.IFileFormatDescriptor
 
getAllFileFormatDescriptors() - Method in class com.helger.phive.binary.FileFormatRegistry
 
getAllFileFormatDescriptors() - Method in interface com.helger.phive.binary.IFileFormatRegistry
 
getContentValidatorFavourAccuracy() - Method in interface com.helger.phive.binary.IFileFormatDescriptor
 
getContentValidatorFavourSpeed() - Method in interface com.helger.phive.binary.IFileFormatDescriptor
 
getFileFormatDescriptorByFileExtension(String) - Method in class com.helger.phive.binary.FileFormatRegistry
 
getFileFormatDescriptorByFileExtension(String) - Method in interface com.helger.phive.binary.IFileFormatRegistry
Find the file format descriptor with the given file extension
getFileFormatDescriptorByMimeType(IMimeType) - Method in interface com.helger.phive.binary.IFileFormatRegistry
Find the file format descriptor with the given MIME type
getFileFormatDescriptorByMimeType(String) - Method in class com.helger.phive.binary.FileFormatRegistry
 
getFileFormatDescriptorByMimeType(String) - Method in interface com.helger.phive.binary.IFileFormatRegistry
Find the file format descriptor with the given MIME type
getFileFormatDescriptorOfName(String) - Method in class com.helger.phive.binary.FileFormatRegistry
 
getFileFormatDescriptorOfName(String) - Method in interface com.helger.phive.binary.IFileFormatRegistry
Find the file format descriptor with the given name
getFromIDOrNull(String) - Static method in enum class com.helger.phive.binary.EPhiveContentValidationMode
 
getID() - Method in enum class com.helger.phive.binary.EPhiveContentValidationMode
 
getInstance() - Static method in class com.helger.phive.binary.FileFormatRegistry
 
getName() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
getRegisteredFileFormatDescriptorCount() - Method in class com.helger.phive.binary.FileFormatRegistry
 
getShortName() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
getShortName() - Method in interface com.helger.phive.binary.IFileFormatDescriptor
 

I

IFileFormatDescriptor - Interface in com.helger.phive.binary
Descriptor for a single file format.
IFileFormatRegistrarSPI - Interface in com.helger.phive.binary
SPI interface to be implemented by other modules wishing to register their own file formats.
IFileFormatRegistry - Interface in com.helger.phive.binary
Base interface for a file format registry
internalAllowedMimeTypes() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
internalContentDetectors() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
IPhiveContentValidator - Interface in com.helger.phive.binary
A single content detector interface
isInstantiated() - Static method in class com.helger.phive.binary.FileFormatRegistry
 
isValidContent(byte[]) - Method in interface com.helger.phive.binary.IPhiveContentValidator
Check if the provided data matches the requirements.
isValidFileExtension(String) - Static method in class com.helger.phive.binary.PhiveBinaryHelper
Check if the provided file extension is valid or not.
isValidMimeType(String) - Static method in class com.helger.phive.binary.PhiveBinaryHelper
Check if the provided MIME Type is valid or not.

L

LEADING_BYTES - Enum constant in enum class com.helger.phive.binary.EPhiveContentValidationMode
The file format is detected based on the first n bytes of the content.

N

NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorCSV
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorGIF
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorJPG
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorPDF
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorPNG
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorPSD
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorTIFF
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorXLS
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorXLSX
 
NAME - Static variable in class com.helger.phive.binary.impl.FileFormatDescriptorXML
 

P

PhiveBinaryHelper - Class in com.helger.phive.binary
Helper classes

R

registerFileFormat(IFileFormatDescriptor) - Method in class com.helger.phive.binary.FileFormatRegistry
 
registerFileFormat(IFileFormatDescriptor) - Method in interface com.helger.phive.binary.IFileFormatRegistry
Register a new file format descriptor into the registry.
registerFileFormats(IFileFormatRegistry) - Method in interface com.helger.phive.binary.IFileFormatRegistrarSPI
Register all your file format descriptors.
registerFileFormats(IFileFormatRegistry) - Method in class com.helger.phive.binary.impl.FileFormatRegistrarDefaultSPI
 
reinitialize() - Method in class com.helger.phive.binary.FileFormatRegistry
 

T

toString() - Method in class com.helger.phive.binary.AbstractFileFormatDescriptor
 
toString() - Method in class com.helger.phive.binary.FileFormatRegistry
 

V

valueOf(String) - Static method in enum class com.helger.phive.binary.EPhiveContentValidationMode
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.helger.phive.binary.EPhiveContentValidationMode
Returns an array containing the constants of this enum class, in the order they are declared.
A B C E F G I L N P R T V 
All Classes and Interfaces|All Packages|Constant Field Values