Class NotificationResult

java.lang.Object
javax.management.remote.NotificationResult
All Implemented Interfaces:
Serializable
public class NotificationResult extends Object implements Serializable

Result of a query for buffered notifications. Notifications in a notification buffer have positive, monotonically increasing sequence numbers. The result of a notification query contains the following elements:

  • The sequence number of the earliest notification still in the buffer.
  • The sequence number of the next notification available for querying. This will be the starting sequence number for the next notification query.
  • An array of (Notification,listenerID) pairs corresponding to the returned notifications and the listeners they correspond to.

It is possible for the nextSequenceNumber to be less than the earliestSequenceNumber. This signifies that notifications between the two might have been lost.

Since:
1.5
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    NotificationResult(long earliestSequenceNumber, long nextSequenceNumber, TargetedNotification[] targetedNotifications)
    Constructs a notification query result.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getEarliestSequenceNumber()
    Returns the sequence number of the earliest notification still in the buffer.
    long
    getNextSequenceNumber()
    Returns the sequence number of the next notification available for querying.
    TargetedNotification[]
    getTargetedNotifications()
    Returns the notifications resulting from the query, and the listeners they correspond to.
    String
    toString()
    Returns a string representation of the object.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • NotificationResult

      public NotificationResult(long earliestSequenceNumber, long nextSequenceNumber, TargetedNotification[] targetedNotifications)

      Constructs a notification query result.

      Parameters:
      earliestSequenceNumber - the sequence number of the earliest notification still in the buffer.
      nextSequenceNumber - the sequence number of the next notification available for querying.
      targetedNotifications - the notifications resulting from the query, and the listeners they correspond to. This array can be empty.
      Throws:
      IllegalArgumentException - if targetedNotifications is null or if earliestSequenceNumber or nextSequenceNumber is negative.

  • Method Details

    • getEarliestSequenceNumber

      public long getEarliestSequenceNumber()
      Returns the sequence number of the earliest notification still in the buffer.
      Returns:
      the sequence number of the earliest notification still in the buffer.

    • getNextSequenceNumber

      public long getNextSequenceNumber()
      Returns the sequence number of the next notification available for querying.
      Returns:
      the sequence number of the next notification available for querying.

    • getTargetedNotifications

      public TargetedNotification[] getTargetedNotifications()
      Returns the notifications resulting from the query, and the listeners they correspond to.
      Returns:
      the notifications resulting from the query, and the listeners they correspond to. This array can be empty.

    • toString

      public String toString()
      Returns a string representation of the object. The result should be a concise but informative representation that is easy for a person to read.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the object.