oracle.javatools.compare

Class CompareMain.FileCompareContributor

java.lang.Object

oracle.javatools.compare.CompareContributor

oracle.javatools.compare.algorithm.sequence.SequenceCompareContributor

oracle.javatools.compare.algorithm.text.TextCompareContributor

oracle.javatools.compare.CompareMain.FileCompareContributor

All Implemented Interfaces:

oracle.javatools.compare.algorithm.EditableContributor, oracle.javatools.compare.algorithm.ExpirableContributor

Enclosing class:

CompareMain

public static class CompareMain.FileCompareContributor
extends oracle.javatools.compare.algorithm.text.TextCompareContributor
implements EditableContributor

Field Summary

Fields inherited from interface oracle.javatools.compare.algorithm.EditableContributor

PROPERTY_EDITABLE, PROPERTY_MODIFIED

Constructor Summary

Constructors

Constructor and Description
FileCompareContributor(java.io.File file, boolean ignoreWhitespace)

Method Summary

Modifier and Type	Method and Description
java.io.File	getFile()
java.lang.String	getLongLabel() Get a long label for this comparable element.
java.lang.String	getShortLabel() Get a short label for this comparable element.
TextBuffer	getTextBuffer() Get the TextBuffer to display in compare for this contributor.
java.lang.String	getType() Get the extension of the file this contributor represents.
boolean	isEditable() Get whether this contributor is currently editable.
boolean	isModified() Get whether this contributor is currently modified, i.e.
void	save()

Methods inherited from class oracle.javatools.compare.algorithm.text.TextCompareContributor

_equal, addChangeListener, addHighLite, addHighLiteListener, addTextBufferListeners, deleteElement, deleteHighLite, equal, fireChangeEvent, getDocumentModel, getElement, getHighLite, getIgnoreWhitespace, getLength, insertElement, isHighLite, newHighLite, removeChangeListener, removeHighLiteListener, replaceElement, reset, selected, setDocumentModel, setIgnoreWhitespace

Methods inherited from class oracle.javatools.compare.CompareContributor

addPropertyChangeListener, addPropertyChangeListener, getProperty, getPropertyChangeSupport, removePropertyChangeListener, setLongLabel, setProperty, setShortLabel, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.javatools.compare.algorithm.EditableContributor

addChangeListener, removeChangeListener

Constructor Detail

FileCompareContributor

public FileCompareContributor(java.io.File file,
                              boolean ignoreWhitespace)
                       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getFile

public java.io.File getFile()

getTextBuffer

public TextBuffer getTextBuffer()

Description copied from class: oracle.javatools.compare.algorithm.text.TextCompareContributor

Get the TextBuffer to display in compare for this contributor.

Specified by:

getTextBuffer in class oracle.javatools.compare.algorithm.text.TextCompareContributor

Returns:

a TextBuffer

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: CompareContributor

Get a short label for this comparable element.

Overrides:

getShortLabel in class CompareContributor

Returns:

a short label for this comparable element.

getLongLabel

public java.lang.String getLongLabel()

Description copied from class: CompareContributor

Get a long label for this comparable element.

Overrides:

getLongLabel in class CompareContributor

Returns:

a long label for this comparable element.

getType

public java.lang.String getType()

Description copied from class: CompareContributor

Get the extension of the file this contributor represents. This is currently only used to determine the syntax highlighting style for the text compare viewer, but it will almost certainly be used for other things in the future. By default, this method returns an empty string.

Overrides:

getType in class CompareContributor

Returns:

an extension for this file without any period prefix. E.g. "java".

isEditable

public boolean isEditable()

Description copied from interface: oracle.javatools.compare.algorithm.EditableContributor

Get whether this contributor is currently editable. This is to support contributors that are normally editable, but may be read-only under certain states (e.g. a checked in file.).

Specified by:

isEditable in interface oracle.javatools.compare.algorithm.EditableContributor

Returns:

true if this contributor can currently be edited.

isModified

public boolean isModified()

Description copied from interface: oracle.javatools.compare.algorithm.EditableContributor

Get whether this contributor is currently modified, i.e. has unsaved changes pending.

Specified by:

isModified in interface oracle.javatools.compare.algorithm.EditableContributor

Returns:

true if this contributor has unsaved changes.

save

public void save()
          throws java.io.IOException

Throws:

java.io.IOException