com.bloomberglp.blpapi
Class ConstantsList

java.lang.Object
  com.bloomberglp.blpapi.ConstantsList

public abstract class ConstantsList
extends java.lang.Object

Represents a list of Constant objects in the schema. As well as the list of Constant objects this class also provides access to the symbolic name, description and status of the ConstantsList. All Constant objects in a ConstantsList are of the same Datatype. ConstantLists are read-only and always created by the API, never by the application.

Author:

Chao Yao(cyao3)

Constructor Summary

ConstantsList()

Method Summary

abstract Constant	constantAt(int index) Return a read only Constant from this ConstansList at the specified index
abstract Schema.Datatype	datatype() Return the Datatype used to represent the value of this ConstantsList
abstract java.lang.String	description() Returns a String containing a human readable description of this ConstantsList
abstract Constant	getConstant(Name name) Return a read only Constant from this ConstantsList identified by the specified name
abstract Constant	getConstant(java.lang.String name) Return a read only Constant from this ConstantsList identified by the specified name
abstract boolean	hasConstant(Name name) Return true if this ConstantsList contains a Constant object with the specified name
abstract boolean	hasConstant(java.lang.String name) Return true if this ConstantsList contains a Constant object with the specified name
abstract Name	name() Returns the symbolic name of this ConstantsList
abstract int	numConstants() Return the number of Constant objects contained in this ConstantsList
abstract void	setUserData(java.lang.Object userData) Set the user data associated with this ConstantsList to the specified userData
abstract Schema.Status	status() Returns the status of this ConstantList
abstract java.lang.Object	userData() Returns the user data associated with this ConstantsList.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstantsList

public ConstantsList()

Method Detail

setUserData

public abstract void setUserData(java.lang.Object userData)

Set the user data associated with this ConstantsList to the specified userData

Parameters:

userData - user provided data that is to be associated with this ConstantsList

name

public abstract Name name()

Returns the symbolic name of this ConstantsList

description

public abstract java.lang.String description()

Returns a String containing a human readable description of this ConstantsList

status

public abstract Schema.Status status()

Returns the status of this ConstantList

See Also:

Schema.Status

datatype

public abstract Schema.Datatype datatype()

Return the Datatype used to represent the value of this ConstantsList

See Also:

Schema.Datatype

userData

public abstract java.lang.Object userData()

Returns the user data associated with this ConstantsList. If setUserData(Object) has never been called for this ConstantsList then return null

hasConstant

public abstract boolean hasConstant(Name name)

Return true if this ConstantsList contains a Constant object with the specified name

hasConstant

public abstract boolean hasConstant(java.lang.String name)

Return true if this ConstantsList contains a Constant object with the specified name

getConstant

public abstract Constant getConstant(Name name)

Return a read only Constant from this ConstantsList identified by the specified name

Throws:

NotFoundException - if this ConstansList does not contain a Constant with the specified name.

getConstant

public abstract Constant getConstant(java.lang.String name)

Return a read only Constant from this ConstantsList identified by the specified name

Throws:

NotFoundException - if this ConstansList does not contain a Constant with the specified name.

numConstants

public abstract int numConstants()

Return the number of Constant objects contained in this ConstantsList

constantAt

public abstract Constant constantAt(int index)

Return a read only Constant from this ConstansList at the specified index

Throws:

java.lang.IndexOutOfBoundsException - if index is not in the range of 0 to numConstants() - 1