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
nextSequenceNumberto be less than theearliestSequenceNumber. This signifies that notifications between the two might have been lost.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description NotificationResult(long earliestSequenceNumber, long nextSequenceNumber, TargetedNotification[] targetedNotifications)Constructs a notification query result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description longgetEarliestSequenceNumber()Returns the sequence number of the earliest notification still in the buffer.longgetNextSequenceNumber()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.StringtoString()Returns a string representation of the object.
-
-
-
Constructor Detail
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- iftargetedNotificationsis null or ifearliestSequenceNumberornextSequenceNumberis negative.
-
Method Detail
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.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
