com.yworks.yfiles.algorithms

Class DpKeyBase<TValue>

java.lang.Object

com.yworks.yfiles.algorithms.DpKeyBase<TValue>

Type Parameters:

TValue - The type of the values that are returned by the IDataProvider registered with this class.

Direct Known Subclasses:

EdgeDpKey, GraphDpKey, GraphObjectDpKey, IEdgeLabelLayoutDpKey, ILabelLayoutDpKey, INodeLabelLayoutDpKey, NodeDpKey

public class DpKeyBase<TValue>
extends Object

This is the base class of all look-up keys that are used to register IDataProvider with a Graph.

Constructor Summary

Constructors

Constructor and Description
DpKeyBase(Class declaringType, String name) Initializes a new instance of the DpKeyBase class.

Method Summary

Modifier and Type	Method and Description
protected boolean	equals(DpKeyBase<TValue> other) Returns whether this key is equal to the specified other.
boolean	equals(Object obj) Determines whether the specified Object is equal to this instance.
Class	getDeclaringType() Gets the type that declares this key.
String	getName() Gets the name of this key.
int	hashCode() Returns a hash code for this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DpKeyBase

public DpKeyBase(Class declaringType,
                 String name)

Initializes a new instance of the DpKeyBase class.

Parameters:

declaringType - Type that declares this key.

name - The name of this key.

Method Detail

equals

protected final boolean equals(DpKeyBase<TValue> other)

Returns whether this key is equal to the specified other.

Parameters:

other - The other key to compare with this instance.

Returns:

true if the specified key is equal to this instance; otherwise, false.

equals

public boolean equals(Object obj)

Determines whether the specified Object is equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The Object to compare with this instance.

Returns:

true if the specified Object is equal to this instance; otherwise, false.

getDeclaringType

public final Class getDeclaringType()

Gets the type that declares this key.

Returns:

The type that declares this key.

getName

public final String getName()

Gets the name of this key.

Returns:

The name of this key.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class Object

Returns:

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.