Package com.bloomberglp.blpapi

Class ConstantsList

java.lang.Object
com.bloomberglp.blpapi.ConstantsList
public abstract class ConstantsList extends 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.

  • Constructor Details

    • ConstantsList

      public ConstantsList()

  • Method Details

    • setUserData

      public abstract void setUserData(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
      Returns:
      name

    • description

      public abstract String description()
      Returns a String containing a human readable description of this ConstantsList
      Returns:
      description

    • status

      public abstract Schema.Status status()
      Returns the status of this ConstantList
      Returns:
      status
      See Also:

    • datatype

      public abstract Schema.Datatype datatype()
      Return the Datatype used to represent the value of this ConstantsList
      Returns:
      data type
      See Also:

    • userData

      public abstract 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(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(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:
      IndexOutOfBoundsException - if index is not in the range of 0 to numConstants() - 1