|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bloomberglp.blpapi.CorrelationID
public final class CorrelationID
A key used to identify individual subscriptions or requests.
Constructor Summary | |
---|---|
CorrelationID()
|
|
CorrelationID(CorrelationID from)
|
|
CorrelationID(long value)
Construct a correlation id object and initialize it with the specified long correlation data |
|
CorrelationID(java.lang.Object value)
Construct a correlation id object and initialize it with the specified Object value correlation data |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
Tests this CorrelationID for equality with another object |
int |
hashCode()
Return the hashcode value for this CorrelationID |
boolean |
isInternal()
Return true if this correlation id object was generated internally by the library false otherwise |
boolean |
isObject()
Return true if this correlation id object was originally initialized with an Object value false otherwise |
boolean |
isValue()
Return true if this correlation id object was originally initialized with a long value false otherwise |
java.lang.Object |
object()
Return the value of this correlation id as a Object value. |
java.lang.String |
toString()
Return a String form of this CorrelationID |
long |
value()
Return the value of this correlation id as a long value. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CorrelationID(long value)
value
- the long value to be used as the correlation datapublic CorrelationID(java.lang.Object value)
value
- the Object value to be used as the correlation datapublic CorrelationID()
public CorrelationID(CorrelationID from)
Method Detail |
---|
public long value()
Note that this function assumes that this correlation id object has been initialized with an long value.
java.lang.IllegalStateException
- if this correlation id was not initialized
with an long valuepublic java.lang.Object object()
Note that this function assumes that this correlation id object has been initialized with an Object value.
java.lang.IllegalStateException
- if this correlation id was not initialized
with an objectpublic boolean isInternal()
public boolean isObject()
public boolean isValue()
public boolean equals(java.lang.Object obj)
If the other Object is not a CorrelationID this method immediately returns false. For two CorrelationID objects to be considered equal both the CorrelationIDs should have a long value or an Object value and the values should be equal
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |