Groupdocs API References – com.groupdocs.comparison.result

Java: ChangeInfo

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

Inheritance: java.lang.Object

public class ChangeInfo

The ChangeInfo class represents information about a specific change in a document comparison.

It provides details such as the type of change, the affected area, and the content before and after the change. Use this class to retrieve information about individual changes within a comparison result.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare(resultFile);
     // Get a list of changes from the comparison result
     ChangeInfo[] changes = comparer.getChanges();
     // Iterate through the changes and retrieve information
     for (ChangeInfo change : changes) {
         ChangeType changeType = change.getType();
         String componentType = change.getComponentType();
         PageInfo pageInfo = change.getPageInfo();
         // Process the change information as needed
         // ...
     }
 }

Constructors

Constructor	Description
ChangeInfo()

Methods

Method	Description
getId()	Gets unique id of the change.
setId(int value)	Sets unique id of the change.
getComparisonAction()	Gets the action that will be applied to the change.
setComparisonAction(ComparisonAction value)	Sets the action that should be applied to the change.
getPageInfo()	Gets information about the page, on which current change was found.
setPageInfo(PageInfo value)	Sets information about the page, on which current change was found.
getBox()	Gets coordinates of changed element on the page.
setBox(Rectangle value)	Sets coordinates of changed element on the page.
getText()	Gets text value of the change.
setText(String value)	Sets text value of the change.
getStyleChanges()	Gets the list of style changes.
setStyleChanges(List value)	Sets the list of style changes.
getAuthors()	Gets the list of authors.
setAuthors(List value)	Sets the list of authors.
getType()	Gets the type of the change represented by enum ChangeType.
getTargetText()	Gets changed text from target document.
setTargetText(String value)	Sets changed text from target document.
getSourceText()	Gets changed text from source document.
setSourceText(String value)	Sets changed text from source document.
getComponentType()	Gets the type of the changed component.
setComponentType(String value)	Sets the type of the changed component.
toString()

ChangeInfo()

public ChangeInfo()

getId()

public final int getId()

Gets unique id of the change.

Returns: int - the id of the change

setId(int value)

public final void setId(int value)

Sets unique id of the change.

Parameters:

Parameter	Type	Description
value	int	The id of the change

getComparisonAction()

public final ComparisonAction getComparisonAction()

Gets the action that will be applied to the change.

Action (ComparisonAction.ACCEPT or ComparisonAction.REJECT) tells comparison what to do with this change.

Returns: ComparisonAction - the action that will be applied to the change

setComparisonAction(ComparisonAction value)

public final void setComparisonAction(ComparisonAction value)

Sets the action that should be applied to the change.

Action (ComparisonAction.ACCEPT or ComparisonAction.REJECT) tells comparison what to do with this change.

Parameters:

Parameter	Type	Description
value	ComparisonAction	The action that should be applied to the change

getPageInfo()

public final PageInfo getPageInfo()

Gets information about the page, on which current change was found.

Returns: PageInfo - information about the page

setPageInfo(PageInfo value)

public final void setPageInfo(PageInfo value)

Sets information about the page, on which current change was found.

Parameters:

Parameter	Type	Description
value	PageInfo	Information about the page

getBox()

public final Rectangle getBox()

Gets coordinates of changed element on the page.

Returns: Rectangle - coordinates of changed element

setBox(Rectangle value)

public final void setBox(Rectangle value)

Sets coordinates of changed element on the page.

Parameters:

Parameter	Type	Description
value	Rectangle	Coordinates of changed element, not null

getText()

public final String getText()

Gets text value of the change.

Returns: java.lang.String - text value of the change

setText(String value)

public final void setText(String value)

Sets text value of the change.

Parameters:

Parameter	Type	Description
value	java.lang.String	Text value of the change

getStyleChanges()

public final List<StyleChangeInfo> getStyleChanges()

Gets the list of style changes.

Returns: java.util.List<com.groupdocs.comparison.result.StyleChangeInfo> - the list of style changes

setStyleChanges(List value)

public final void setStyleChanges(List<StyleChangeInfo> value)

Sets the list of style changes.

Parameters:

Parameter	Type	Description
value	java.util.List<com.groupdocs.comparison.result.StyleChangeInfo>	The list of style changes

getAuthors()

public final List<String> getAuthors()

Gets the list of authors.

Returns: java.util.List<java.lang.String> - the list of authors

setAuthors(List value)

public final void setAuthors(List<String> value)

Sets the list of authors.

Parameters:

Parameter	Type	Description
value	java.util.List<java.lang.String>	The list of authors

getType()

public final ChangeType getType()

Gets the type of the change represented by enum ChangeType.

Returns: ChangeType - the type of the change

getTargetText()

public String getTargetText()

Gets changed text from target document.

Returns: java.lang.String - the changed text

setTargetText(String value)

public void setTargetText(String value)

Sets changed text from target document.

Parameters:

Parameter	Type	Description
value	java.lang.String	The changed text

getSourceText()

public String getSourceText()

Gets changed text from source document.

Returns: java.lang.String - the changed text

setSourceText(String value)

public void setSourceText(String value)

Sets changed text from source document.

Parameters:

Parameter	Type	Description
value	java.lang.String	The changed text

getComponentType()

public String getComponentType()

Gets the type of the changed component.

Returns: java.lang.String - the type of the changed component

setComponentType(String value)

public void setComponentType(String value)

Sets the type of the changed component.

Parameters:

Parameter	Type	Description
value	java.lang.String	The type of the changed component

toString()

public String toString()

Returns: java.lang.String

Java: PageInfo

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

Inheritance: java.lang.Object

public class PageInfo

The PageInfo class represents information about a specific page in a document.

It provides details such as the page number, width, height, and other relevant properties. Use this class to retrieve information about individual pages in a document during the comparison process.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare(resultFile);
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo change : changes) {
         final PageInfo pageInfo = change.getPageInfo();
         // Print the page information
         System.out.println("Page Number: " + pageInfo.getPageNumber());
         System.out.println("Page Width: " + pageInfo.getWidth());
         System.out.println("Page Height: " + pageInfo.getHeight());
     }
 }

Constructors

Constructor	Description
PageInfo(int pageNumber, int width, int height)	Initializes a new instance of the PageInfo class with configuring pageNumber, width and height.

Methods

Method	Description
getWidth()	Gets the width of the page
setWidth(int value)	Sets the width of the page
getHeight()	Gets the height of the page
setHeight(int value)	Sets the height of the page
getPageNumber()	Gets the number of the page
setPageNumber(int value)	Sets the number of the page
toString()

PageInfo(int pageNumber, int width, int height)

public PageInfo(int pageNumber, int width, int height)

Initializes a new instance of the PageInfo class with configuring pageNumber, width and height.

Parameters:

Parameter	Type	Description
pageNumber	int	The number of the page
width	int	The width of the page
height	int	The height of the page

getWidth()

public final int getWidth()

Gets the width of the page

Returns: int - the width of the page

setWidth(int value)

public final void setWidth(int value)

Sets the width of the page

Parameters:

Parameter	Type	Description
value	int	The width of the page

getHeight()

public final int getHeight()

Gets the height of the page

Returns: int - the height of the page

setHeight(int value)

public final void setHeight(int value)

Sets the height of the page

Parameters:

Parameter	Type	Description
value	int	The height of the page

getPageNumber()

public final int getPageNumber()

Gets the number of the page

Returns: int - the number of the page

setPageNumber(int value)

public final void setPageNumber(int value)

Sets the number of the page

Parameters:

Parameter	Type	Description
value	int	The number of the page

toString()

public String toString()

Returns: java.lang.String

Java: Rectangle

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

Inheritance: java.lang.Object

public final class Rectangle

The Rectangle class represents changed area on a document.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare(resultFile);
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo change : changes) {
         final Rectangle box = change.getBox();
         // Print the changed area on page
         System.out.println("Changed area on a page: "
                 + box.getX() + ", " + box.getY() + ", " + box.getWidth() + ", " + box.getHeight());
     }
 }

Constructors

Constructor	Description
Rectangle()	Initializes a new instance of the Rectangle class.
Rectangle(Rectangle other)	Creates a new Rectangle object that is a copy of the specified rectangle.
Rectangle(double x, double y, double width, double height)	Creates a new instance of the Rectangle class with the specified x, y, width, and height.

Methods

Method	Description
getHeight()	Gets the height of the rectangle.
setHeight(double value)	Sets the height of the rectangle.
getWidth()	Gets the width of the rectangle.
setWidth(double value)	Sets the width of the rectangle.
getX()	Gets the x-coordinate of the top-left corner of the rectangle.
setX(double value)	Sets the x-coordinate of the top-left corner of the rectangle.
getY()	Gets the y-coordinate of the top-left corner of the rectangle.
setY(double value)	Sets the y-coordinate of the top-left corner of the rectangle.
equals(Object o)	{@inheritDoc}
hashCode()	{@inheritDoc}
toString()	{@inheritDoc}

Rectangle()

public Rectangle()

Initializes a new instance of the Rectangle class.

Rectangle(Rectangle other)

public Rectangle(Rectangle other)

Creates a new Rectangle object that is a copy of the specified rectangle.

Parameters:

Parameter	Type	Description
other	Rectangle	The rectangle to be copied

Rectangle(double x, double y, double width, double height)

public Rectangle(double x, double y, double width, double height)

Creates a new instance of the Rectangle class with the specified x, y, width, and height.

Parameters:

Parameter	Type	Description
x	double	The x-coordinate of the top-left corner of the rectangle
y	double	The y-coordinate of the top-left corner of the rectangle
width	double	The width of the rectangle
height	double	The height of the rectangle

getHeight()

public double getHeight()

Gets the height of the rectangle.

Returns: double - the height of the rectangle

setHeight(double value)

public void setHeight(double value)

Sets the height of the rectangle.

Parameters:

Parameter	Type	Description
value	double	The height of the rectangle

getWidth()

public double getWidth()

Gets the width of the rectangle.

Returns: double - the width of the rectangle

setWidth(double value)

public void setWidth(double value)

Sets the width of the rectangle.

Parameters:

Parameter	Type	Description
value	double	The width of the rectangle

getX()

public double getX()

Gets the x-coordinate of the top-left corner of the rectangle.

Returns: double - the x-coordinate of the top-left corner of the rectangle

setX(double value)

public void setX(double value)

Sets the x-coordinate of the top-left corner of the rectangle.

Parameters:

Parameter	Type	Description
value	double	The x-coordinate of the top-left corner of the rectangle

getY()

public double getY()

Gets the y-coordinate of the top-left corner of the rectangle.

Returns: double - the y-coordinate of the top-left corner of the rectangle

setY(double value)

public void setY(double value)

Sets the y-coordinate of the top-left corner of the rectangle.

Parameters:

Parameter	Type	Description
value	double	The y-coordinate of the top-left corner of the rectangle

equals(Object o)

public boolean equals(Object o)

Parameters:

Parameter	Type	Description
o	java.lang.Object

Returns: boolean

hashCode()

public int hashCode()

Returns: int

toString()

public String toString()

Returns: java.lang.String

Java: StyleChangeInfo

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

Inheritance: java.lang.Object

public class StyleChangeInfo

The StyleChangeInfo class represents information about a style change in a compared document.

It provides details such as the changed property name, values before and after the change, and so on. Use this class to retrieve information about style changes during the document comparison process.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);

     comparer.compare();
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo change : changes) {
         // Access the style change information
         final List styleChanges = change.getStyleChanges();
         for (StyleChangeInfo styleChange : styleChanges) {
             // Print the style change information
             System.out.println("PropertyName: " + styleChange.getPropertyName());
             System.out.println("OldValue: " + styleChange.getOldValue());
             System.out.println("NewValue: " + styleChange.getNewValue());
         }
     }
 }

Constructors

Constructor	Description
StyleChangeInfo()

Methods

Method	Description
getPropertyName()	Gets the name of the property that was changed.
setPropertyName(String value)	Sets the name of the property that was changed.
getNewValue()	Gets the new value of the property.
setNewValue(Object value)	Sets the new value of the property.
getOldValue()	Gets the old value of the property.
setOldValue(Object value)	Sets the old value of the property.
equals(Object o)	{@inheritDoc}
hashCode()	{@inheritDoc}

StyleChangeInfo()

public StyleChangeInfo()

getPropertyName()

public final String getPropertyName()

Gets the name of the property that was changed.

Returns: java.lang.String - the property name

setPropertyName(String value)

public final void setPropertyName(String value)

Sets the name of the property that was changed.

Parameters:

Parameter	Type	Description
value	java.lang.String	The property name

getNewValue()

public final Object getNewValue()

Gets the new value of the property.

Returns: java.lang.Object - the new value of the property

setNewValue(Object value)

public final void setNewValue(Object value)

Sets the new value of the property.

Parameters:

Parameter	Type	Description
value	java.lang.Object	The new value of the property

getOldValue()

public final Object getOldValue()

Gets the old value of the property.

Returns: java.lang.Object - the old value of the property

setOldValue(Object value)

public final void setOldValue(Object value)

Sets the old value of the property.

Parameters:

Parameter	Type	Description
value	java.lang.Object	The old value of the property

equals(Object o)

public boolean equals(Object o)

Parameters:

Parameter	Type	Description
o	java.lang.Object

Returns: boolean

hashCode()

public int hashCode()

Returns: int

Java: ChangeType

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

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

public enum ChangeType extends Enum<ChangeType>

The ChangeType enum represents the types of changes that can occur during the document comparison process.

Each constant in this enum represents a specific type of change and provides a human-readable description and a numeric value.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();
     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo changeInfo : changes) {
         // Get the ChangeType for a specific change
         final ChangeType changeType = changeInfo.getType();
         // Print the ChangeType information
         System.out.println("Description: " + changeType.toString());
         System.out.println("Value: " + changeType.toInt());
     }
 }

Fields

Field	Description
NONE	Represents no change.
MODIFIED	Represents a modified change.
INSERTED	Represents an inserted change.
DELETED	Represents a deleted change.
ADDED	Represents an added change.
NOT_MODIFIED	Represents a not modified change.
STYLE_CHANGED	Represents a style changed change.
RESIZED	Represents a resized change.
MOVED	Represents a moved change.
MOVED_AND_RESIZED	Represents a moved and resized change.
SHIFTED_AND_RESIZED	Represents a shifted and resized change.

Methods

Method	Description
values()
valueOf(String name)
fromString(String toStringValue)	Parses string representation of ChangeType to get the enum constant.
fromInt(int intValue)	Creates new constant of enum ChangeType using provided numeric value.
toString()	String representation of ChangeType.
toInt()	Numeric representation of ChangeType.

NONE

public static final ChangeType NONE

Represents no change.

MODIFIED

public static final ChangeType MODIFIED

Represents a modified change.

INSERTED

public static final ChangeType INSERTED

Represents an inserted change.

DELETED

public static final ChangeType DELETED

Represents a deleted change.

ADDED

public static final ChangeType ADDED

Represents an added change.

NOT_MODIFIED

public static final ChangeType NOT_MODIFIED

Represents a not modified change.

STYLE_CHANGED

public static final ChangeType STYLE_CHANGED

Represents a style changed change.

RESIZED

public static final ChangeType RESIZED

Represents a resized change.

MOVED

public static final ChangeType MOVED

Represents a moved change.

MOVED_AND_RESIZED

public static final ChangeType MOVED_AND_RESIZED

Represents a moved and resized change.

SHIFTED_AND_RESIZED

public static final ChangeType SHIFTED_AND_RESIZED

Represents a shifted and resized change.

values()

public static ChangeType[] values()

Returns: com.groupdocs.comparison.result.ChangeType[]

valueOf(String name)

public static ChangeType valueOf(String name)

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: ChangeType

fromString(String toStringValue)

public static ChangeType fromString(String toStringValue)

Parses string representation of ChangeType to get the enum constant.

Parameters:

Parameter	Type	Description
toStringValue	java.lang.String	The string representation of ChangeType

Returns: ChangeType - ChangeType enum constant associated with input string

fromInt(int intValue)

public static ChangeType fromInt(int intValue)

Creates new constant of enum ChangeType using provided numeric value.

Parameters:

Parameter	Type	Description
intValue	int	The numeric representation of ChangeType

Returns: ChangeType - ChangeType enum constant associated with numeric value

toString()

public String toString()

String representation of ChangeType.

Returns: java.lang.String - string value of enum constant

toInt()

public int toInt()

Numeric representation of ChangeType.

Returns: int - numeric value of enum constant

Java: ComparisonAction

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

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

public enum ComparisonAction extends Enum<ComparisonAction>

The ComparisonAction enum represents the actions that can be applied to a change during the document comparison process.

Each constant in this enum represents a specific action and provides a human-readable description and a numeric value.

Example usage:


 try (Comparer comparer = new Comparer(sourceFile)) {
     comparer.add(targetFile);
     comparer.compare();

     final ChangeInfo[] changes = comparer.getChanges();
     for (ChangeInfo changeInfo : changes) {
         if (changeInfo.getId() % 2 == 0) {
             changeInfo.setComparisonAction(ComparisonAction.REJECT);
         }
     }
     comparer.applyChanges(resultFile, changes);
 }

Fields

Field	Description
NONE	Represents no action.
ACCEPT	Represents an accept action.
REJECT	Represents a reject action.

Methods

Method	Description
values()
valueOf(String name)
fromString(String toStringValue)	Parses string representation of ComparisonAction to get the enum constant.
fromInt(int intValue)	Creates new constant of enum ComparisonAction using provided numeric value.
toString()	String representation of ComparisonAction.
toInt()	Numeric representation of ComparisonAction.

NONE

public static final ComparisonAction NONE

Represents no action. The change will have no effect.

ACCEPT

public static final ComparisonAction ACCEPT

Represents an accept action. The change will be visible in the result file.

REJECT

public static final ComparisonAction REJECT

Represents a reject action. The change will be invisible in the result file.

values()

public static ComparisonAction[] values()

Returns: com.groupdocs.comparison.result.ComparisonAction[]

valueOf(String name)

public static ComparisonAction valueOf(String name)

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: ComparisonAction

fromString(String toStringValue)

public static ComparisonAction fromString(String toStringValue)

Parses string representation of ComparisonAction to get the enum constant.

Parameters:

Parameter	Type	Description
toStringValue	java.lang.String	The string representation of ComparisonAction

Returns: ComparisonAction - ComparisonAction enum constant associated with input string

fromInt(int intValue)

public static ComparisonAction fromInt(int intValue)

Creates new constant of enum ComparisonAction using provided numeric value.

Parameters:

Parameter	Type	Description
intValue	int	The numeric representation of ComparisonAction

Returns: ComparisonAction - ComparisonAction enum constant associated with numeric value

toString()

public String toString()

String representation of ComparisonAction.

Returns: java.lang.String - string value of enum constant

toInt()

public int toInt()

Numeric representation of ComparisonAction.

Returns: int - numeric value of enum constant

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

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

The FileType enum represents the type of a file used in the document comparison process.

It defines different file types such as Word documents, PDF files, and more. Provides methods to obtain list of all file types supported by GroupDocs.Comparison, detect file type by extension etc. Use this enum to specify the file type when working with the GroupDocs.Comparison library.

Learn more about file formats supported by GroupDocs.Comparison: Full list of supported document formats
Learn more about getting supported file types in Java: How to get supported file formats in Java

Example usage:


  // Set the file type to Word document
  final FileType fileType = FileType.DOCX;
  // Perform comparison using the specified file type
  final LoadOptions loadOptions = new LoadOptions(fileType);
  try (Comparer comparer = new Comparer(sourceFile, loadOptions)) {
      comparer.add(targetFile);

      comparer.compare(resultFile, compareOptions);
 }

Fields

Field	Description
UNKNOWN	Unknown type
AS	ActionScript Programming Language format
AS3	ActionScript Programming Language format
ASM	Assembler Programming Language format
BAT	Script file in DOS, OS/2 and Microsoft Windows
CMD	Script file in DOS, OS/2 and Microsoft Windows
C	C-Based Programming Language format
H	C-Based header files contain definitions of Functions and Variables
PDF	Adobe Portable Document format
DOC	Microsoft Word 97-2003 Document
DOCM	Microsoft Word Macro-Enabled Document
DOCX	Microsoft Word Document
DOT	Microsoft Word 97-2003 Template
DOTM	Microsoft Word Macro-Enabled Template
DOTX	Microsoft Word Template
XLS	Microsoft Excel 97-2003 Worksheet
XLT	Microsoft Excel template
XLSX	Microsoft Excel Worksheet
XLTM	Microsoft Excel macro-enabled template
XLSB	Microsoft Excel Binary Worksheet
XLSM	Microsoft Excel Macro-Enabled Worksheet
POT	Microsoft PowerPoint template
POTX	Microsoft PowerPoint Template
POTM	Microsoft PowerPoint Template with support for Macros
PPS	Microsoft PowerPoint 97-2003 Slide Show
PPSX	Microsoft PowerPoint Slide Show
PPTX	Microsoft PowerPoint Presentation
PPT	Microsoft PowerPoint 97-2003 Presentation
PPTM	Microsoft PowerPoint Macro-Enabled Presentation
PPSM	Microsoft PowerPoint Macro-Enabled Slide Show Presentation
VSDX	Microsoft Visio Drawing
VSD	Microsoft Visio 2003-2010 Drawing
VSS	Microsoft Visio 2003-2010 Stencil
VST	Microsoft Visio 2003-2010 Template
VDX	Microsoft Visio 2003-2010 XML Drawing
ONE	Microsoft OneNote Document
ODT	OpenDocument Text
ODP	OpenDocument Presentation
OTP	OpenDocument Presentation Template
ODS	OpenDocument Spreadsheet
OTT	OpenDocument Text Template
RTF	Rich Text Document
TXT	Plain Text Document
CSV	Comma Separated Values File
HTML	HyperText Markup Language
MHTML	Mime HTML
MOBI	Mobipocket e-book format
DCM	Digital Imaging and Communications in Medicine
DJVU	Deja Vu format
DWG	Autodesk Design Data Formats
DXF	AutoCAD Drawing Interchange
BMP	Bitmap Picture
GIF	Graphics Interchange Format
JPEG	Joint Photographic Experts Group
JPG	Joint Photographic Experts Group
PNG	Portable Network Graphics
SVG	Scalar Vector Graphics
EML	E-mail Message
EMLX	Apple Mail E-mail File
MSG	Microsoft Outlook E-mail Message
CAD	CAD file format
CPP	C-Based Programming Language format
CC	C-Based Programming Language format
CXX	C-Based Programming Language format
HXX	Header Files that are written in the C++ programming language
HH	Header information referenced by a C++ source code file
HPP	Header Files that are written in the C++ programming language
CMAKE	Tool for managing the build process of software
CS	CSharp Programming Language format
CSX	CSharp script file format
CAKE	CSharp cross-platform build automation system format
DIFF	Data comparison tool format
PATCH	List of differences format
REJ	Rejected files format
GROOVY	Source code file written in Groovy format
GVY	Source code file written in Groovy format
GRADLE	Build-automation system format
HAML	Markup language for simplified HTML generation
JS	JavaScript Programming Language format
ES6	JavaScript standardised scripting language format
MJS	Extension for EcmaScript (ES) module files
PAC	Proxy Auto-Configuration file for JavaScript function format
JSON	Lightweight format for storing and transporting data
BOWERRC	Configuration file for package control on the server-side
JSHINTRC	JavaScript code quality tool
JSCSRC	JavaScript configuration file format
WEBMANIFEST	Manifest file includes information about the app
JSMAP	JSON file that contains information on how to translate code back to source code
HAR	The HTTP Archive format
JAVA	Java Programming Language format
LESS	Dynamic preprocessor style sheet language format
LOG	Logging keeps a registry of events, processes, messages and communication
MAKE	Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal
MK	Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal
MD	Markdown Language format
MKD	Markdown Language format
MDWN	Markdown Language format
MDOWN	Markdown Language format
MARKDOWN	Markdown Language format
MARKDN	Markdown Language format
MDTXT	Markdown Language format
MDTEXT	Markdown Language format
ML	Caml Programming Language format
MLI	Caml Programming Language format
OBJC	Objective-C Programming Language format
OBJCP	Objective-C++ Programming Language format
PHP	PHP Programming Language format
PHP4	PHP Programming Language format
PHP5	PHP Programming Language format
PHTML	Standard file extension for PHP 2 programs format
CTP	CakePHP Template format
PL	Perl Programming Language format
PM	Perl module format
POD	Perl lightweight markup language format
T	Perl test file format
PSGI	Interface between web servers and web applications and frameworks written in the Perl programming
P6	Perl Programming Language format
PL6	Perl Programming Language format
PM6	Perl module format
NQP	Intermediate language used to build the Rakudo Perl 6 compiler
PROP	Properties file format
CFG	Configuration file used for storing settings
CONF	Configuration file used on Unix and Linux based systems
DIR	Directory is a location for storing files on computer
PY	Python Programming Language format
RPY	Python-based file engine to create and run games
PYW	Files used in Windows to indicate a script needs to be run
CPY	Controller Python Script format
GYP	Build automation tool format
GYPI	Build automation tool format
PYI	Python Interface file format
IPY	IPython Script format
RST	Lightweight markup language
RB	Ruby Programming Language format
ERB	Ruby Programming Language format
RJS	Ruby Programming Language format
GEMSPEC	Developer file that specifies the attributes of a RubyGems
RAKE	Ruby build automation tool
RU	Rack configuration file format
PODSPEC	Ruby build settings format
RBI	Ruby Interface file format
SASS	Style sheet language format
SCSS	Style sheet language format
SCALA	Scala Programming Language format
SBT	SBT build tool for Scala format
SC	Scala worksheet format
SH	Script programmed for bash format
BASH	Type of interpreter that processes shell commands
BASHRC	File determines the behavior of interactive shells
EBUILD	Specialized bash script which automates compilation and installation procedures for software packages
SQL	Structured Query Language format
DSQL	Dynamic Structured Query Language format
VIM	Vim source code file format
YAML	Human-readable data-serialization language format
YML	Human-readable data-serialization language format

Methods

Method	Description
values()
valueOf(String name)
fromFileNameOrExtension(String value)	Return FileType based on file name or extension
getSupportedFileTypes()	Gets list of supported file types
areEquals(FileType left, FileType right)	Checks the equality of provided file types
areNotEquals(FileType left, FileType right)	Checks are provided file types not equals
getFileFormat()	Gets text description of the file type
getExtension()	Gets the extension of the file type
toString()	Gets string representation of FileType, for example ‘PHP Programming Language format (.php)’

UNKNOWN

public static final FileType UNKNOWN

Unknown type

AS

public static final FileType AS

ActionScript Programming Language format

AS3

public static final FileType AS3

ActionScript Programming Language format

ASM

public static final FileType ASM

Assembler Programming Language format

BAT

public static final FileType BAT

Script file in DOS, OS/2 and Microsoft Windows

CMD

public static final FileType CMD

Script file in DOS, OS/2 and Microsoft Windows

C

public static final FileType C

C-Based Programming Language format

H

public static final FileType H

C-Based header files contain definitions of Functions and Variables

PDF

public static final FileType PDF

Adobe Portable Document format

DOC

public static final FileType DOC

Microsoft Word 97-2003 Document

DOCM

public static final FileType DOCM

Microsoft Word Macro-Enabled Document

DOCX

public static final FileType DOCX

Microsoft Word Document

DOT

public static final FileType DOT

Microsoft Word 97-2003 Template

DOTM

public static final FileType DOTM

Microsoft Word Macro-Enabled Template

DOTX

public static final FileType DOTX

Microsoft Word Template

XLS

public static final FileType XLS

Microsoft Excel 97-2003 Worksheet

XLT

public static final FileType XLT

Microsoft Excel template

XLSX

public static final FileType XLSX

Microsoft Excel Worksheet

XLTM

public static final FileType XLTM

Microsoft Excel macro-enabled template

XLSB

public static final FileType XLSB

Microsoft Excel Binary Worksheet

XLSM

public static final FileType XLSM

Microsoft Excel Macro-Enabled Worksheet

POT

public static final FileType POT

Microsoft PowerPoint template

POTX

public static final FileType POTX

Microsoft PowerPoint Template

POTM

public static final FileType POTM

Microsoft PowerPoint Template with support for Macros

PPS

public static final FileType PPS

Microsoft PowerPoint 97-2003 Slide Show

PPSX

public static final FileType PPSX

Microsoft PowerPoint Slide Show

PPTX

public static final FileType PPTX

Microsoft PowerPoint Presentation

PPT

public static final FileType PPT

Microsoft PowerPoint 97-2003 Presentation

PPTM

public static final FileType PPTM

Microsoft PowerPoint Macro-Enabled Presentation

PPSM

public static final FileType PPSM

Microsoft PowerPoint Macro-Enabled Slide Show Presentation

VSDX

public static final FileType VSDX

Microsoft Visio Drawing

VSD

public static final FileType VSD

Microsoft Visio 2003-2010 Drawing

VSS

public static final FileType VSS

Microsoft Visio 2003-2010 Stencil

VST

public static final FileType VST

Microsoft Visio 2003-2010 Template

VDX

public static final FileType VDX

Microsoft Visio 2003-2010 XML Drawing

ONE

public static final FileType ONE

Microsoft OneNote Document

ODT

public static final FileType ODT

OpenDocument Text

ODP

public static final FileType ODP

OpenDocument Presentation

OTP

public static final FileType OTP

OpenDocument Presentation Template

ODS

public static final FileType ODS

OpenDocument Spreadsheet

OTT

public static final FileType OTT

OpenDocument Text Template

RTF

public static final FileType RTF

Rich Text Document

TXT

public static final FileType TXT

Plain Text Document

CSV

public static final FileType CSV

Comma Separated Values File

HTML

public static final FileType HTML

HyperText Markup Language

MHTML

public static final FileType MHTML

Mime HTML

MOBI

public static final FileType MOBI

Mobipocket e-book format

DCM

public static final FileType DCM

Digital Imaging and Communications in Medicine

DJVU

public static final FileType DJVU

Deja Vu format

DWG

public static final FileType DWG

Autodesk Design Data Formats

DXF

public static final FileType DXF

AutoCAD Drawing Interchange

BMP

public static final FileType BMP

Bitmap Picture

GIF

public static final FileType GIF

Graphics Interchange Format

JPEG

public static final FileType JPEG

Joint Photographic Experts Group

JPG

public static final FileType JPG

Joint Photographic Experts Group

PNG

public static final FileType PNG

Portable Network Graphics

SVG

public static final FileType SVG

Scalar Vector Graphics

EML

public static final FileType EML

E-mail Message

EMLX

public static final FileType EMLX

Apple Mail E-mail File

MSG

public static final FileType MSG

Microsoft Outlook E-mail Message

CAD

public static final FileType CAD

CAD file format

CPP

public static final FileType CPP

C-Based Programming Language format

CC

public static final FileType CC

C-Based Programming Language format

CXX

public static final FileType CXX

C-Based Programming Language format

HXX

public static final FileType HXX

Header Files that are written in the C++ programming language

HH

public static final FileType HH

Header information referenced by a C++ source code file

HPP

public static final FileType HPP

Header Files that are written in the C++ programming language

CMAKE

public static final FileType CMAKE

Tool for managing the build process of software

CS

public static final FileType CS

CSharp Programming Language format

CSX

public static final FileType CSX

CSharp script file format

CAKE

public static final FileType CAKE

CSharp cross-platform build automation system format

DIFF

public static final FileType DIFF

Data comparison tool format

PATCH

public static final FileType PATCH

List of differences format

REJ

public static final FileType REJ

Rejected files format

GROOVY

public static final FileType GROOVY

Source code file written in Groovy format

GVY

public static final FileType GVY

Source code file written in Groovy format

GRADLE

public static final FileType GRADLE

Build-automation system format

HAML

public static final FileType HAML

Markup language for simplified HTML generation

JS

public static final FileType JS

JavaScript Programming Language format

ES6

public static final FileType ES6

JavaScript standardised scripting language format

MJS

public static final FileType MJS

Extension for EcmaScript (ES) module files

PAC

public static final FileType PAC

Proxy Auto-Configuration file for JavaScript function format

JSON

public static final FileType JSON

Lightweight format for storing and transporting data

BOWERRC

public static final FileType BOWERRC

Configuration file for package control on the server-side

JSHINTRC

public static final FileType JSHINTRC

JavaScript code quality tool

JSCSRC

public static final FileType JSCSRC

JavaScript configuration file format

WEBMANIFEST

public static final FileType WEBMANIFEST

Manifest file includes information about the app

JSMAP

public static final FileType JSMAP

JSON file that contains information on how to translate code back to source code

HAR

public static final FileType HAR

The HTTP Archive format

JAVA

public static final FileType JAVA

Java Programming Language format

LESS

public static final FileType LESS

Dynamic preprocessor style sheet language format

LOG

public static final FileType LOG

Logging keeps a registry of events, processes, messages and communication

MAKE

public static final FileType MAKE

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

MK

public static final FileType MK

Makefile is a file containing a set of directives used by a make build automation tool to generate a target/goal

MD

public static final FileType MD

Markdown Language format

MKD

public static final FileType MKD

Markdown Language format

MDWN

public static final FileType MDWN

Markdown Language format

MDOWN

public static final FileType MDOWN

Markdown Language format

MARKDOWN

public static final FileType MARKDOWN

Markdown Language format

MARKDN

public static final FileType MARKDN

Markdown Language format

MDTXT

public static final FileType MDTXT

Markdown Language format

MDTEXT

public static final FileType MDTEXT

Markdown Language format

ML

public static final FileType ML

Caml Programming Language format

MLI

public static final FileType MLI

Caml Programming Language format

OBJC

public static final FileType OBJC

Objective-C Programming Language format

OBJCP

public static final FileType OBJCP

Objective-C++ Programming Language format

PHP

public static final FileType PHP

PHP Programming Language format

PHP4

public static final FileType PHP4

PHP Programming Language format

PHP5

public static final FileType PHP5

PHP Programming Language format

PHTML

public static final FileType PHTML

Standard file extension for PHP 2 programs format

CTP

public static final FileType CTP

CakePHP Template format

PL

public static final FileType PL

Perl Programming Language format

PM

public static final FileType PM

Perl module format

POD

public static final FileType POD

Perl lightweight markup language format

T

public static final FileType T

Perl test file format

PSGI

public static final FileType PSGI

Interface between web servers and web applications and frameworks written in the Perl programming

P6

public static final FileType P6

Perl Programming Language format

PL6

public static final FileType PL6

Perl Programming Language format

PM6

public static final FileType PM6

Perl module format

NQP

public static final FileType NQP

Intermediate language used to build the Rakudo Perl 6 compiler

PROP

public static final FileType PROP

Properties file format

CFG

public static final FileType CFG

Configuration file used for storing settings

CONF

public static final FileType CONF

Configuration file used on Unix and Linux based systems

DIR

public static final FileType DIR

Directory is a location for storing files on computer

PY

public static final FileType PY

Python Programming Language format

RPY

public static final FileType RPY

Python-based file engine to create and run games

PYW

public static final FileType PYW

Files used in Windows to indicate a script needs to be run

CPY

public static final FileType CPY

Controller Python Script format

GYP

public static final FileType GYP

Build automation tool format

GYPI

public static final FileType GYPI

Build automation tool format

PYI

public static final FileType PYI

Python Interface file format

IPY

public static final FileType IPY

IPython Script format

RST

public static final FileType RST

Lightweight markup language

RB

public static final FileType RB

Ruby Programming Language format

ERB

public static final FileType ERB

Ruby Programming Language format

RJS

public static final FileType RJS

Ruby Programming Language format

GEMSPEC

public static final FileType GEMSPEC

Developer file that specifies the attributes of a RubyGems

RAKE

public static final FileType RAKE

Ruby build automation tool

RU

public static final FileType RU

Rack configuration file format

PODSPEC

public static final FileType PODSPEC

Ruby build settings format

RBI

public static final FileType RBI

Ruby Interface file format

SASS

public static final FileType SASS

Style sheet language format

SCSS

public static final FileType SCSS

Style sheet language format

SCALA

public static final FileType SCALA

Scala Programming Language format

SBT

public static final FileType SBT

SBT build tool for Scala format

SC

public static final FileType SC

Scala worksheet format

SH

public static final FileType SH

Script programmed for bash format

BASH

public static final FileType BASH

Type of interpreter that processes shell commands

BASHRC

public static final FileType BASHRC

File determines the behavior of interactive shells

EBUILD

public static final FileType EBUILD

Specialized bash script which automates compilation and installation procedures for software packages

SQL

public static final FileType SQL

Structured Query Language format

DSQL

public static final FileType DSQL

Dynamic Structured Query Language format

VIM

public static final FileType VIM

Vim source code file format

YAML

public static final FileType YAML

Human-readable data-serialization language format

YML

public static final FileType YML

Human-readable data-serialization language format

values()

public static FileType[] values()

Returns: com.groupdocs.comparison.result.FileType[]

valueOf(String name)

public static FileType valueOf(String name)

Parameters:

Parameter	Type	Description
name	java.lang.String

Returns: FileType

fromFileNameOrExtension(String value)

public static FileType fromFileNameOrExtension(String value)

Return FileType based on file name or extension

Parameters:

Parameter	Type	Description
value	java.lang.String	File name or extension, not null

Returns: FileType - the file type

getSupportedFileTypes()

public static List<FileType> getSupportedFileTypes()

Gets list of supported file types

Returns: java.util.List<com.groupdocs.comparison.result.FileType> - list of FileType

areEquals(FileType left, FileType right)

public static boolean areEquals(FileType left, FileType right)

Checks the equality of provided file types

Parameters:

Parameter	Type	Description
left	FileType	Left FileType object.
right	FileType	Right FileType object.

Returns: boolean - true if equal, otherwise false

areNotEquals(FileType left, FileType right)

public static boolean areNotEquals(FileType left, FileType right)

Checks are provided file types not equals

Parameters:

Parameter	Type	Description
left	FileType	Left FileType object.
right	FileType	Right FileType object.

Returns: boolean - true if not equal, otherwise false

getFileFormat()

public String getFileFormat()

Gets text description of the file type

Returns: java.lang.String - file type descriptiuon

getExtension()

public String getExtension()

Gets the extension of the file type

Returns: java.lang.String - extension of the file type

toString()

public String toString()

Gets string representation of FileType, for example ‘PHP Programming Language format (.php)’

Returns: java.lang.String - string representation