Click or drag to resize
Name Class
Name objects are used to identify and access the classes which define the schema.
Inheritance Hierarchy
SystemObject
  Bloomberglp.BlpapiName

Namespace:  Bloomberglp.Blpapi
Assembly:  Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.14.3.1
Syntax
[SerializableAttribute]
public sealed class Name

The Name type exposes the following members.

Constructors
  NameDescription
Public methodName
Default constructed Name. All default constructed Name objects are equivalent to NullName.
Public methodName(String)
Constructs a Name from the specified nameString.
Top
Methods
  NameDescription
Public methodEquals
Compares this Name object to the specified Object.
(Overrides ObjectEquals(Object).)
Public methodStatic memberFindName
Returns a reference to a Name object for the specified nameString or null if a Name does not exist.
Public methodStatic memberFreeGlobalNameTable
Purges all entries from the global name table.
Public methodGetHashCode
GetHashCode() override to correspond to Equals(Object) Equals()
(Overrides ObjectGetHashCode.)
Public methodStatic memberGetName
Returns a reference to a Name object for the specified nameString creating it if it doesn't exist already.
Public methodStatic memberHasName
Returns true if a reference to a Name object exists for the specified nameString.
Public methodToString
Returns the String this Name object represents.
(Overrides ObjectToString.)
Top
Fields
  NameDescription
Public fieldStatic memberNullName
Name object representing no actual string.
Top
Remarks
Name objects are used to identify and access the classes which define the schema. SchemaTypeDefinition, SchemaElementDefinition, Constant, and 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.

Thread Safety
Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.
See Also