com.bloomberglp.blpapi
Class Name

java.lang.Object
  com.bloomberglp.blpapi.Name

public final class Name
extends java.lang.Object

Name objects are used to identify and access the classes which define the schema - SchemaTypeDefinition, SchemaElementDefinition, Constant, ConstantsList. They are also used to access the values in Element objects and Message objects.

The Name class is an efficient substitute for a string when used as a key, providing constant time comparison and ordering operations. Two Name objects constructed from Strings for which equals() would return 'true' will always compare equally.

This is where possible Name objects should be initialized once and then reused. Creating a Name object from a String involves a search in a container requiring multiple string comparison operations.

Note: Each Name instance refers to an entry in a global static table. Name instances for identical strings will refer to the same data. There is no provision for removing entries from the static table so Name objects should only be used when the set of input strings is bounded.

For example, creating a Name for every possible field name and type in a data model is reasonable (in fact, the API will do this whenever it receives schema information). However, converting sequence numbers on incoming messages to strings and creating a Name from each one of those strings will cause the static table to grow in an unbounded manner.

Author:

Siva Somu (ssomu)

Field Summary

static Name

NullName

Constructor Summary

Name()

Name(java.lang.String nameString)
Construct a Name from the specified nameString

Method Summary

boolean	equals(java.lang.Object other) Compares this Name object to the specified Object
static Name	findName(java.lang.String nameString) Return a reference to a Name object for the specified nameString or null if a Name does not exist.
static Name	getName(java.lang.String nameString) Return a reference to a Name object for the specified nameString creating it if it doesn't exist already
int	hashCode() Return a hashcode value for this Name object
static boolean	hasName(java.lang.String nameString) Return true if a reference to a Name object exists for the specified nameString
java.lang.String	toString() Return the String this Name object represents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

NullName

public static final Name NullName

Constructor Detail

Name

public Name()

Name

public Name(java.lang.String nameString)

Construct a Name from the specified nameString

Constructing a Name from a String is a relatively expensive operation. If a Name will be used repeatedly it is preferable to create it once and re-use the object.

Method Detail

getName

public static Name getName(java.lang.String nameString)

Return a reference to a Name object for the specified nameString creating it if it doesn't exist already

findName

public static Name findName(java.lang.String nameString)

Return a reference to a Name object for the specified nameString or null if a Name does not exist.

hasName

public static boolean hasName(java.lang.String nameString)

Return true if a reference to a Name object exists for the specified nameString

equals

public boolean equals(java.lang.Object other)

Compares this Name object to the specified Object

The result of the comparison is true if and only if the specified Object is not null and this Name object contains the same value as the specified Name

Overrides:

equals in class java.lang.Object

Returns:

true if the objects are the same false otherwise

hashCode

public int hashCode()

Return a hashcode value for this Name object

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Return the String this Name object represents

Overrides:

toString in class java.lang.Object