Class MessageIterator

java.lang.Object
com.bloomberglp.blpapi.MessageIterator
All Implemented Interfaces:
Iterator<Message>

public class MessageIterator extends Object implements Iterator<Message>
An iterator over the Message objects within an Event

MessageIterator objects are used to process the individual Message objects in an Event received in an EventHandler, from EventQueue.nextEvent() or from AbstractSession.nextEvent(). This class is used to iterate over each message in an Event.

You can use the MessageIterator as follows


 MessageIterator msgIter = event.messageIterator();
 while (msgIter.hasNext()) {
     Message msg = msgIter.next();
     ...
 }
 
  • Method Details

    • next

      public Message next()
      Return the next element in the iteration

      Return the next element in the iteration and Attempts to advance this MessageIterator to the next Message in this Event

      Specified by:
      next in interface Iterator<Message>
      Returns:
      the next Message in the iteration
      Throws:
      NoSuchElementException - if the iteration has no more elements
    • hasNext

      public boolean hasNext()
      Returns true if the iteration has more elements.

      (In other words, returns true if next() would return an element rather than throwing an exception.)

      Specified by:
      hasNext in interface Iterator<Message>
      Returns:
      true if the iterator has more elements
    • remove

      public void remove()
      The remove operation is not supported by this Iterator
      Specified by:
      remove in interface Iterator<Message>
      Throws:
      UnsupportedOperationException - is always thrown.