Package com.intellij.openapi.externalSystem.model

Class DataNode<T>

java.lang.Object

com.intellij.openapi.externalSystem.model.DataNode<T>

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx, java.io.Serializable

public class DataNode<T>
extends java.lang.Object
implements UserDataHolderEx, java.io.Serializable

This class provides a generic graph infrastructure with ability to store particular data. The main purpose is to allow easy extensible data domain construction.

Example: we might want to describe project model like 'project' which has multiple 'module' children where every 'module' has a collection of child 'content root' and dependencies nodes etc. When that is done, plugins can easily enhance any project. For example, particular framework can add facet settings as one more 'project' node's child.

Not thread-safe.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataNode(Key<T> key, T data, DataNode<?> parent)

Method Summary

Modifier and Type	Method and Description
void	addChild(DataNode<?> child)
void	clear(boolean removeFromGraph)
<T> DataNode<T>	createChild(Key<T> key, T data)
boolean	equals(java.lang.Object o)
java.util.Collection<DataNode<?>>	getChildren()
<T> T	getCopyableUserData(Key<T> key)
T	getData()
<T> T	getData(Key<T> key) Allows to retrieve data stored for the given key at the current node or any of its parents.
<T> DataNode<T>	getDataNode(Key<T> key)
Key<T>	getKey()
DataNode<?>	getParent()
<P> DataNode<P>	getParent(java.lang.Class<P> dataClass)
<U> U	getUserData(Key<U> key)
DataNode<T>	graphCopy()
int	hashCode()
boolean	isIgnored()
boolean	isReady()
DataNode<T>	nodeCopy()
static <T> DataNode<T>	nodeCopy(DataNode<T> dataNode)
<T> void	putCopyableUserData(Key<T> key, T value)
<U> void	putUserData(Key<U> key, U value) Add a new user data value to this object.
<D> D	putUserDataIfAbsent(Key<D> key, D value)
<U> void	removeUserData(Key<U> key)
<D> boolean	replace(Key<D> key, D oldValue, D newValue) Replaces (atomically) old value in the map with the new one
void	setIgnored(boolean ignored)
java.lang.String	toString()
boolean	validateData()
void	visit(java.util.function.Consumer<? super DataNode<?>> consumer)
void	visitData(java.util.function.Function visitor) Allows to replace or modify data.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataNode

public DataNode(Key<T> key,
                T data,
                DataNode<?> parent)

Method Detail

isReady

public boolean isReady()

getParent

public DataNode<?> getParent()

createChild

public <T> DataNode<T> createChild(Key<T> key,
                                   T data)

getKey

public Key<T> getKey()

getData

public T getData()

isIgnored

public boolean isIgnored()

setIgnored

public void setIgnored(boolean ignored)

visitData

public void visitData(java.util.function.Function visitor)

Allows to replace or modify data. If function returns null, data is left unchanged

Parameters:

visitor - visitor. Must accept argument of type T and return value of type T

getData

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

Allows to retrieve data stored for the given key at the current node or any of its parents.

Type Parameters:

D - target data type

Parameters:

key - target data's key

Returns:

data stored for the current key and available via the current node (if any)

getDataNode

public <T> DataNode<T> getDataNode(Key<T> key)

getParent

public <P> DataNode<P> getParent(java.lang.Class<P> dataClass)

addChild

public void addChild(DataNode<?> child)

getChildren

public java.util.Collection<DataNode<?>> getChildren()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clear

public void clear(boolean removeFromGraph)

graphCopy

public DataNode<T> graphCopy()

nodeCopy

public DataNode<T> nodeCopy()

getUserData

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

Specified by:

getUserData in interface UserDataHolder

Returns:

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

putUserData

public <U> void putUserData(Key<U> key,
                            U 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

removeUserData

public <U> void removeUserData(Key<U> key)

putUserDataIfAbsent

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

Specified by:

putUserDataIfAbsent in interface UserDataHolderEx

Returns:

written or already existing value

replace

public <D> boolean replace(Key<D> key,
                           D oldValue,
                           D 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)

putCopyableUserData

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

getCopyableUserData

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

validateData

public boolean validateData()

nodeCopy

public static <T> DataNode<T> nodeCopy(DataNode<T> dataNode)

visit

public final void visit(java.util.function.Consumer<? super DataNode<?>> consumer)