Package com.intellij.openapi.vfs.encoding

Class EncodingManagerImpl

java.lang.Object

com.intellij.openapi.vfs.encoding.EncodingRegistry

com.intellij.openapi.vfs.encoding.EncodingManager

com.intellij.openapi.vfs.encoding.EncodingManagerImpl

All Implemented Interfaces:

PersistentStateComponent<com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State>, Disposable

public class EncodingManagerImpl
extends EncodingManager
implements PersistentStateComponent<com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State>, Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_CACHED_ENCODING_CHANGED

Fields inherited from class com.intellij.openapi.vfs.encoding.EncodingManager

PROP_NATIVE2ASCII_SWITCH, PROP_PROPERTIES_FILES_ENCODING

Constructor Summary

Constructors

Constructor and Description
EncodingManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	clearDocumentQueue()
void	dispose() Usually not invoked directly, see class javadoc.
java.nio.charset.Charset	getCachedCharsetFromContent(Document document)
java.nio.charset.Charset	getDefaultCharset()
java.nio.charset.Charset	getDefaultCharsetForPropertiesFiles(VirtualFile virtualFile)
java.lang.String	getDefaultCharsetName()
java.nio.charset.Charset	getEncoding(VirtualFile virtualFile, boolean useParentDefaults)
java.util.Collection<java.nio.charset.Charset>	getFavorites()
com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State	getState()
boolean	isNative2Ascii(VirtualFile virtualFile)
boolean	isNative2AsciiForPropertiesFiles()
void	loadState(com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State state) This method is called when new component state is loaded.
void	setDefaultCharsetForPropertiesFiles(VirtualFile virtualFile, java.nio.charset.Charset charset)
void	setDefaultCharsetName(java.lang.String name)
void	setEncoding(VirtualFile virtualFileOrDir, java.nio.charset.Charset charset)
void	setNative2AsciiForPropertiesFiles(VirtualFile virtualFile, boolean native2Ascii)

Methods inherited from class com.intellij.openapi.vfs.encoding.EncodingManager

getInstance, shouldAddBOMForNewUtf8File

Methods inherited from class com.intellij.openapi.vfs.encoding.EncodingRegistry

doActionAndRestoreEncoding

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Field Detail

PROP_CACHED_ENCODING_CHANGED

public static final java.lang.String PROP_CACHED_ENCODING_CHANGED

See Also:

Constant Field Values

Constructor Detail

EncodingManagerImpl

public EncodingManagerImpl()

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getCachedCharsetFromContent

public java.nio.charset.Charset getCachedCharsetFromContent(Document document)

Specified by:

getCachedCharsetFromContent in class EncodingManager

getState

public com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State getState()

Specified by:

getState in interface PersistentStateComponent<com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

loadState

public void loadState(com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<com.intellij.openapi.vfs.encoding.EncodingManagerImpl.State>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getFavorites

public java.util.Collection<java.nio.charset.Charset> getFavorites()

Specified by:

getFavorites in class EncodingManager

getEncoding

public java.nio.charset.Charset getEncoding(VirtualFile virtualFile,
                                            boolean useParentDefaults)

Specified by:

getEncoding in class EncodingRegistry

Parameters:

virtualFile - file to get encoding for

useParentDefaults - true to determine encoding from the parent

Returns:

encoding configured for this file in Settings|File Encodings or, if useParentDefaults is true, encoding configured for nearest parent of virtualFile or, null if there is no configured encoding found.

clearDocumentQueue

public void clearDocumentQueue()

setEncoding

public void setEncoding(VirtualFile virtualFileOrDir,
                        java.nio.charset.Charset charset)

Specified by:

setEncoding in class EncodingRegistry

isNative2Ascii

public boolean isNative2Ascii(VirtualFile virtualFile)

Specified by:

isNative2Ascii in class EncodingRegistry

isNative2AsciiForPropertiesFiles

public boolean isNative2AsciiForPropertiesFiles()

Specified by:

isNative2AsciiForPropertiesFiles in class EncodingManager

setNative2AsciiForPropertiesFiles

public void setNative2AsciiForPropertiesFiles(VirtualFile virtualFile,
                                              boolean native2Ascii)

Specified by:

setNative2AsciiForPropertiesFiles in class EncodingManager

getDefaultCharset

public java.nio.charset.Charset getDefaultCharset()

Specified by:

getDefaultCharset in class EncodingRegistry

Returns:

charset configured in Settings|File Encodings|IDE encoding

getDefaultCharsetName

public java.lang.String getDefaultCharsetName()

Specified by:

getDefaultCharsetName in class EncodingManager

Returns:

returns empty for system default

setDefaultCharsetName

public void setDefaultCharsetName(java.lang.String name)

Overrides:

setDefaultCharsetName in class EncodingManager

getDefaultCharsetForPropertiesFiles

public java.nio.charset.Charset getDefaultCharsetForPropertiesFiles(VirtualFile virtualFile)

Specified by:

getDefaultCharsetForPropertiesFiles in class EncodingManager

Returns:

null for system-default

setDefaultCharsetForPropertiesFiles

public void setDefaultCharsetForPropertiesFiles(VirtualFile virtualFile,
                                                java.nio.charset.Charset charset)

Specified by:

setDefaultCharsetForPropertiesFiles in class EncodingManager