Class TypedNotification<T> (2.5.0)

public class TypedNotification<T> extends AbstractNotification

Beta
Notification metadata and parsed content sent to this client about a watched resource.

Implementation is not thread-safe.

Inheritance

java.lang.Object > AbstractNotification > TypedNotification<T>

Type Parameter

Name Description
T

Constructors

TypedNotification(UnparsedNotification sourceNotification)

public TypedNotification(UnparsedNotification sourceNotification)
Parameter
Name Description
sourceNotification UnparsedNotification

source notification metadata to copy

TypedNotification(long messageNumber, String resourceState, String resourceId, String resourceUri, String channelId)

public TypedNotification(long messageNumber, String resourceState, String resourceId, String resourceUri, String channelId)
Parameters
Name Description
messageNumber long

message number (a monotonically increasing value starting with 1)

resourceState String
resource state
resourceId String

opaque ID for the watched resource that is stable across API versions

resourceUri String

opaque ID (in the form of a canonicalized URI) for the watched resource that is sensitive to the API version

channelId String

notification channel UUID provided by the client in the watch request

Methods

getContent()

public final T getContent()

Returns the parsed notification content or null for none.

Returns
Type Description
T

setChanged(String changed)

public TypedNotification<T> setChanged(String changed)

Sets the type of change performed on the resource or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
changed String
Returns
Type Description
TypedNotification<T>
Overrides

setChannelExpiration(String channelExpiration)

public TypedNotification<T> setChannelExpiration(String channelExpiration)

Sets the notification channel expiration time or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
channelExpiration String
Returns
Type Description
TypedNotification<T>
Overrides

setChannelId(String channelId)

public TypedNotification<T> setChannelId(String channelId)

Sets the notification channel UUID provided by the client in the watch request.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
channelId String
Returns
Type Description
TypedNotification<T>
Overrides

setChannelToken(String channelToken)

public TypedNotification<T> setChannelToken(String channelToken)

Sets the notification channel token (an opaque string) provided by the client in the watch request or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
channelToken String
Returns
Type Description
TypedNotification<T>
Overrides

setContent(T content)

public TypedNotification<T> setContent(T content)

Sets the parsed notification content or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
content T
Returns
Type Description
TypedNotification<T>

setMessageNumber(long messageNumber)

public TypedNotification<T> setMessageNumber(long messageNumber)

Sets the message number (a monotonically increasing value starting with 1).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
messageNumber long
Returns
Type Description
TypedNotification<T>
Overrides

setResourceId(String resourceId)

public TypedNotification<T> setResourceId(String resourceId)

Sets the opaque ID for the watched resource that is stable across API versions.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
resourceId String
Returns
Type Description
TypedNotification<T>
Overrides

setResourceState(String resourceState)

public TypedNotification<T> setResourceState(String resourceState)

Sets the resource state.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
resourceState String
Returns
Type Description
TypedNotification<T>
Overrides

setResourceUri(String resourceUri)

public TypedNotification<T> setResourceUri(String resourceUri)

Sets the opaque ID (in the form of a canonicalized URI) for the watched resource that is sensitive to the API version.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name Description
resourceUri String
Returns
Type Description
TypedNotification<T>
Overrides

toString()

public String toString()
Returns
Type Description
String
Overrides