Package com.intellij.openapi.externalSystem.model

Class Key<T>

java.lang.Object

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

Type Parameters:

T - data class

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Key<?>>

public final class Key<T>
extends java.lang.Object
implements java.lang.Comparable<Key<?>>, java.io.Serializable

The basic design of external system integration assumes that target project info if represented as a generic graph of DataNode objects where every DataNode content type is identified by an instance of this class.

That makes it possible to register custom DataNode processor per-Key

Thread-safe.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Key(java.lang.String dataClass, int processingWeight) Creates new Key object.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Key<?> that)
static <T> Key<T>	create(java.lang.Class<T> dataClass, int processingWeight)
boolean	equals(java.lang.Object o)
java.lang.String	getDataType()
int	getProcessingWeight() There is a possible case that when a DataNode object has children of more than on type (children with more than one different Key we might want to process one type of children before another.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Key

public Key(java.lang.String dataClass,
           int processingWeight)

Creates new Key object.

Parameters:

dataClass - class of the payload data which will be associated with the current key

processingWeight - there is a possible case that when a DataNode object has children of more than on type (children with more than one different Key we might want to process one type of children before another. That's why we need a way to define that processing order. This parameter serves exactly for that - lower value means that key's payload should be processed before payload of the key with a greater value

Method Detail

create

public static <T> Key<T> create(java.lang.Class<T> dataClass,
                                int processingWeight)

getDataType

public java.lang.String getDataType()

getProcessingWeight

public int getProcessingWeight()

There is a possible case that when a DataNode object has children of more than on type (children with more than one different Key we might want to process one type of children before another. That's why we need a way to define that processing order. This property serves exactly for that - lower value means that key's payload should be processed before payload of the key with a greater value.

Returns:

processing weight for data associated with the current key

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

compareTo

public int compareTo(Key<?> that)

Specified by:

compareTo in interface java.lang.Comparable<Key<?>>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object