Package com.intellij.openapi.vcs.readOnlyHandler

Class ReadonlyStatusHandlerImpl

java.lang.Object

com.intellij.openapi.vfs.ReadonlyStatusHandler

com.intellij.openapi.vcs.readOnlyHandler.ReadonlyStatusHandlerImpl

All Implemented Interfaces:

PersistentStateComponent<ReadonlyStatusHandlerImpl.State>

public class ReadonlyStatusHandlerImpl
extends ReadonlyStatusHandler
implements PersistentStateComponent<ReadonlyStatusHandlerImpl.State>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadonlyStatusHandlerImpl.State

Nested classes/interfaces inherited from class com.intellij.openapi.vfs.ReadonlyStatusHandler

ReadonlyStatusHandler.OperationStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	myClearReadOnlyInTests

Constructor Summary

Constructors

Constructor and Description
ReadonlyStatusHandlerImpl(Project project)

Method Summary

Modifier and Type	Method and Description
ReadonlyStatusHandler.OperationStatus	ensureFilesWritable(java.util.Collection<? extends VirtualFile> files)
ReadonlyStatusHandlerImpl.State	getState()
void	loadState(ReadonlyStatusHandlerImpl.State state) This method is called when new component state is loaded.
static void	processFiles(java.util.List<com.intellij.openapi.vcs.readOnlyHandler.FileInfo> fileInfos, java.lang.String changelist)
void	setClearReadOnlyInTests(boolean clearReadOnlyInTests) Normally when file is read-only and ensureFilesWritable is called, a dialog box appears which allows user to decide whether to clear read-only flag or not.

Methods inherited from class com.intellij.openapi.vfs.ReadonlyStatusHandler

ensureDocumentWritable, ensureFilesWritable, ensureFilesWritable, getInstance

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

myClearReadOnlyInTests

protected boolean myClearReadOnlyInTests

Constructor Detail

ReadonlyStatusHandlerImpl

public ReadonlyStatusHandlerImpl(Project project)

Method Detail

getState

public ReadonlyStatusHandlerImpl.State getState()

Specified by:

getState in interface PersistentStateComponent<ReadonlyStatusHandlerImpl.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(ReadonlyStatusHandlerImpl.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<ReadonlyStatusHandlerImpl.State>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

ensureFilesWritable

public ReadonlyStatusHandler.OperationStatus ensureFilesWritable(java.util.Collection<? extends VirtualFile> files)

Specified by:

ensureFilesWritable in class ReadonlyStatusHandler

processFiles

public static void processFiles(java.util.List<com.intellij.openapi.vcs.readOnlyHandler.FileInfo> fileInfos,
                                java.lang.String changelist)

setClearReadOnlyInTests

public void setClearReadOnlyInTests(boolean clearReadOnlyInTests)

Normally when file is read-only and ensureFilesWritable is called, a dialog box appears which allows user to decide whether to clear read-only flag or not. This method allows to control what will happen in unit-test mode.

Parameters:

clearReadOnlyInTests - if true, ensureFilesWritable will try to clear read-only status from passed files. Otherwise, read-only status is not modified (as if user refused to modify it).