Package com.intellij.openapi.diff

Class SimpleContent

java.lang.Object

com.intellij.openapi.diff.DiffContent

com.intellij.openapi.diff.SimpleContent

public class SimpleContent
extends DiffContent

Allows to compare some text not associated with file or document.

See Also:

getText(), setReadOnly(boolean)

Constructor Summary

Constructors

Constructor and Description
SimpleContent(java.lang.String text) Constructs content with given text and null type
SimpleContent(java.lang.String text, FileType type)

Method Summary

Modifier and Type	Method and Description
static SimpleContent	createEmpty()
static SimpleContent	fromBytes(byte[] bytes, java.lang.String charset, FileType fileType)
static DiffContent	fromIoFile(java.io.File file, java.lang.String charset, FileType fileType)
byte[]	getBytes()
java.nio.charset.Charset	getCharset()
FileType	getContentType()
Document	getDocument() Represents this content as Document null means content has no text representation
VirtualFile	getFile()
LineSeparator	getLineSeparator()
Navigatable	getOpenFileDescriptor(int offset) Provides a way to open given text place in editor null means given offset can't be opened in editor
java.lang.String	getText()
void	setBOM(byte[] BOM)
void	setCharset(java.nio.charset.Charset charset)
void	setReadOnly(boolean readOnly) Make this content editable or not.

Methods inherited from class com.intellij.openapi.diff.DiffContent

fromDocument, fromFile, isBinary, isEmpty, setIsEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleContent

public SimpleContent(java.lang.String text)

Constructs content with given text and null type

SimpleContent

public SimpleContent(java.lang.String text,
                     FileType type)

Method Detail

createEmpty

public static SimpleContent createEmpty()

setReadOnly

public void setReadOnly(boolean readOnly)

Make this content editable or not. By default SimpleContent isn't editable.

getText

public java.lang.String getText()

Returns:

modified text.

See Also:

setReadOnly(boolean)

getDocument

public Document getDocument()

Description copied from class: DiffContent

Represents this content as Document null means content has no text representation

Specified by:

getDocument in class DiffContent

Returns:

document associated with this content

getOpenFileDescriptor

public Navigatable getOpenFileDescriptor(int offset)

Description copied from class: DiffContent

Provides a way to open given text place in editor null means given offset can't be opened in editor

Specified by:

getOpenFileDescriptor in class DiffContent

Parameters:

offset - in document returned by DiffContent.getDocument()

Returns:

null

getFile

public VirtualFile getFile()

Specified by:

getFile in class DiffContent

Returns:

null

getContentType

public FileType getContentType()

Specified by:

getContentType in class DiffContent

Returns:

FileType of content. null means use other content's type for this one

getBytes

public byte[] getBytes()

Specified by:

getBytes in class DiffContent

Returns:

Encodes using default encoding

getLineSeparator

public LineSeparator getLineSeparator()

Overrides:

getLineSeparator in class DiffContent

Returns:

line separator used in this content, or null if it is unknown.

getCharset

public java.nio.charset.Charset getCharset()

setCharset

public void setCharset(java.nio.charset.Charset charset)

fromBytes

public static SimpleContent fromBytes(byte[] bytes,
                                      java.lang.String charset,
                                      FileType fileType)
                               throws java.io.UnsupportedEncodingException

Parameters:

bytes - binary text representation

charset - name of charset. If null IDE default charset will be used

fileType - content type. If null file name will be used to select file type

Returns:

content representing bytes as text

Throws:

java.io.UnsupportedEncodingException - On encoding errors.

fromIoFile

public static DiffContent fromIoFile(java.io.File file,
                                     java.lang.String charset,
                                     FileType fileType)
                              throws java.io.IOException

Parameters:

file - should exist and not to be a directory

charset - name of file charset. If null IDE default charset will be used

fileType - content type. If null file name will be used to select file type

Returns:

Content representing text in file

Throws:

java.io.IOException - On I/O errors.

setBOM

public void setBOM(byte[] BOM)