Groupdocs API References – com.groupdocs.viewer

Java: License

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class License

Provides methods to license the component and unlock its full functionality.

The License class allows you to apply a valid license to the GroupDocs.Viewer component, enabling you to utilize all the features and remove any evaluation limitations.

Example usage:


 License license = new License();
 license.setLicense("path/to/license/file.lic");

Constructors

Constructor	Description
License()

Methods

Method	Description
resetLicense()
setLicense(InputStream licenseStream)	Licenses the component.
setLicense(Path licensePath)	Licenses the component.
setLicense(String licensePath)	Licenses the component.
setLicense(URL licenseUri)	Licenses the component.
isLicensed()

License()

public License()

resetLicense()

public static void resetLicense()

setLicense(InputStream licenseStream)

public final void setLicense(InputStream licenseStream)

Licenses the component.

The following example demonstrates how to set a license passing InputStream of the license file.

For more information about licensing, please refer to the GroupDocs Licensing FAQ. You can also find detailed information about GroupDocs.Viewer licensing in the Evaluation Limitations and Licensing documentation.

Example:


 FileInputStream licenseStream = new FileInputStream("LicenseFile.lic");
 License license = new License();
 license.setLicense(licenseStream);

Parameters:

Parameter	Type	Description
licenseStream	java.io.InputStream	The license stream.

setLicense(Path licensePath)

public final void setLicense(Path licensePath)

Licenses the component.

Sets the license for the component using the specified license path.

Note: This method should be called before using any functionality of the component.

Parameters:

Parameter	Type	Description
licensePath	java.nio.file.Path	The license path.

setLicense(String licensePath)

public final void setLicense(String licensePath)

Licenses the component.

This method should be called before using any functionality.

Example usage:


 String licensePath = "GroupDocs.Viewer.lic";
 License license = new License();
 license.setLicense(licensePath);

Parameters:

Parameter	Type	Description
licensePath	java.lang.String	The license path or url.

setLicense(URL licenseUri)

public void setLicense(URL licenseUri)

Licenses the component.

This method should be called before using any functionality.

Parameters:

Parameter	Type	Description
licenseUri	java.net.URL	The license URI.

isLicensed()

public final boolean isLicensed()

Returns: boolean

Java: Metered

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class Metered

Provides methods for applying metered license to the GroupDocs.Viewer component.

Metered licensing allows you to dynamically monitor and control the usage of GroupDocs.Viewer based on the number of document pages processed instead of a traditional per-server or per-developer license. This flexible licensing model is suitable for scenarios where the document processing requirements vary over time or when you want to pay only for what you use.

Example usage:


 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 // Perform document processing operations using GroupDocs.Viewer
 // ...

Constructors

Constructor	Description
Metered()

Methods

Method	Description
getConsumptionQuantity()	Retrieves the amount of megabytes (MB) processed.
getConsumptionCredit()	Retrieves the count of credits consumed.
setMeteredKey(String publicKey, String privateKey)	Activates the product with Metered keys.

Metered()

public Metered()

getConsumptionQuantity()

public static double getConsumptionQuantity()

Retrieves the amount of megabytes (MB) processed.

This method returns the total amount of MB processed by the component.

Example:


 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double mbProcessed = Metered.getConsumptionQuantity();

Returns: double - the amount of MB processed.

getConsumptionCredit()

public static double getConsumptionCredit()

Retrieves the count of credits consumed.

This method returns the total count of credits consumed by the component.

Example:


 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);
 double creditsConsumed = Metered.getConsumptionCredit();

Returns: double - the count of credits consumed.

setMeteredKey(String publicKey, String privateKey)

public final void setMeteredKey(String publicKey, String privateKey)

Activates the product with Metered keys.

Following example demonstrates how to activate product with Metered keys.

Example:


 String publicKey = "Public Key";
 String privateKey = "Private Key";
 Metered metered = new Metered();
 metered.setMeteredKey(publicKey, privateKey);

Parameters:

Parameter	Type	Description
publicKey	java.lang.String	The public key.
privateKey	java.lang.String	The private key.

Java: Viewer

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: java.io.Closeable

public class Viewer implements Closeable

Represents the main class that controls the document rendering process.

The Viewer class is the entry point for rendering documents using the GroupDocs.Viewer component. It provides methods and options to load documents from various sources, customize the rendering process, and retrieve the rendered output in different formats.

Example usage:


 try (Viewer viewer = new Viewer("source.pdf")) {
     viewer.view(new PngViewOptions("result-page{0}.png"));
 }

Constructors

Constructor	Description
Viewer(InputStream fileStream)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, boolean leaveOpen)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)	Initializes new instance of Viewer class.
Viewer(URL url)	Initializes a new instance of the Viewer class.
Viewer(URL url, LoadOptions loadOptions)	Initializes a new instance of the Viewer class.
Viewer(URL url, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(FileReader fileReader, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(String filePath)	Initializes a new instance of the Viewer class.
Viewer(Path filePath)	Initializes a new instance of the Viewer class.
Viewer(String filePath, LoadOptions loadOptions)	Initializes a new instance of the Viewer class.
Viewer(Path filePath, LoadOptions loadOptions)	Initializes a new instance of the Viewer class.
Viewer(String filePath, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(Path filePath, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)	Initializes a new instance of the Viewer class.
Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)	Initializes a new instance of the Viewer class.

Fields

Field	Description
LOAD_OPTIONS
SETTINGS
FILE_READER
OPTIONS

Methods

Method	Description
getViewInfo(ViewInfoOptions options)	Returns information about the view and document specific information.
getAttachments()	Returns attachments contained by the document.
saveAttachment(Attachment attachment, OutputStream destination)	Saves an attachment file to the destination stream.
view(ViewOptions options)	Creates a view of all document pages.
view(ViewOptions options, int[] pageNumbers)	Creates a view of specific document pages.
getAllFonts()	Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document.
search(SearchHighlightOptions options)	Performs a text search and highlights matches (if found) in the loaded document according to the provided options.
getFileInfo()	Returns information about the file, such as file type and a flag that indicates if the file is encrypted.
close()	Releases the file stream and managed internal resources.

Viewer(InputStream fileStream)

public Viewer(InputStream fileStream)

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The method that returns a readable stream.

Viewer(InputStream fileStream, boolean leaveOpen)

public Viewer(InputStream fileStream, boolean leaveOpen)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The file stream.
leaveOpen	boolean	true to leave the stream open after the Viewer object is disposed; otherwise, false.

Viewer(InputStream fileStream, LoadOptions loadOptions)

public Viewer(InputStream fileStream, LoadOptions loadOptions)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The readable stream.
loadOptions	LoadOptions	The document load options.

Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)

public Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The file stream.
loadOptions	LoadOptions	The document load options.
leaveOpen	boolean	true to leave the stream open after the Viewer object is disposed; otherwise, false.

Viewer(InputStream fileStream, ViewerSettings settings)

public Viewer(InputStream fileStream, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The file stream.
settings	ViewerSettings	The Viewer settings.

Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)

public Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The file stream.
settings	ViewerSettings	The Viewer settings.
leaveOpen	boolean	true to leave the stream open after the Viewer object is disposed; otherwise, false.

Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)

public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The file stream.
loadOptions	LoadOptions	The document load options.
settings	ViewerSettings	The Viewer settings.

Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)

public Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen)

Initializes new instance of Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
fileStream	java.io.InputStream	The file stream.
loadOptions	LoadOptions	The document load options.
settings	ViewerSettings	The Viewer settings.
leaveOpen	boolean	true to leave the stream open after the Viewer object is disposed; otherwise, false.

Viewer(URL url)

public Viewer(URL url)

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer

Parameters:

Parameter	Type	Description
url	java.net.URL	A URL to a file that should be loaded into the Viewer.

Viewer(URL url, LoadOptions loadOptions)

public Viewer(URL url, LoadOptions loadOptions)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
url	java.net.URL	A URL to a file that should be loaded into the Viewer.
loadOptions	LoadOptions	The document load options.

Viewer(URL url, ViewerSettings settings)

public Viewer(URL url, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
url	java.net.URL	A URL to a file that should be loaded into the Viewer.
settings	ViewerSettings	The Viewer settings.

Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)

public Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
url	java.net.URL	A URL to a file that should be loaded into the Viewer.
loadOptions	LoadOptions	The document load options.
settings	ViewerSettings	The Viewer settings.

Viewer(FileReader fileReader, ViewerSettings settings)

public Viewer(FileReader fileReader, ViewerSettings settings)

Initializes a new instance of the Viewer class.

This constructor allows you to create a Viewer object to view a document from a FileReader with the specified ViewerSettings.

Learn more

To learn about the file types supported by GroupDocs.Viewer, visit: Document formats supported by GroupDocs.Viewer
To explore the features of GroupDocs.Viewer for Java, refer to: Developer Guide

Parameters:

Parameter	Type	Description
fileReader	FileReader	The FileReader containing the document to be loaded into the Viewer.
settings	ViewerSettings	The ViewerSettings to be applied to the Viewer.

Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)

public Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Provides functionality to load and view documents using GroupDocs.Viewer.

Note: Ensure that the file reader, load options, and settings are properly configured for accurate document processing.

Parameters:

Parameter	Type	Description
fileReader	FileReader	The file reader.
loadOptions	LoadOptions	The load options.
settings	ViewerSettings	The Viewer settings.

Viewer(String filePath)

public Viewer(String filePath)

Initializes a new instance of the Viewer class.

Learn more:

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The path to the file to render.

Viewer(Path filePath)

public Viewer(Path filePath)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

Parameter	Type	Description
filePath	java.nio.file.Path	The path to the file to render.

Viewer(String filePath, LoadOptions loadOptions)

public Viewer(String filePath, LoadOptions loadOptions)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The path to the file to render.
loadOptions	LoadOptions	The document load options.

Viewer(Path filePath, LoadOptions loadOptions)

public Viewer(Path filePath, LoadOptions loadOptions)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view a document with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
filePath	java.nio.file.Path	The path to the file to render.
loadOptions	LoadOptions	The document load options.

Viewer(String filePath, ViewerSettings settings)

public Viewer(String filePath, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The path to the file to render.
settings	ViewerSettings	The Viewer settings.

Viewer(Path filePath, ViewerSettings settings)

public Viewer(Path filePath, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

Parameter	Type	Description
filePath	java.nio.file.Path	The path to the file to render.
settings	ViewerSettings	The Viewer settings.

Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)

public Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view documents with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The path to the file to render.
loadOptions	LoadOptions	The document load options.
settings	ViewerSettings	The Viewer settings.

Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)

public Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
More about GroupDocs.Viewer for Java features: Developer Guide
More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view documents with GroupDocs.Viewer

Parameters:

Parameter	Type	Description
filePath	java.nio.file.Path	The path to the file to render.
loadOptions	LoadOptions	The document load options.
settings	ViewerSettings	The Viewer settings.

LOAD_OPTIONS

public static final String LOAD_OPTIONS

SETTINGS

public static final String SETTINGS

FILE_READER

public static final String FILE_READER

OPTIONS

public static final String OPTIONS

getViewInfo(ViewInfoOptions options)

public final ViewInfo getViewInfo(ViewInfoOptions options)

Returns information about the view and document specific information.

Learn more:

Learn more about the document - file type, page count, and other format specific properties: How to get file information using GroupDocs.Viewer

Parameters:

Parameter	Type	Description
options	ViewInfoOptions	The view info options.

Returns: ViewInfo - Information about the view and document specific information.

getAttachments()

public final List<Attachment> getAttachments()

Returns attachments contained by the document.

Learn more:

Learn more about getting document attachments in Java: How to get a list of document attachments using GroupDocs.Viewer
Learn more about saving document attachments in Java: How to save document attachments using GroupDocs.Viewer

Returns: java.util.List<com.groupdocs.viewer.results.Attachment> - attachments contained by the document.

saveAttachment(Attachment attachment, OutputStream destination)

public void saveAttachment(Attachment attachment, OutputStream destination)

Saves an attachment file to the destination stream.

Learn more:

Learn more about getting document attachments in Java: How to get a list of document attachments using GroupDocs.Viewer
Learn more about saving document attachments in Java: How to save document attachments using GroupDocs.Viewer

Parameters:

Parameter	Type	Description
attachment	Attachment	The attachment.
destination	java.io.OutputStream	The writable stream.

view(ViewOptions options)

public final void view(ViewOptions options)

Creates a view of all document pages.

Learn more

Learn more about different viewing options following this guide: How to customize document viewing output using GroupDocs.Viewer

Parameters:

Parameter	Type	Description
options	ViewOptions	The view options.

view(ViewOptions options, int[] pageNumbers)

public final void view(ViewOptions options, int[] pageNumbers)

Creates a view of specific document pages.

Learn more

Learn more about different viewing options following this guide: How to customize document viewing output using GroupDocs.Viewer

Parameters:

Parameter	Type	Description
options	ViewOptions	The view options.
pageNumbers	int[]	The page numbers to view.

getAllFonts()

public IFontInfo[] getAllFonts()

Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document.

For details, see the documentation.

Returns: com.groupdocs.viewer.fonts.IFontInfo[] - Non-null list of all fonts used in the document loaded into this Viewer instance.

search(SearchHighlightOptions options)

public void search(SearchHighlightOptions options)

Performs a text search and highlights matches (if found) in the loaded document according to the provided options.

Parameters:

Parameter	Type	Description
options	com.groupdocs.viewer.options.SearchHighlightOptions	Search and highlight options, including a text phrase to search. Cannot be null .

getFileInfo()

public FileInfo getFileInfo()

Returns information about the file, such as file type and a flag that indicates if the file is encrypted.

Learn more:

Learn more about how to check if a file is encrypted: How to check if a file is encrypted

Returns: FileInfo - the file information.

close()

public final void close()

Releases the file stream and managed internal resources.

Java: ViewerSettings

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

public class ViewerSettings

Defines settings for customizing the behavior of the Viewer component.

The ViewerSettings class provides options and properties to customize the behavior of the GroupDocs.Viewer component during the document rendering process. You can use this class to specify various settings, such as logger, custom cache implementation, and more.

Example usage:


 final ViewerSettings viewerSettings = new ViewerSettings();
 viewerSettings.setLogger(new ConsoleLogger(false, true));

 try (Viewer viewer = new Viewer("source.pdf", viewerSettings)) {
     // Document processing
 }

Constructors

Constructor	Description
ViewerSettings(Cache cache, ILogger logger)	Initializes a new instance of the ViewerSettings class.
ViewerSettings(ILogger logger)	Initializes a new instance of the ViewerSettings class.
ViewerSettings(Cache cache)	Initializes a new instance of the ViewerSettings class.
ViewerSettings()	Initializes a new instance of the ViewerSettings class.

Methods

Method	Description
getLogger()	Gets the logger implementation used for logging (Errors, Warnings, Traces).
setLogger(ILogger logger)	Sets the logger implementation used for logging (Errors, Warnings, Traces).
getCache()	Gets the cache implementation used for storing rendering results.
setCache(Cache cache)	Sets the cache implementation used for storing rendering results.

ViewerSettings(Cache cache, ILogger logger)

public ViewerSettings(Cache cache, ILogger logger)

Initializes a new instance of the ViewerSettings class.

Parameters:

Parameter	Type	Description
cache	Cache	The cache.
logger	com.groupdocs.foundation.logging.ILogger	The logger.

ViewerSettings(ILogger logger)

public ViewerSettings(ILogger logger)

Initializes a new instance of the ViewerSettings class.

Parameters:

Parameter	Type	Description
logger	com.groupdocs.foundation.logging.ILogger	The logger.

ViewerSettings(Cache cache)

public ViewerSettings(Cache cache)

Initializes a new instance of the ViewerSettings class.

Parameters:

Parameter	Type	Description
cache	Cache	The cache.

ViewerSettings()

public ViewerSettings()

Initializes a new instance of the ViewerSettings class.

getLogger()

public ILogger getLogger()

Gets the logger implementation used for logging (Errors, Warnings, Traces).

Returns: com.groupdocs.foundation.logging.ILogger - the logger implementation.

setLogger(ILogger logger)

public void setLogger(ILogger logger)

Sets the logger implementation used for logging (Errors, Warnings, Traces).

Parameters:

Parameter	Type	Description
logger	com.groupdocs.foundation.logging.ILogger	The logger implementation to set.

getCache()

public final Cache getCache()

Gets the cache implementation used for storing rendering results.

Returns: Cache - the cache implementation.

setCache(Cache cache)

public void setCache(Cache cache)

Sets the cache implementation used for storing rendering results.

Parameters:

Parameter	Type	Description
cache	Cache	The cache implementation.

Java: FileType

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object, java.lang.Enum

All Implemented Interfaces: com.aspose.ms.System.IEquatable, com.groupdocs.viewer.caching.Cacheable

public enum FileType extends Enum<FileType> implements System.IEquatable<FileType>, Cacheable

Represents the file type. Provides methods to obtain a list of all file types supported by the GroupDocs.Viewer component.

The FileType enum provides constants representing different file types that are supported by the GroupDocs.Viewer component. You can use the methods in this enum to obtain a list of all supported file types or check if a specific file type is supported.

Example usage:


 // Try to detect file type using stream
 final FileType fileTypeFromStream = FileType.fromStream(new FileInputStream("document.pdf"));
 // Detect file type by extension
 final FileType fileTypeFromExtension = FileType.fromExtension(".png");
 // Iterate all supported file types
 for (FileType supportedFileType : FileType.getSupportedFileTypes()) {
     System.out.println("File type: " + supportedFileType);
 }
 final LoadOptions loadOptions = new LoadOptions(fileTypeFromExtension);
 // Usage of loadOptions

Fields

Field	Description
UNKNOWN	Represents an unknown file type.
ZIP	Represents a zipped file (.zip) that can hold one or more files or directories.
TAR	Represents a consolidated Unix file archive (.tar) created for collecting one or more files.
XZ	Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm.
TXZ	Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files.
TARXZ	Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files.
TGZ	Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files.
TARGZ	Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files.
BZ_2	Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method.
RAR	Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method.
GZ	Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application.
GZIP	Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems.
SEVEN_ZIP	Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression.
CPIO	Cpio is a general file archiver utility and its associated file format.
ZSTANDARD	ZST file is a compressed file that is generated with the Zstandard (zstd) compression algorithm.
TZST	TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.
TAR_ZST	TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.
ISO	ISO optical disc image is an uncompressed archive disk image file that represents the contents of entire data on an optical disc such as CD or DVD, based on the ISO-9660 standard.
LHA	LHA or LZH is a freeware compression utility and associated file format.
CAB	Cabinet (or CAB) is an archive-file format for Microsoft Windows.
DXF	Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file.
DWG	Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data.
DWT	Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a starter for creating drawings that can be saved as DWG files.
STL	Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry.
IFC	Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties.
DWF	Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings.
FBX	Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format.
DWFX	Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document.
DGN	Represents a MicroStation Design File (.dgn), which are drawings created and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System.
PLT	Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc.
CF2	Represents a Common File Format File (.cf2).
OBJ	Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies.
HPG	Represents a PLT (HPGL) File (.hpg).
IGS	Represents an Initial Graphics Exchange Specification (IGES) File (.igs).
VSD	Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections.
VSDX	Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards.
VSS	Represents a Visio Stencil File (.vss), which are stencil files created with Microsoft Visio 2007 and earlier.
VSSX	Represents a Visio Stencil File (.vssx), which are drawing stencils created with Microsoft Visio 2013 and above.
VSDM	Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support macros.
VST	Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio.
VSTX	Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above.
VSTM	Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros.
VSSM	Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros.
VSX	Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio.
VTX	Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format.
VDW	Represents a Visio Web Drawing (.vdw), which specifies the streams and storages required for rendering a web drawing.
VDX	Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension.
EPUB	Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers.
MOBI	Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats.
AZW_3	Amazon Kindle Format 8 (KF8) ebook is the digital file format developed for Amazon Kindle devices.
MSG	Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks.
EML	Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications.
EMLX	Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple.
PST	Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information.
OST	Represents an Outlook Offline Data File (.ost), which represents a user’s mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook.
TIF	Represents a Tagged Image File (.tif), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
TIFF	Represents a Tagged Image File Format (.tiff), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard.
JPG	Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression.
JPEG	Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression.
JFIF	JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms.
PNG	Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression.
GIF	Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image.
APNG	Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation.
BMP	Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images.
ICO	Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows.
TGA	Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION.
JP_2	Represents a JPEG 2000 Core Image File (.jp2), which is an image coding system and state-of-the-art image compression standard.
JPF	Represents a JPEG 2000 Image File (.jpf).
JPX	Represents a JPEG 2000 Image File (.jpx).
JPM	Represents a JPEG 2000 Image File (.jpm).
J2C	Represents a JPEG 2000 Code InputStream (.j2c).
J2K	Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression.
JPC	Represents a JPEG 2000 Code Stream (.jpc).
JLS	Represents a JPEG-LS (JLS) file (.jls).
DIB	Represents a Device Independent Bitmap File (.dib).
WMF	Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data.
WMZ	Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data.
EMF	Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently.
EMZ	Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP.
WEBP	Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression.
DNG	Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files.
CDR	Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images.
CMX	Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics.
DJVU	Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs.
CGM	Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text.
PCL	Represents a Printer Command Language Document (.pcl).
PSD	Represents an Adobe Photoshop Document (.psd), which is Adobe Photoshop’s native file format used for graphics designing and development.
PSB	Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop.
DCM	Represents a DICOM Image (.dcm), which represents a digital image that stores medical information of patients such as MRIs, CT scans, and ultrasound images.
PS	Represents a PostScript File (.ps).
EPS	Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page.
ODG	Represents an OpenDocument Graphic File (.odg), which is used by Apache OpenOffice’s Draw application to store drawing elements as a vector image.
FODG	Represents a Flat XML ODF Template (.fodg), which is used by Apache OpenOffice’s Draw application to store drawing elements as a vector image.
SVG	Represents a Scalable Vector Graphics File (.svg), which is a Scalar Vector Graphics file that uses XML-based text format for describing the appearance of an image.
SVGZ	Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image.
OTG	Represents an OpenDocument Graphic Template (.otg).
HTM	Represents a Hypertext Markup Language File (.htm), which is the extension for web pages created for display in browsers.
HTML	Represents a Hypertext Markup Language File (.html), which is the extension for web pages created for display in browsers.
MHT	Represents an MHTML Web Archive (.mht).
NSF	Represents a Lotus Notes Database (.nsf).
MBOX	Represents an Email Mailbox File (.mbox).
MHTML	Represents a MIME HTML File (.mhtml).
XML	Represents an XML File (.xml).
ONE	Represents a OneNote Document (.one) created by Microsoft OneNote application.
PDF	Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s.
XPS	Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft.
OXPS	Represents an OpenXPS File (.oxps).
TEX	Represents a LaTeX Source Document (.tex), which is a language that comprises programming as well as mark-up features used to typeset documents.
PPT	Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a slideshow.
PPTX	Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application.
PPS	Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes.
PPSX	Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes.
ODP	Represents an OpenDocument Presentation (.odp), which represents a presentation file format used by OpenOffice.org in the OASISOpen standard.
FODP	Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation.
POT	Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions.
PPTM	Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions.
POTX	Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above.
POTM	Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros.
PPSM	Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a macro-enabled slide show file format created with Microsoft PowerPoint 2007 or higher.
OTP	Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format.
XLS	Represents an Excel Spreadsheet (.xls), which represents the Excel Binary File Format.
EXCEL_2003_XML	Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the Excel Binary File Format.
NUMBERS	Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format.
XLSX	Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007.
XLSM	Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros.
XLSB	Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format.
CSV	Represents a Comma Separated Values File (.csv), which represents plain text files that contain records of data with comma-separated values.
TSV	Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format.
ODS	Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user.
FODS	Represents an OpenDocument Flat XML Spreadsheet (.fods).
OTS	Represents an OpenDocument Spreadsheet Template (.ots).
XLAM	Represents a Microsoft Excel Add-in (.xlam).
XLTM	Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files.
XLT	Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite.
XLTX	Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates based on the Office OpenXML file format specifications.
SXC	Represents a StarOffice Calc Spreadsheet (.sxc).
MPP	Represents a Microsoft Project File (.mpp), which is a Microsoft Project data file that stores information related to project management in an integrated manner.
MPT	Represents a Microsoft Project Template (.mpt), which contains basic information and structure along with document settings for creating .MPP files.
MPX	Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring project information between Microsoft Project (MSP) and other applications that support the MPX file format, such as Primavera Project Planner, Sciforma, and Timerline Precision Estimating.
AS	Represents an ActionScript File (.as).
AS_3	Represents an ActionScript File (.as3).
ASM	Represents an Assembly Language Source Code File (.asm).
BAT	Represents a DOS Batch File (.bat).
C	Represents a C/C++ Source Code File (.c).
CC	Represents a C++ Source Code File (.cc).
CMAKE	Represents a CMake File (.cmake).
CPP	Represents a C++ Source Code File (.cpp).
CS	Represents a C# Source Code File (.cs), which is a source code file for the C# programming language.
VB	Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language.
CSS	Represents a Cascading Style Sheet (.css) file.
CXX	Represents a C++ Source Code File (.cxx).
DIFF	Represents a Patch File (.diff).
ERB	Represents a Ruby ERB Script (.erb).
GROOVY	Represents a Groovy Source Code File (.groovy).
H	Represents a C/C++/Objective-C Header File (.h).
HAML	Represents a Haml Source Code File (.haml).
HH	Represents a C++ Header File (.hh).
JAVA	Represents a Java Source Code File (.java).
JS	Represents a JavaScript File (.js).
JSON	Represents a JavaScript Object Notation File (.json).
LESS	Represents a LESS Style Sheet (.less) file.
LOG	Represents a Log File (.log).
M	Represents an Objective-C Implementation File (.m).
MAKE	Represents an Xcode Makefile Script (.make).
MD	Represents a Markdown Documentation File (.md).
ML	Represents an ML Source Code File (.ml).
MM	Represents an Objective-C++ Source File (.mm).
PHP	Represents a PHP Source Code File (.php).
PL	Represents a Perl Script (.pl).
PROPERTIES	Represents a Java Properties File (.properties).
PY	Represents a Python Script (.py).
RB	Represents a Ruby Source Code (.rb) file.
RST	Represents a reStructuredText File (.rst).
SASS	Represents a Syntactically Awesome StyleSheets File (.sass).
SCALA	Represents a Scala Source Code File (.scala).
SCM	Represents a Scheme Source Code File (.scm).
SCRIPT	Represents a Generic Script File (.script).
SH	Represents a Bash Shell Script (.sh).
SML	Represents a Standard ML Source Code File (.sml).
SQL	Represents a Structured Query Language Data File (.sql).
VIM	Represents a Vim Settings File (.vim).
YAML	Represents a YAML Document (.yaml).
DOC	Represents a Microsoft Word Document (.doc) file.
DOCX	Represents a Microsoft Word Open XML Document (.docx) file.
CHM	Represents a Microsoft Compiled HTML Help File (.chm).
DOCM	Represents a Word Open XML Macro-Enabled Document (.docm) file.
DOT	Represents a Word Document Template (.dot) file.
DOTX	Represents a Word Open XML Document Template (.dotx) file.
DOTM	Represents a Word Open XML Macro-Enabled Document Template (.dotm) file.
RTF	Represents a Rich Text Format File (.rtf).
TXT	Represents a Plain Text File (.txt).
ODT	Represents an OpenDocument Text Document (.odt).
OTT	Represents an OpenDocument Document Template (.ott).
VCF	Represents a vCard File (.vcf), which is a digital file format for storing contact information.
AI	Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings.
PSM1	Represents a PowerShell script module file (.psm1).
PS1	Represents a PowerShell script file (.ps1).
PSD1	Represents a PowerShell script module manifest file (.psd1).

Methods

Method	Description
values()
valueOf(String name)
fromExtension(String extension)	Maps a file extension to a file type.
fromFilePath(String filePath)	Extracts the file extension from a file name or file path and maps it to a file type.
fromMediaType(String mediaType)	Maps a file media type to a file type.
fromStream(InputStream stream)	Detects the file type by reading the file signature.
fromStream(InputStream stream, String password)	Detects the file type by reading the file signature.
fromStream(InputStream stream, ILogger logger)	Detects the file type by reading the file signature.
fromStream(InputStream stream, String password, ILogger logger)	Detects the file type by reading the file signature.
getSupportedFileTypes()	Retrieves the supported file types.
detectCharset(String filePath)	Attempts to detect text TXT, TSV, and CSV files charset by path.
detectCharset(InputStream stream)	Attempts to detect text TXT, TSV, and CSV file charset by stream.
getFileFormat()	Gets the name of the file format, e.g., “Microsoft Word Document”.
getExtension()	Gets the file extension suffix (including the period “.”), e.g., “.doc”.
toString()	Returns a string representation of the current object.

UNKNOWN

public static final FileType UNKNOWN

Represents an unknown file type.

ZIP

public static final FileType ZIP

Represents a zipped file (.zip) that can hold one or more files or directories. Learn more about this file format here.

TAR

public static final FileType TAR

Represents a consolidated Unix file archive (.tar) created for collecting one or more files. Learn more about this file format here.

XZ

public static final FileType XZ

Represents an XZ file (.xz) compressed using a high-ratio compression algorithm based on the LZMA algorithm. Learn more about this file format here.

TXZ

public static final FileType TXZ

Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format here.

TARXZ

public static final FileType TARXZ

Represents a consolidated Unix file archive (.txz, .tar.xz) created for collecting one or more files. Learn more about this file format here.

TGZ

public static final FileType TGZ

Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format here.

TARGZ

public static final FileType TARGZ

Represents a consolidated Unix file archive (.tgz, .tar.gz) created for collecting one or more files. Learn more about this file format here.

BZ_2

public static final FileType BZ_2

Represents a Bzip2 compressed file (.bz2) generated using the BZIP2 open-source compression method. Learn more about this file format here.

RAR

public static final FileType RAR

Represents a Roshal Archive (.rar) compressed file generated using the RAR (WINRAR version 4) compression method. Learn more about this file format here.

GZ

public static final FileType GZ

Represents a Gnu Zipped File (.gz) compressed file created with the gzip compression application. Learn more about this file format here.

GZIP

public static final FileType GZIP

Represents a Gnu Zipped File (.gzip) compressed file introduced as a free utility for replacing the Compress program used in Unix systems. Learn more about this file format here.

SEVEN_ZIP

public static final FileType SEVEN_ZIP

Represents a 7Zip (.7z, .7zip) file, which is a free open-source archiver with LZMA and LZMA2 compression. Learn more about this file format here.

CPIO

public static final FileType CPIO

Cpio is a general file archiver utility and its associated file format. It is primarily installed on Unix-like computer operating systems. Learn more about this file format here.

ZSTANDARD

public static final FileType ZSTANDARD

ZST file is a compressed file that is generated with the Zstandard (zstd) compression algorithm. It is a compressed file that is created with lossless compression by the algorithm. ZST files can be used to compress different types of files such as databases, file systems, networks, and games. Learn more about this file format here.

TZST

public static final FileType TZST

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

TAR_ZST

public static final FileType TAR_ZST

TZST files (.tar.zst, .tzst) are Zstandard archives (ZST), which internally contain a Consolidated Unix File Archive (Tar), created with Unix-based utility for collecting one or more files.

ISO

public static final FileType ISO

ISO optical disc image is an uncompressed archive disk image file that represents the contents of entire data on an optical disc such as CD or DVD, based on the ISO-9660 standard. Learn more about this file format here.

LHA

public static final FileType LHA

LHA or LZH is a freeware compression utility and associated file format. Learn more about this file format here.

CAB

public static final FileType CAB

Cabinet (or CAB) is an archive-file format for Microsoft Windows. Learn more about this file format here.

DXF

public static final FileType DXF

Represents a Drawing Exchange Format File (.dxf), which is a tagged data representation of an AutoCAD drawing file. Learn more about this file format here.

DWG

public static final FileType DWG

Represents an AutoCAD Drawing Database File (.dwg), which represents proprietary binary files used for containing 2D and 3D design data. Learn more about this file format here.

DWT

public static final FileType DWT

Represents an AutoCAD Drawing Template (.dwt), which is an AutoCAD drawing template file used as a starter for creating drawings that can be saved as DWG files. Learn more about this file format here.

STL

public static final FileType STL

Represents a Stereolithography File (.stl), which is an interchangeable file format that represents 3-dimensional surface geometry. It is commonly used in rapid prototyping, 3D printing, and computer-aided manufacturing. Learn more about this file format here.

IFC

public static final FileType IFC

Represents an Industry Foundation Classes File (.ifc), which is a file format that establishes international standards for importing and exporting building objects and their properties. It enables interoperability between different software applications. Learn more about this file format here.

DWF

public static final FileType DWF

Represents a Design Web Format File (.dwf), which is a compressed file format for viewing, reviewing, or printing 2D/3D drawings. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format here.

FBX

public static final FileType FBX

Represents an Autodesk FBX Interchange File (FilmBoX) (.fbx), which is a 3D model format. Learn more about this file format here.

DWFX

public static final FileType DWFX

Represents a Design Web Format File XPS (.dwfx), which is a compressed format for viewing, reviewing, or printing 2D/3D drawings as an XPS document. It contains graphics and text as part of the design data and reduces the file size due to compression. Learn more about this file format here.

DGN

public static final FileType DGN

Represents a MicroStation Design File (.dgn), which are drawings created and supported by CAD applications such as MicroStation and Intergraph Interactive Graphics Design System. Learn more about this file format here.

PLT

public static final FileType PLT

Represents a PLT (HPGL) File (.plt), which is a vector-based plotter file introduced by Autodesk, Inc. It contains information for a certain CAD file, and all images are printed using lines instead of dots, ensuring accuracy and precision in production. Learn more about this file format here.

CF2

public static final FileType CF2

Represents a Common File Format File (.cf2). Learn more about this file format here.

OBJ

public static final FileType OBJ

Represents a Wavefront 3D Object File (.obj), which is a 3D image file introduced by Wavefront Technologies. Learn more about this file format here.

HPG

public static final FileType HPG

Represents a PLT (HPGL) File (.hpg). It is a file format used for plotter files in the HP Graphics Language (HPGL). Learn more about this file format here.

IGS

public static final FileType IGS

Represents an Initial Graphics Exchange Specification (IGES) File (.igs).

VSD

public static final FileType VSD

Represents a Visio Drawing File (.vsd), which are drawings created with Microsoft Visio application to represent a variety of graphical objects and their interconnections. Learn more about this file format here.

VSDX

public static final FileType VSDX

Represents a Visio Drawing File (.vsdx), which represents the Microsoft Visio file format introduced from Microsoft Office 2013 onwards. It replaced the binary file format (.VSD) supported by earlier versions of Microsoft Visio. Learn more about this file format here.

VSS

public static final FileType VSS

Represents a Visio Stencil File (.vss), which are stencil files created with Microsoft Visio 2007 and earlier. Stencil files provide drawing objects that can be included in a .VSD Visio drawing. Learn more about this file format here.

VSSX

public static final FileType VSSX

Represents a Visio Stencil File (.vssx), which are drawing stencils created with Microsoft Visio 2013 and above. The VSSX file format can be opened with Visio 2013 and above. Visio files are known for representing a variety of drawing elements such as shapes, connectors, flowcharts, network layout, UML diagrams, etc. Learn more about this file format here.

VSDM

public static final FileType VSDM

Represents a Visio Macro-Enabled Drawing (.vsdm), which are drawing files created with Microsoft Visio application that support macros. VSDM files are OPC/XML drawings that are similar to VSDX, but also provide the capability to run macros when the file is opened. Learn more about this file format here.

VST

public static final FileType VST

Represents a Visio Drawing Template (.vst), which are vector image files created with Microsoft Visio. They act as templates for creating further files and contain the default layout and settings used for creating new Visio drawings. Learn more about this file format here.

VSTX

public static final FileType VSTX

Represents a Visio Drawing Template (.vstx), which are drawing template files created with Microsoft Visio 2013 and above. These VSTX files provide a starting point for creating Visio drawings saved as .VSDX files, with default layout and settings. Learn more about this file format here.

VSTM

public static final FileType VSTM

Represents a Visio Macro-Enabled Drawing Template (.vstm), which are template files created with Microsoft Visio that support macros. Files created from VSTM templates can run macros developed in Visual Basic for Applications (VBA) code. Learn more about this file format here.

VSSM

public static final FileType VSSM

Represents a Visio Macro-Enabled Stencil File (.vssm), which are Microsoft Visio Stencil files that support macros. When a VSSM file is opened, macros can be run to achieve desired formatting and placement of shapes in a diagram. Learn more about this file format here.

VSX

public static final FileType VSX

Represents a Visio Stencil XML File (.vsx), which refers to stencils consisting of drawings and shapes used for creating diagrams in Microsoft Visio. VSX files are saved in XML file format and were supported until Visio 2013. Learn more about this file format here.

VTX

public static final FileType VTX

Represents a Visio Template XML File (.vtx), which is a Microsoft Visio drawing template saved to disk in XML file format. The template provides basic settings for creating multiple Visio files with the same settings. Learn more about this file format here.

VDW

public static final FileType VDW

Represents a Visio Web Drawing (.vdw), which specifies the streams and storages required for rendering a web drawing. Learn more about this file format here.

VDX

public static final FileType VDX

Represents a Visio Drawing XML File (.vdx), which represents any drawing or chart created in Microsoft Visio but saved in XML format with the .VDX extension. A Visio drawing XML file is created in the Visio software developed by Microsoft. Learn more about this file format here.

EPUB

public static final FileType EPUB

Represents an Open eBook File (.epub), which is an e-book file format that provides a standard digital publication format for publishers and consumers. The format is supported by many e-readers and software applications. Learn more about this file format here.

MOBI

public static final FileType MOBI

Represents a Mobipocket eBook (.mobi), which is one of the most widely used ebook file formats. The format is an enhancement to the old OEB (Open Ebook Format) format and was used as a proprietary format for Mobipocket Reader. Learn more about this file format here.

AZW_3

public static final FileType AZW_3

Amazon Kindle Format 8 (KF8) ebook is the digital file format developed for Amazon Kindle devices. The format is an enhancement to older AZW files and is used on Kindle Fire devices only with backward compatibility for the ancestor file format i.e. MOBI and AZW. Learn more about this file format here.

MSG

public static final FileType MSG

Represents an Outlook Mail Message (.msg), which is a file format used by Microsoft Outlook and Exchange to store email messages, contacts, appointments, or other tasks. Learn more about this file format here.

EML

public static final FileType EML

Represents an E-Mail Message (.eml), which represents email messages saved using Outlook and other relevant applications. Almost all email clients support this file format due to its compliance with the RFC-822 Internet Message Format Standard. Learn more about this file format here.

EMLX

public static final FileType EMLX

Represents an Apple Mail Message (.emlx), which is implemented and developed by Apple. The Apple Mail application uses the EMLX file format for exporting emails. Learn more about this file format here.

PST

public static final FileType PST

Represents an Outlook Personal Information Store File (.pst), which represents Outlook Personal Storage Files (also called Personal Storage Table) that store a variety of user information. Learn more about this file format here.

OST

public static final FileType OST

Represents an Outlook Offline Data File (.ost), which represents a user’s mailbox data in offline mode on a local machine upon registration with Exchange Server using Microsoft Outlook. Learn more about this file format here.

TIF

public static final FileType TIF

Represents a Tagged Image File (.tif), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color, and full-color image data in several color spaces. Learn more about this file format here.

TIFF

public static final FileType TIFF

Represents a Tagged Image File Format (.tiff), which represents raster images that are meant for usage on a variety of devices that comply with this file format standard. It is capable of describing bilevel, grayscale, palette-color, and full-color image data in several color spaces. Learn more about this file format here.

JPG

public static final FileType JPG

Represents a JPEG Image (.jpg), which is a type of image format that is saved using the method of lossy compression. The output image, as a result of compression, is a trade-off between storage size and image quality. Learn more about this file format here.

JPEG

public static final FileType JPEG

Represents a JPEG Image (.jpeg), which is a type of image format that is saved using the method of lossy compression. The output image, as a result of compression, is a trade-off between storage size and image quality. Learn more about this file format here.

JFIF

public static final FileType JFIF

JPEG File Interchange Format (.jfif) is image that was developed for fast exchange between platforms. This format uses JPEG compression.Learn more about this file format here.

PNG

public static final FileType PNG

Represents a Portable Network Graphic (.png), which is a type of raster image file format that uses lossless compression. This file format was created as a replacement for the Graphics Interchange Format (GIF) and has no copyright limitations. Learn more about this file format here.

GIF

public static final FileType GIF

Represents a Graphical Interchange Format File (.gif), which is a type of highly compressed image. For each image, GIF typically allows up to 8 bits per pixel, and up to 256 colors are allowed across the image. Learn more about this file format here.

APNG

public static final FileType APNG

Represents an Animated Portable Network Graphic (.apng), which is an extension of the PNG format that supports animation. Learn more about this file format here.

BMP

public static final FileType BMP

Represents a Bitmap Image File (.bmp), which is used to store bitmap digital images. These images are independent of the graphics adapter and are also called device independent bitmap (DIB) file format. Learn more about this file format here.

ICO

public static final FileType ICO

Represents an Icon File (.ico), which is an image file type used as an icon for the representation of an application on Microsoft Windows. Learn more about this file format here.

TGA

public static final FileType TGA

Represents a Truevision TGA (TARGA) file, which is used to store bitmap digital images developed by TRUEVISION. Learn more about this file format here.

JP_2

public static final FileType JP_2

Represents a JPEG 2000 Core Image File (.jp2), which is an image coding system and state-of-the-art image compression standard. Learn more about this file format here.

JPF

public static final FileType JPF

Represents a JPEG 2000 Image File (.jpf). Learn more about this file format here.

JPX

public static final FileType JPX

Represents a JPEG 2000 Image File (.jpx). Learn more about this file format here.

JPM

public static final FileType JPM

Represents a JPEG 2000 Image File (.jpm). Learn more about this file format here.

J2C

public static final FileType J2C

Represents a JPEG 2000 Code InputStream (.j2c). Learn more about this file format here.

J2K

public static final FileType J2K

Represents a JPEG 2000 Code Stream (.j2k), which is an image compressed using wavelet compression instead of DCT compression. Learn more about this file format here.

JPC

public static final FileType JPC

Represents a JPEG 2000 Code Stream (.jpc). Learn more about this file format here.

JLS

public static final FileType JLS

Represents a JPEG-LS (JLS) file (.jls). Learn more about this file format here.

DIB

public static final FileType DIB

Represents a Device Independent Bitmap File (.dib). Learn more about this file format here.

WMF

public static final FileType WMF

Represents a Windows Metafile (.wmf), which represents Microsoft Windows Metafile (WMF) for storing vector as well as bitmap-format image data. Learn more about this file format here.

WMZ

public static final FileType WMZ

Represents a Compressed Windows Metafile (.wmz), which represents Microsoft Windows Metafile (WMF) compressed in GZIP archive for storing vector as well as bitmap-format image data. Learn more about this file format here.

EMF

public static final FileType EMF

Represents an Enhanced Windows Metafile (.emf), which represents graphical images device-independently. Metafiles of EMF comprise variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format here.

EMZ

public static final FileType EMZ

Represents a Windows Compressed Enhanced Metafile (.emz), which represents graphical images device-independently compressed by GZIP. Metafiles of EMF comprise variable-length records in chronological order that can render the stored image after parsing on any output device. Learn more about this file format here.

WEBP

public static final FileType WEBP

Represents a WebP Image (.webp), which is a modern raster web image file format based on lossless and lossy compression. It provides the same image quality while considerably reducing the image size. Learn more about this file format here.

DNG

public static final FileType DNG

Represents a Digital Negative Specification (.dng), which is a digital camera image format used for the storage of raw files. It was developed by Adobe in September 2004 and is primarily used for digital photography. Learn more about this file format here.

CDR

public static final FileType CDR

Represents a CorelDraw Vector Graphic Drawing (.cdr), which is a vector drawing image file natively created with CorelDRAW for storing digitally encoded and compressed images. A CDR drawing file contains text, lines, shapes, images, colors, and effects for vector representation of image contents. Learn more about this file format here.

CMX

public static final FileType CMX

Represents a Corel Exchange (.cmx), which is a drawing image file that may contain vector graphics as well as bitmap graphics. Learn more about this file format here.

DJVU

public static final FileType DJVU

Represents a DjVu Image (.djvu), which is a graphics file format intended for scanned documents and books, especially those containing a combination of text, drawings, images, and photographs. Learn more about this file format here.

CGM

public static final FileType CGM

Represents a Computer Graphics Metafile (.cgm), which is a free, platform-independent, international standard metafile format for storing and exchanging vector graphics (2D), raster graphics, and text. CGM uses an object-oriented approach and provides many functions for image production. Learn more about this file format here.

PCL

public static final FileType PCL

Represents a Printer Command Language Document (.pcl). Learn more about this file format here.

PSD

public static final FileType PSD

Represents an Adobe Photoshop Document (.psd), which is Adobe Photoshop’s native file format used for graphics designing and development. Learn more about this file format here.

PSB

public static final FileType PSB

Represents a Photoshop Large Document Format (.psb), which is used for graphics designing and development in Adobe Photoshop. Learn more about this file format here.

DCM

public static final FileType DCM

Represents a DICOM Image (.dcm), which represents a digital image that stores medical information of patients such as MRIs, CT scans, and ultrasound images. Learn more about this file format here.

PS

public static final FileType PS

Represents a PostScript File (.ps). Learn more about this file format here.

EPS

public static final FileType EPS

Represents an Encapsulated PostScript File (.eps), which describes an Encapsulated PostScript language program that defines the appearance of a single page. Learn more about this file format here.

ODG

public static final FileType ODG

Represents an OpenDocument Graphic File (.odg), which is used by Apache OpenOffice’s Draw application to store drawing elements as a vector image. Learn more about this file format here.

FODG

public static final FileType FODG

Represents a Flat XML ODF Template (.fodg), which is used by Apache OpenOffice’s Draw application to store drawing elements as a vector image. Learn more about this file format here.

SVG

public static final FileType SVG

Represents a Scalable Vector Graphics File (.svg), which is a Scalar Vector Graphics file that uses XML-based text format for describing the appearance of an image. Learn more about this file format here.

SVGZ

public static final FileType SVGZ

Represents a Compressed Scalable Vector Graphics File (.svgz), which is a Scalar Vector Graphics file that uses XML-based text format, compressed by GZIP, for describing the appearance of an image. Learn more about this file format here.

OTG

public static final FileType OTG

Represents an OpenDocument Graphic Template (.otg). Learn more about this file format here.

HTM

public static final FileType HTM

Represents a Hypertext Markup Language File (.htm), which is the extension for web pages created for display in browsers. Learn more about this file format here.

HTML

public static final FileType HTML

Represents a Hypertext Markup Language File (.html), which is the extension for web pages created for display in browsers. Learn more about this file format here.

MHT

public static final FileType MHT

Represents an MHTML Web Archive (.mht). Learn more about this file format here.

NSF

public static final FileType NSF

Represents a Lotus Notes Database (.nsf). Learn more about this file format here.

MBOX

public static final FileType MBOX

Represents an Email Mailbox File (.mbox). Learn more about this file format here.

MHTML

public static final FileType MHTML

Represents a MIME HTML File (.mhtml). Learn more about this file format here.

XML

public static final FileType XML

Represents an XML File (.xml). Learn more about this file format here.

ONE

public static final FileType ONE

Represents a OneNote Document (.one) created by Microsoft OneNote application. OneNote lets you gather information using the application as if you are using your draftpad for taking notes. Learn more about this file format here.

PDF

public static final FileType PDF

Represents a Portable Document Format File (.pdf), which is a type of document created by Adobe back in the 1990s. The purpose of this file format was to introduce a standard for the representation of documents and other reference material in a format that is independent of application software, hardware, and operating systems. Learn more about this file format here.

XPS

public static final FileType XPS

Represents an XML Paper Specification File (.xps), which represents page layout files based on XML Paper Specifications created by Microsoft. This format was developed by Microsoft as a replacement for the EMF file format and is similar to the PDF file format, but uses XML in the layout, appearance, and printing information of a document. Learn more about this file format here.

OXPS

public static final FileType OXPS

Represents an OpenXPS File (.oxps). Learn more about this file format here.

TEX

public static final FileType TEX

Represents a LaTeX Source Document (.tex), which is a language that comprises programming as well as mark-up features used to typeset documents. Learn more about this file format here.

PPT

public static final FileType PPT

Represents a PowerPoint Presentation (.ppt), which represents a PowerPoint file that consists of a collection of slides for displaying as a slideshow. It specifies the Binary File Format used by Microsoft PowerPoint 97-2003. Learn more about this file format here.

PPTX

public static final FileType PPTX

Represents a PowerPoint Open XML Presentation (.pptx), which are presentation files created with the popular Microsoft PowerPoint application. Unlike the previous version of the presentation file format PPT, which was binary, the PPTX format is based on the Microsoft PowerPoint Open XML presentation file format. Learn more about this file format here.

PPS

public static final FileType PPS

Represents a PowerPoint Slide Show (.pps), which are created using Microsoft PowerPoint for Slide Show purposes. PPS file reading and creation are supported by Microsoft PowerPoint 97-2003. Learn more about this file format here.

PPSX

public static final FileType PPSX

Represents a PowerPoint Open XML Slide Show (.ppsx) files, which are created using Microsoft PowerPoint 2007 and above for Slide Show purposes. Learn more about this file format here.

ODP

public static final FileType ODP

Represents an OpenDocument Presentation (.odp), which represents a presentation file format used by OpenOffice.org in the OASISOpen standard. Learn more about this file format here.

FODP

public static final FileType FODP

Represents an OpenDocument Presentation (.fodp), which represents OpenDocument Flat XML Presentation. Learn more about this file format here.

POT

public static final FileType POT

Represents a PowerPoint Template (.pot), which represents Microsoft PowerPoint template files created by PowerPoint 97-2003 versions. Learn more about this file format here.

PPTM

public static final FileType PPTM

Represents a PowerPoint Open XML Macro-Enabled Presentation (.pptm), which are macro-enabled presentation files created with Microsoft PowerPoint 2007 or higher versions. Learn more about this file format here.

POTX

public static final FileType POTX

Represents a PowerPoint Open XML Presentation Template (.potx), which represents Microsoft PowerPoint template presentations created with Microsoft PowerPoint 2007 and above. Learn more about this file format here.

POTM

public static final FileType POTM

Represents a PowerPoint Open XML Macro-Enabled Presentation Template (.potm), which are Microsoft PowerPoint template files with support for macros. POTM files are created with PowerPoint 2007 or above and contain default settings that can be used to create further presentation files. Learn more about this file format here.

PPSM

public static final FileType PPSM

Represents a PowerPoint Open XML Macro-Enabled Slide (.ppsm), which represents a macro-enabled slide show file format created with Microsoft PowerPoint 2007 or higher. Learn more about this file format here.

OTP

public static final FileType OTP

Represents an OpenDocument Presentation Template (.otp), which represents presentation template files created by applications in the OASIS OpenDocument standard format. Learn more about this file format here.

XLS

public static final FileType XLS

Represents an Excel Spreadsheet (.xls), which represents the Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format here.

EXCEL_2003_XML

public static final FileType EXCEL_2003_XML

Represents an Excel 2003 XML (SpreadsheetML) (.xml), which represents the Excel Binary File Format. Such files can be created by Microsoft Excel as well as other similar spreadsheet programs such as OpenOffice Calc or Apple Numbers. Learn more about this file format here.

NUMBERS

public static final FileType NUMBERS

Represents Apple Numbers (.numbers), which represents an Excel-like Binary File Format. Such files can be created by Apple Numbers application. Learn more about this file format here.

XLSX

public static final FileType XLSX

Represents a Microsoft Excel Open XML Spreadsheet (.xlsx), which is a well-known format for Microsoft Excel documents that was introduced by Microsoft with the release of Microsoft Office 2007. Learn more about this file format here.

XLSM

public static final FileType XLSM

Represents an Excel Open XML Macro-Enabled Spreadsheet (.xlsm), which is a type of spreadsheet file that supports macros. Learn more about this file format here.

XLSB

public static final FileType XLSB

Represents an Excel Binary Spreadsheet (.xlsb), which specifies the Excel Binary File Format. It is a collection of records and structures that specify Excel workbook content. Learn more about this file format here.

CSV

public static final FileType CSV

Represents a Comma Separated Values File (.csv), which represents plain text files that contain records of data with comma-separated values. Learn more about this file format here.

TSV

public static final FileType TSV

Represents a Tab Separated Values File (.tsv), which represents data separated with tabs in plain text format. Learn more about this file format here.

ODS

public static final FileType ODS

Represents an OpenDocument Spreadsheet (.ods), which stands for OpenDocument Spreadsheet Document format that is editable by the user. Data is stored inside ODF files in rows and columns. Learn more about this file format here.

FODS

public static final FileType FODS

Represents an OpenDocument Flat XML Spreadsheet (.fods). It is a spreadsheet document format based on XML used by OpenOffice and LibreOffice. Learn more about this file format here.

OTS

public static final FileType OTS

Represents an OpenDocument Spreadsheet Template (.ots). It is a template document format used by OpenOffice and LibreOffice for spreadsheets. Learn more about this file format here.

XLAM

public static final FileType XLAM

Represents a Microsoft Excel Add-in (.xlam). It is a file format used by Microsoft Excel to create add-ins with custom functionality. Learn more about this file format here.

XLTM

public static final FileType XLTM

Represents a Microsoft Excel Macro-Enabled Template (.xltm), which represents files generated by Microsoft Excel as Macro-enabled template files. XLTM files are similar to XLTX in structure except that the latter doesn’t support creating template files with macros. Learn more about this file format here.

XLT

public static final FileType XLT

Represents a Microsoft Excel Template (.xlt), which are template files created with Microsoft Excel, a spreadsheet application that comes as part of the Microsoft Office suite. Microsoft Office 97-2003 supported creating new XLT files as well as opening them. Learn more about this file format here.

XLTX

public static final FileType XLTX

Represents an Excel Open XML Spreadsheet Template (.xltx), which represents Microsoft Excel Templates based on the Office OpenXML file format specifications. It is used to create a standard template file that can be utilized to generate XLSX files with the same settings specified in the XLTX file. Learn more about this file format here.

SXC

public static final FileType SXC

Represents a StarOffice Calc Spreadsheet (.sxc). It is a spreadsheet document created with StarOffice Calc, a spreadsheet program. Learn more about this file format here.

MPP

public static final FileType MPP

Represents a Microsoft Project File (.mpp), which is a Microsoft Project data file that stores information related to project management in an integrated manner. Learn more about this file format here.

MPT

public static final FileType MPT

Represents a Microsoft Project Template (.mpt), which contains basic information and structure along with document settings for creating .MPP files. Learn more about this file format here.

MPX

public static final FileType MPX

Represents a Microsoft Project Exchange file (.mpx), which is an ASCII file format for transferring project information between Microsoft Project (MSP) and other applications that support the MPX file format, such as Primavera Project Planner, Sciforma, and Timerline Precision Estimating. Learn more about this file format here.

AS

public static final FileType AS

Represents an ActionScript File (.as). Learn more about this file format here.

AS_3

public static final FileType AS_3

Represents an ActionScript File (.as3). Learn more about this file format here.

ASM

public static final FileType ASM

Represents an Assembly Language Source Code File (.asm). Learn more about this file format here.

BAT

public static final FileType BAT

Represents a DOS Batch File (.bat). Learn more about this file format here.

C

public static final FileType C

Represents a C/C++ Source Code File (.c). Learn more about this file format here.

CC

public static final FileType CC

Represents a C++ Source Code File (.cc). Learn more about this file format here.

CMAKE

public static final FileType CMAKE

Represents a CMake File (.cmake). Learn more about this file format here.

CPP

public static final FileType CPP

Represents a C++ Source Code File (.cpp). Learn more about this file format here.

CS

public static final FileType CS

Represents a C# Source Code File (.cs), which is a source code file for the C# programming language. It was introduced by Microsoft for use with the .NET Framework. Learn more about this file format here.

VB

public static final FileType VB

Represents a Visual Basic Project Item File (.vb), which is a source code file created in the Visual Basic language. It was created by Microsoft for the development of .NET applications. Learn more about this file format here.

CSS

public static final FileType CSS

Represents a Cascading Style Sheet (.css) file. Learn more about this file format here.

CXX

public static final FileType CXX

Represents a C++ Source Code File (.cxx). Learn more about this file format here.

DIFF

public static final FileType DIFF

Represents a Patch File (.diff). Learn more about this file format here.

ERB

public static final FileType ERB

Represents a Ruby ERB Script (.erb). Learn more about this file format here.

GROOVY

public static final FileType GROOVY

Represents a Groovy Source Code File (.groovy). Learn more about this file format here.

H

public static final FileType H

Represents a C/C++/Objective-C Header File (.h). Learn more about this file format here.

HAML

public static final FileType HAML

Represents a Haml Source Code File (.haml). Learn more about this file format here.

HH

public static final FileType HH

Represents a C++ Header File (.hh). Learn more about this file format here.

JAVA

public static final FileType JAVA

Represents a Java Source Code File (.java). Learn more about this file format here.

JS

public static final FileType JS

Represents a JavaScript File (.js). Learn more about this file format here.

JSON

public static final FileType JSON

Represents a JavaScript Object Notation File (.json). Learn more about this file format here.

LESS

public static final FileType LESS

Represents a LESS Style Sheet (.less) file. Learn more about this file format here.

LOG

public static final FileType LOG

Represents a Log File (.log). Learn more about this file format here.

M

public static final FileType M

Represents an Objective-C Implementation File (.m). Learn more about this file format here.

MAKE

public static final FileType MAKE

Represents an Xcode Makefile Script (.make). Learn more about this file format here.

MD

public static final FileType MD

Represents a Markdown Documentation File (.md). Learn more about this file format here.

ML

public static final FileType ML

Represents an ML Source Code File (.ml). Learn more about this file format here.

MM

public static final FileType MM

Represents an Objective-C++ Source File (.mm). Learn more about this file format here.

PHP

public static final FileType PHP

Represents a PHP Source Code File (.php). Learn more about this file format here.

PL

public static final FileType PL

Represents a Perl Script (.pl). Learn more about this file format here.

PROPERTIES

public static final FileType PROPERTIES

Represents a Java Properties File (.properties). Learn more about this file format here.

PY

public static final FileType PY

Represents a Python Script (.py). Learn more about this file format here.

RB

public static final FileType RB

Represents a Ruby Source Code (.rb) file. Learn more about this file format here.

RST

public static final FileType RST

Represents a reStructuredText File (.rst). Learn more about this file format here.

SASS

public static final FileType SASS

Represents a Syntactically Awesome StyleSheets File (.sass). Learn more about this file format here.

SCALA

public static final FileType SCALA

Represents a Scala Source Code File (.scala). Learn more about this file format here.

SCM

public static final FileType SCM

Represents a Scheme Source Code File (.scm). Learn more about this file format here.

SCRIPT

public static final FileType SCRIPT

Represents a Generic Script File (.script). Learn more about this file format here.

SH

public static final FileType SH

Represents a Bash Shell Script (.sh). Learn more about this file format here.

SML

public static final FileType SML

Represents a Standard ML Source Code File (.sml). Learn more about this file format here.

SQL

public static final FileType SQL

Represents a Structured Query Language Data File (.sql). Learn more about this file format here.

VIM

public static final FileType VIM

Represents a Vim Settings File (.vim). Learn more about this file format here.

YAML

public static final FileType YAML

Represents a YAML Document (.yaml). Learn more about this file format here.

DOC

public static final FileType DOC

Represents a Microsoft Word Document (.doc) file. Learn more about this file format here.

DOCX

public static final FileType DOCX

Represents a Microsoft Word Open XML Document (.docx) file. Learn more about this file format here.

CHM

public static final FileType CHM

Represents a Microsoft Compiled HTML Help File (.chm). Learn more about this file format here.

DOCM

public static final FileType DOCM

Represents a Word Open XML Macro-Enabled Document (.docm) file. Learn more about this file format here.

DOT

public static final FileType DOT

Represents a Word Document Template (.dot) file. Learn more about this file format here.

DOTX

public static final FileType DOTX

Represents a Word Open XML Document Template (.dotx) file. Learn more about this file format here.

DOTM

public static final FileType DOTM

Represents a Word Open XML Macro-Enabled Document Template (.dotm) file. Learn more about this file format here.

RTF

public static final FileType RTF

Represents a Rich Text Format File (.rtf). Learn more about this file format here.

TXT

public static final FileType TXT

Represents a Plain Text File (.txt). Learn more about this file format here.

ODT

public static final FileType ODT

Represents an OpenDocument Text Document (.odt). Learn more about this file format here.

OTT

public static final FileType OTT

Represents an OpenDocument Document Template (.ott). It is a template document generated in compliance with the OASIS’ OpenDocument standard format. Learn more about this file format here.

VCF

public static final FileType VCF

Represents a vCard File (.vcf), which is a digital file format for storing contact information. It is widely used for data interchange among popular information exchange applications. Learn more about this file format here.

AI

public static final FileType AI

Represents an Adobe Illustrator file (.ai), which is a file format for Adobe Illustrator drawings. Learn more about this file format here.

PSM1

public static final FileType PSM1

Represents a PowerShell script module file (.psm1). It is a file format for PowerShell module scripts. Learn more about this file format here.

PS1

public static final FileType PS1

Represents a PowerShell script file (.ps1). It is a file format for Windows PowerShell Cmdlet files. Learn more about this file format here.

PSD1

public static final FileType PSD1

Represents a PowerShell script module manifest file (.psd1). It is a file format for PowerShell module manifest scripts. Learn more about this file format here.

values()

public static FileType[] values()

Returns: com.groupdocs.viewer.FileType[]

valueOf(String name)

public static FileType valueOf(String name)

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: FileType

fromExtension(String extension)

public static FileType fromExtension(String extension)

Maps a file extension to a file type.

This method takes a file extension, with or without the period “.”, and returns the corresponding file type if it is supported. If the file type is not supported, it returns the default UNKNOWN file type.

Parameters:

Parameter	Type	Description
extension	java.lang.String	The file extension with or without the period “.”.

Returns: FileType - the corresponding file type if supported, otherwise the default UNKNOWN file type.

fromFilePath(String filePath)

public static FileType fromFilePath(String filePath)

Extracts the file extension from a file name or file path and maps it to a file type.

If the file type is supported, the method returns the corresponding FileType , otherwise it returns the default UNKNOWN file type.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file name or file path.

Returns: FileType - the corresponding file type if supported, otherwise the default UNKNOWN file type.

fromMediaType(String mediaType)

public static FileType fromMediaType(String mediaType)

Maps a file media type to a file type. For example, ‘application/pdf’ will be mapped to PDF.

This method takes a file media type as input and maps it to the corresponding FileType . If the media type is supported, the method returns the corresponding file type. If the media type is not supported, it returns the default UNKNOWN file type.

Parameters:

Parameter	Type	Description
mediaType	java.lang.String	The file media type, e.g., ‘application/pdf’.

Returns: FileType - the corresponding file type if found, otherwise the default UNKNOWN file type.

fromStream(InputStream stream)

public static FileType fromStream(InputStream stream)

Detects the file type by reading the file signature.

This method takes an input stream representing a file and tries to detect its file type by analyzing the file signature. The file signature is a unique sequence of bytes at the beginning of the file that indicates its file type. The method reads the file signature from the input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The input stream representing the file.

Returns: FileType - the detected file type if successful, otherwise the default UNKNOWN file type.

fromStream(InputStream stream, String password)

public static FileType fromStream(InputStream stream, String password)

Detects the file type by reading the file signature.

This method analyzes the file signature, which is a unique sequence of bytes at the beginning of the file, to determine the file type. It reads the file signature from the provided input stream and matches it against known file signatures of supported file types. If a match is found, the method returns the corresponding file type. If no match is found, it returns the default UNKNOWN file type.

If the file is encrypted and requires a password to open, the password should be provided as a parameter to this method. The password will be used to decrypt the file and analyze its signature for determining the file type.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The input stream representing the file.
password	java.lang.String	The password to open the file.

Returns: FileType - the detected file type if successful, otherwise the default UNKNOWN file type.

fromStream(InputStream stream, ILogger logger)

public static FileType fromStream(InputStream stream, ILogger logger)

Detects the file type by reading the file signature.

A logger can be provided to log any relevant information or errors during the file type detection process. The logger should implement the ILogger interface. If no logger is provided, the detection process will not produce any log output.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The input stream representing the file.
logger	com.groupdocs.foundation.logging.ILogger	The logger for logging information or errors.

Returns: FileType - the detected file type if successful, otherwise the default UNKNOWN file type.

fromStream(InputStream stream, String password, ILogger logger)

public static FileType fromStream(InputStream stream, String password, ILogger logger)

Detects the file type by reading the file signature.

A password can be provided if the file is encrypted or protected. The password will be used to open the file before analyzing the file signature. If the file does not require a password, this parameter can be set to null.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The input stream representing the file.
password	java.lang.String	The password to open the file.
logger	com.groupdocs.foundation.logging.ILogger	The logger for logging information or errors.

Returns: FileType - the detected file type if successful, otherwise the default UNKNOWN file type.

getSupportedFileTypes()

public static List<FileType> getSupportedFileTypes()

Retrieves the supported file types.

This method returns a sequence of all the supported file types by the system. The file types represent various document formats that can be processed or recognized by the system.

Learn more

Learn more about the supported document formats: Full list of supported file formats

Returns: java.util.List<com.groupdocs.viewer.FileType> - a sequence of supported file types.

detectCharset(String filePath)

public static Charset detectCharset(String filePath)

Attempts to detect text TXT, TSV, and CSV files charset by path.

Parameters:

Parameter	Type	Description
filePath	java.lang.String	The file name or file path.

Returns: java.nio.charset.Charset - Charset or null when fails to detect a file charset.

Example:

Charset charset = FileType.detectCharset("message.txt");

detectCharset(InputStream stream)

public static Charset detectCharset(InputStream stream)

Attempts to detect text TXT, TSV, and CSV file charset by stream.

Parameters:

Parameter	Type	Description
stream	java.io.InputStream	The file stream.

Returns: java.nio.charset.Charset - Charset or null when fails to detect a file charset.

Example:

InputStream stream = new FileInputStream("message.txt");
 Charset charset = FileType.detectCharset(stream);

getFileFormat()

public final String getFileFormat()

Gets the name of the file format, e.g., “Microsoft Word Document”.

Returns: java.lang.String - the name of the file format.

getExtension()

public final String getExtension()

Gets the file extension suffix (including the period “.”), e.g., “.doc”.

Returns: java.lang.String - the file extension suffix.

toString()

public String toString()

Returns a string representation of the current object.

Returns: java.lang.String - a string representation of the current object.