Package com.intellij.openapi.vfs.encoding

Class EncodingProjectManagerImpl

java.lang.Object

com.intellij.openapi.vfs.encoding.EncodingRegistry

com.intellij.openapi.vfs.encoding.EncodingManager

com.intellij.openapi.vfs.encoding.EncodingProjectManager

com.intellij.openapi.vfs.encoding.EncodingProjectManagerImpl

All Implemented Interfaces:

PersistentStateComponent<Element>, Disposable

public final class EncodingProjectManagerImpl
extends EncodingProjectManager
implements PersistentStateComponent<Element>, Disposable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncodingProjectManagerImpl.BOMForNewUTF8Files

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

Disposable.Parent

Field Summary

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

PROP_NATIVE2ASCII_SWITCH, PROP_PROPERTIES_FILES_ENCODING

Constructor Summary

Constructors

Constructor and Description
EncodingProjectManagerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
void	dispose() Usually not invoked directly, see class javadoc.
java.util.Map<? extends VirtualFile,? extends java.nio.charset.Charset>	getAllMappings()
java.nio.charset.Charset	getCachedCharsetFromContent(Document document)
java.nio.charset.Charset	getConfiguredDefaultCharset()
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()
ModificationTracker	getModificationTracker()
Element	getState()
boolean	isNative2Ascii(VirtualFile virtualFile)
boolean	isNative2AsciiForPropertiesFiles()
void	loadState(Element element) This method is called when new component state is loaded.
void	setBOMForNewUtf8Files(EncodingProjectManagerImpl.BOMForNewUTF8Files option)
void	setDefaultCharsetForPropertiesFiles(VirtualFile virtualFile, java.nio.charset.Charset charset)
void	setDefaultCharsetName(java.lang.String name) Sets Project encoding (configured in Settings|File Encodings|Project Encoding).
void	setEncoding(VirtualFile virtualFileOrDir, java.nio.charset.Charset charset)
void	setMapping(java.util.Map<? extends VirtualFile,? extends java.nio.charset.Charset> mapping)
void	setNative2AsciiForPropertiesFiles(VirtualFile virtualFile, boolean native2Ascii)
boolean	shouldAddBOMForNewUtf8File()

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

getInstance

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

getInstance

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

Constructor Detail

EncodingProjectManagerImpl

public EncodingProjectManagerImpl(Project project)

Method Detail

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

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(Element element)

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<Element>

Parameters:

element - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

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.

getModificationTracker

public ModificationTracker getModificationTracker()

setEncoding

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

Specified by:

setEncoding in class EncodingRegistry

getFavorites

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

Specified by:

getFavorites in class EncodingManager

getAllMappings

public java.util.Map<? extends VirtualFile,? extends java.nio.charset.Charset> getAllMappings()

Returns:

readonly map of current mappings. to modify mappings use setMapping(Map)

setMapping

public void setMapping(java.util.Map<? extends VirtualFile,? extends java.nio.charset.Charset> mapping)

getDefaultCharset

public java.nio.charset.Charset getDefaultCharset()

Specified by:

getDefaultCharset in class EncodingProjectManager

Returns:

Project encoding (configured in Settings|File Encodings|Project Encoding)

getConfiguredDefaultCharset

public java.nio.charset.Charset getConfiguredDefaultCharset()

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

getDefaultCharsetName

public java.lang.String getDefaultCharsetName()

Specified by:

getDefaultCharsetName in class EncodingProjectManager

Returns:

Project encoding name (configured in Settings|File Encodings|Project Encoding) or empty string if it's configured to "System Default"

setDefaultCharsetName

public void setDefaultCharsetName(java.lang.String name)

Description copied from class: EncodingProjectManager

Sets Project encoding (configured in Settings|File Encodings|Project Encoding). Use empty string to specify "System Default"

Specified by:

setDefaultCharsetName in class EncodingProjectManager

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

getCachedCharsetFromContent

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

Specified by:

getCachedCharsetFromContent in class EncodingManager

setBOMForNewUtf8Files

public void setBOMForNewUtf8Files(EncodingProjectManagerImpl.BOMForNewUTF8Files option)

shouldAddBOMForNewUtf8File

public boolean shouldAddBOMForNewUtf8File()

Overrides:

shouldAddBOMForNewUtf8File in class EncodingManager