Package com.intellij.openapi.util

Class UserDataHolderBase

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

AbstractExternalSystemTask, AbstractFileViewProvider, AbstractProgressIndicatorBase, AnnotationSession, ArtifactImpl, CachedFileContent, CaretImpl, Client, CommenterDataHolder, CompileContextImpl, CompileContextImpl, CompiledClass, ContentImpl, DebugProcessImpl, DefaultProjectResolverContext, DesignerEditor, DiffContentBase, DiffRequestChainBase, DirtyScopeHolder, DnDEventImpl, DocumentImpl, DomInvocationHandler, DummyProject, EditorImpl, EditorTextFieldRendererDocument, EditorWindowImpl, ElementBase, ExecutionEnvironment, ExportableUserDataHolderBase, ExternalSystemRunnableState, Facet, FacetEditorContextBase, FactorTree, FindModel, FrameworkSupportModelBase, GenerationNode, GlobalInspectionContextBase, ImaginaryEditor, IndexedFileImpl, JavaChangeInfoImpl, Language, LargeFileEditorImpl, LightweightHint, LocalInspectionToolSession, LookupElement, MarkdownPreviewFileEditor, MarkupModelImpl, MarkupModelWindow, MockComponentManager, ModuleConfigurationStateImpl, ObjectStubBase, ParameterInfo, ParameterInfoController, PerspectiveFileEditor, PomModelImpl, PreloadedData, ProcessHandler, ProjectJdkImpl, ProjectTaskContext, PsiManager, PyClassTypeImpl, PyCustomMember, RangeMarkerImpl, RefactoringEventData, RefEntityImpl, ResourceBundleEditor, RestPreviewFileEditor, RunConfigurationBase, SceneBuilderEditor, SearchSession, SplitFileEditor, StatementUpDownMover.MoveInfo, TargetedCommandLineBuilder, TerminalSessionEditor, TextComponentEditorImpl, TextEditorImpl, TextEditorProvider.EditorWrapper, TextEditorWithPreview, UIFormEditor, VirtualFile, WizardContext, XBreakpointBase, XDebugSessionData

public class UserDataHolderBase
extends java.lang.Object
implements UserDataHolderEx

Constructor Summary

Constructors

Constructor and Description
UserDataHolderBase()

Method Summary

Modifier and Type	Method and Description
protected boolean	changeUserMap(KeyFMap oldMap, KeyFMap newMap)
protected void	clearUserData()
protected java.lang.Object	clone()
void	copyCopyableDataTo(UserDataHolderBase clone)
void	copyUserDataTo(UserDataHolderBase other)
<T> T	getCopyableUserData(Key<T> key)
<T> T	getUserData(Key<T> key)
java.lang.String	getUserDataString()
protected KeyFMap	getUserMap()
boolean	isUserDataEmpty()
<T> void	putCopyableUserData(Key<T> key, T value)
<T> void	putUserData(Key<T> key, T value) Add a new user data value to this object.
<T> T	putUserDataIfAbsent(Key<T> key, T value)
<T> boolean	replace(Key<T> key, T oldValue, T newValue) Replaces (atomically) old value in the map with the new one
protected void	setUserMap(KeyFMap map)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDataHolderBase

public UserDataHolderBase()

Method Detail

clone

protected java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getUserDataString

public java.lang.String getUserDataString()

copyUserDataTo

public void copyUserDataTo(UserDataHolderBase other)

getUserData

public <T> T getUserData(Key<T> key)

Specified by:

getUserData in interface UserDataHolder

Returns:

a user data value associated with this object. Doesn't require read action.

getUserMap

protected KeyFMap getUserMap()

putUserData

public <T> void putUserData(Key<T> key,
                            T value)

Description copied from interface: UserDataHolder

Add a new user data value to this object. Doesn't require write action.

Specified by:

putUserData in interface UserDataHolder

changeUserMap

protected boolean changeUserMap(KeyFMap oldMap,
                                KeyFMap newMap)

getCopyableUserData

public <T> T getCopyableUserData(Key<T> key)

putCopyableUserData

public <T> void putCopyableUserData(Key<T> key,
                                    T value)

replace

public <T> boolean replace(Key<T> key,
                           T oldValue,
                           T newValue)

Description copied from interface: UserDataHolderEx

Replaces (atomically) old value in the map with the new one

Specified by:

replace in interface UserDataHolderEx

Returns:

true if old value got replaced, false otherwise

See Also:

ConcurrentMap.replace(Object, Object, Object)

putUserDataIfAbsent

public <T> T putUserDataIfAbsent(Key<T> key,
                                 T value)

Specified by:

putUserDataIfAbsent in interface UserDataHolderEx

Returns:

written or already existing value

copyCopyableDataTo

public void copyCopyableDataTo(UserDataHolderBase clone)

clearUserData

protected void clearUserData()

setUserMap

protected void setUserMap(KeyFMap map)

isUserDataEmpty

public boolean isUserDataEmpty()