Package com.intellij.openapi.fileEditor.impl

Class LoadTextUtil

java.lang.Object

com.intellij.openapi.fileEditor.impl.LoadTextUtil

public final class LoadTextUtil
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoadTextUtil.AutoDetectionReason
static class	LoadTextUtil.DetectResult

Method Summary

Modifier and Type	Method and Description
static void	changeLineSeparators(Project project, VirtualFile file, java.lang.String newSeparator, java.lang.Object requestor)
static Pair.NonNull<java.nio.charset.Charset,byte[]>	charsetForWriting(Project project, VirtualFile virtualFile, java.lang.String text, java.nio.charset.Charset existing)
static java.nio.charset.Charset	charsetFromContentOrNull(Project project, VirtualFile virtualFile, java.lang.CharSequence text)
static Pair.NonNull<java.nio.charset.Charset,byte[]>	chooseMostlyHarmlessCharset(java.nio.charset.Charset existing, java.nio.charset.Charset specified, java.lang.String text)
static void	clearCharsetAutoDetectionReason(VirtualFile virtualFile)
static java.nio.charset.Charset	detectCharsetAndSetBOM(VirtualFile virtualFile, byte [] content, FileType fileType)
static java.lang.String	detectLineSeparator(VirtualFile file, boolean checkFile) Get detected line separator, if the file never been loaded, is loaded if checkFile parameter is specified.
static java.nio.charset.Charset	extractCharsetFromFileContent(Project project, VirtualFile virtualFile, java.lang.CharSequence text)
static LoadTextUtil.AutoDetectionReason	getCharsetAutoDetectionReason(VirtualFile virtualFile)
static java.lang.CharSequence	getTextByBinaryPresentation(byte [] bytes, java.nio.charset.Charset charset)
static java.lang.CharSequence	getTextByBinaryPresentation(byte [] bytes, VirtualFile virtualFile)
static java.lang.CharSequence	getTextByBinaryPresentation(byte [] bytes, VirtualFile virtualFile, boolean saveDetectedSeparators, boolean saveBOM)
static java.lang.String	getTextFromBytesOrNull(byte [] bytes, int startOffset, int endOffset) Tries to detect text in the bytes and call the fileTextProcessor with the text (if detected) or with null if not
static LoadTextUtil.DetectResult	guessFromContent(VirtualFile virtualFile, byte [] content)
static java.lang.CharSequence	loadText(VirtualFile file)
static java.lang.CharSequence	loadText(VirtualFile file, int limit) Loads content of given virtual file.
static FileType	processTextFromBinaryPresentationOrNull(byte [] bytes, int length, VirtualFile virtualFile, boolean saveDetectedSeparators, boolean saveBOM, FileType fileType, NotNullFunction<? super java.lang.CharSequence,? extends FileType> fileTextProcessor)
static void	write(Project project, VirtualFile virtualFile, java.lang.Object requestor, java.lang.String text, long newModificationStamp) Overwrites file with text and sets modification stamp and time stamp to the specified values.

Methods inherited from class java.lang.Object

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

Method Detail

detectCharsetAndSetBOM

public static java.nio.charset.Charset detectCharsetAndSetBOM(VirtualFile virtualFile,
                                                              byte [] content,
                                                              FileType fileType)

guessFromContent

public static LoadTextUtil.DetectResult guessFromContent(VirtualFile virtualFile,
                                                         byte [] content)

getTextFromBytesOrNull

public static java.lang.String getTextFromBytesOrNull(byte [] bytes,
                                                      int startOffset,
                                                      int endOffset)

Tries to detect text in the bytes and call the fileTextProcessor with the text (if detected) or with null if not

changeLineSeparators

public static void changeLineSeparators(Project project,
                                        VirtualFile file,
                                        java.lang.String newSeparator,
                                        java.lang.Object requestor)
                                 throws java.io.IOException

Throws:

java.io.IOException

write

public static void write(Project project,
                         VirtualFile virtualFile,
                         java.lang.Object requestor,
                         java.lang.String text,
                         long newModificationStamp)
                  throws java.io.IOException

Overwrites file with text and sets modification stamp and time stamp to the specified values.

Normally you should not use this method.

Parameters:

requestor - any object to control who called this method. Note that it is considered to be an external change if requestor is null. See VirtualFileEvent.getRequestor()

newModificationStamp - new modification stamp or -1 if no special value should be set @return Writer

Throws:

java.io.IOException - if an I/O error occurs

See Also:

VirtualFile.getModificationStamp()

charsetForWriting

public static Pair.NonNull<java.nio.charset.Charset,byte[]> charsetForWriting(Project project,
                                                                              VirtualFile virtualFile,
                                                                              java.lang.String text,
                                                                              java.nio.charset.Charset existing)

chooseMostlyHarmlessCharset

public static Pair.NonNull<java.nio.charset.Charset,byte[]> chooseMostlyHarmlessCharset(java.nio.charset.Charset existing,
                                                                                        java.nio.charset.Charset specified,
                                                                                        java.lang.String text)

extractCharsetFromFileContent

public static java.nio.charset.Charset extractCharsetFromFileContent(Project project,
                                                                     VirtualFile virtualFile,
                                                                     java.lang.CharSequence text)

charsetFromContentOrNull

public static java.nio.charset.Charset charsetFromContentOrNull(Project project,
                                                                VirtualFile virtualFile,
                                                                java.lang.CharSequence text)

loadText

public static java.lang.CharSequence loadText(VirtualFile file)

loadText

public static java.lang.CharSequence loadText(VirtualFile file,
                                              int limit)

Loads content of given virtual file. If limit is then full CharSequence will be returned. Else CharSequence will be truncated by limit if it has bigger length.

Parameters:

file - Virtual file for content loading

limit - Maximum characters count or

Returns:

Full or truncated CharSequence with file content

Throws:

java.lang.IllegalArgumentException - for binary files

getTextByBinaryPresentation

public static java.lang.CharSequence getTextByBinaryPresentation(byte [] bytes,
                                                                 VirtualFile virtualFile)

getTextByBinaryPresentation

public static java.lang.CharSequence getTextByBinaryPresentation(byte [] bytes,
                                                                 VirtualFile virtualFile,
                                                                 boolean saveDetectedSeparators,
                                                                 boolean saveBOM)

processTextFromBinaryPresentationOrNull

public static FileType processTextFromBinaryPresentationOrNull(byte [] bytes,
                                                               int length,
                                                               VirtualFile virtualFile,
                                                               boolean saveDetectedSeparators,
                                                               boolean saveBOM,
                                                               FileType fileType,
                                                               NotNullFunction<? super java.lang.CharSequence,? extends FileType> fileTextProcessor)

detectLineSeparator

public static java.lang.String detectLineSeparator(VirtualFile file,
                                                   boolean checkFile)

Get detected line separator, if the file never been loaded, is loaded if checkFile parameter is specified.

Parameters:

file - the file to check

checkFile - if the line separator was not detected before, try to detect it

Returns:

the detected line separator or null

getTextByBinaryPresentation

public static java.lang.CharSequence getTextByBinaryPresentation(byte [] bytes,
                                                                 java.nio.charset.Charset charset)

getCharsetAutoDetectionReason

public static LoadTextUtil.AutoDetectionReason getCharsetAutoDetectionReason(VirtualFile virtualFile)

clearCharsetAutoDetectionReason

public static void clearCharsetAutoDetectionReason(VirtualFile virtualFile)