oracle.jdeveloper.compare
Class InputStreamTextContributor

java.lang.Object
  oracle.javatools.compare.CompareContributor
      oracle.javatools.compare.algorithm.sequence.SequenceCompareContributor
          oracle.javatools.compare.algorithm.text.TextCompareContributor
              oracle.jdeveloper.compare.IdeTextCompareContributor
                  oracle.jdeveloper.compare.InputStreamTextContributor

All Implemented Interfaces:

IdeCompareContributor, PatchCompareContributor

public class InputStreamTextContributor
extends IdeTextCompareContributor
implements PatchCompareContributor

A TextCompareContributor that uses an InputStream. This class takes care of using the correct decoding for HTML and XML.

Since:

release specific (what release of product did this appear in)

Constructor Summary

InputStreamTextContributor(java.io.InputStream inStream, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String type)

InputStreamTextContributor(java.io.InputStream inStream, java.lang.String defaultEncoding, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String type)

InputStreamTextContributor(java.io.Reader inStream, java.lang.String shortLabel, java.lang.String longLabel, java.lang.String type)
Deprecated. not replaced. This constructor does not allow the stream type to be determined, which we need in order to offer advanced compare functionality for certain kinds of content (including XML). Use another contructor and supply an InputStream instead.

Method Summary

java.lang.String	getLongLabel() Get a long label for this comparable element.
PatchCompareDescriptor	getPatchDescriptor() Gets the patch descriptor object for the compare contributor, used in the creation of a patch.
java.lang.String	getShortLabel() Get a short label for this comparable element.
java.lang.String	getStreamEncoding()
StreamType	getStreamType()
TextBuffer	getTextBuffer() Gets the text buffer for the comparison and patch contribution.
java.lang.String	getType() Get the extension of the file this contributor represents.
void	setPatchDescriptor(PatchCompareDescriptor patchDescriptor)

Methods inherited from class oracle.jdeveloper.compare.IdeTextCompareContributor

getContextNode, getNode, isTextProcessed, setContextNode, setTextProcessed

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

addChangeListener, addTextBufferListeners, deleteElement, equal, fireChangeEvent, getDocumentModel, getElement, getIgnoreWhitespace, getLength, insertElement, removeChangeListener, replaceElement, setDocumentModel, setIgnoreWhitespace

Methods inherited from class oracle.javatools.compare.CompareContributor

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeSupport, removePropertyChangeListener, setLongLabel, 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.jdeveloper.compare.PatchCompareContributor

getIgnoreWhitespace

Constructor Detail

InputStreamTextContributor

public InputStreamTextContributor(java.io.InputStream inStream,
                                  java.lang.String shortLabel,
                                  java.lang.String longLabel,
                                  java.lang.String type)
                           throws java.io.IOException

Throws:

java.io.IOException

InputStreamTextContributor

public InputStreamTextContributor(java.io.InputStream inStream,
                                  java.lang.String defaultEncoding,
                                  java.lang.String shortLabel,
                                  java.lang.String longLabel,
                                  java.lang.String type)
                           throws java.io.IOException

Throws:

java.io.IOException

InputStreamTextContributor

public InputStreamTextContributor(java.io.Reader inStream,
                                  java.lang.String shortLabel,
                                  java.lang.String longLabel,
                                  java.lang.String type)
                           throws java.io.IOException

Deprecated. not replaced. This constructor does not allow the stream type to be determined, which we need in order to offer advanced compare functionality for certain kinds of content (including XML). Use another contructor and supply an InputStream instead.

Parameters:

inStream -

shortLabel -

longLabel -

type -

Throws:

java.io.IOException

Method Detail

getTextBuffer

public TextBuffer getTextBuffer()

Description copied from interface: PatchCompareContributor

Gets the text buffer for the comparison and patch contribution.

Specified by:

getTextBuffer in interface PatchCompareContributor

Specified by:

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

Returns:

the contributor text buffer.

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.

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.

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".

setPatchDescriptor

public void setPatchDescriptor(PatchCompareDescriptor patchDescriptor)

getPatchDescriptor

public PatchCompareDescriptor getPatchDescriptor()

Description copied from interface: PatchCompareContributor

Gets the patch descriptor object for the compare contributor, used in the creation of a patch.

Specified by:

getPatchDescriptor in interface PatchCompareContributor

Returns:

the patch descriptor object.

getStreamType

public StreamType getStreamType()

getStreamEncoding

public java.lang.String getStreamEncoding()