org.microbean.kubernetes.controller

Class AbstractEvent<T extends HasMetadata>

java.lang.Object

java.util.EventObject

org.microbean.kubernetes.controller.AbstractEvent<T>

Type Parameters:

T - a type of Kubernetes resource

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Event, SynchronizationEvent

public abstract class AbstractEvent<T extends HasMetadata>
extends EventObject

An abstract EventObject that represents another event that has occurred to a Kubernetes resource, usually as found in an EventCache implementation.

Author:

Laird Nelson

See Also:

EventCache, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractEvent.Type The type of an AbstractEvent.

Field Summary

Fields inherited from class java.util.EventObject

source

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Returns true if the supplied Object is also an AbstractEvent and is equal in every respect to this one.
Object	getKey() Returns a key that can be used to unambiguously identify this AbstractEvent's resource.
T	getPriorResource() Returns a HasMetadata representing the prior state of the Kubernetes resource this AbstractEvent primarily concerns.
T	getResource() Returns a HasMetadata representing the Kubernetes resource this AbstractEvent concerns.
AbstractEvent.Type	getType() Returns a AbstractEvent.Type representing the type of this AbstractEvent.
int	hashCode() Returns a hashcode for this AbstractEvent.
boolean	isFinalStateKnown() Returns true if this AbstractEvent's resource is an accurate representation of its last known state.
String	toString() Returns a String representation of this AbstractEvent.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getType

public final AbstractEvent.Type getType()

Returns a AbstractEvent.Type representing the type of this AbstractEvent.

This method never returns null.

Returns:

a non-null AbstractEvent.Type

See Also:

AbstractEvent.Type

getPriorResource

public final T getPriorResource()

Returns a HasMetadata representing the prior state of the Kubernetes resource this AbstractEvent primarily concerns.

This method may return null, and often does.

The prior state of a Kubernetes resource is often not known at AbstractEvent construction time so it is common for this method to return null.

Returns:

a HasMetadata representing the prior state of the Kubernetes resource this AbstractEvent primarily concerns, or null

See Also:

getResource()

getResource

public final T getResource()

Returns a HasMetadata representing the Kubernetes resource this AbstractEvent concerns.

This method never returns null.

Returns:

a non-null Kubernetes resource

isFinalStateKnown

public final boolean isFinalStateKnown()

Returns true if this AbstractEvent's resource is an accurate representation of its last known state.

This should only return true for some, but not all, deletion scenarios. Any other behavior should be considered to be an error.

Returns:

true if this AbstractEvent's resource is an accurate representation of its last known state; false otherwise

getKey

public Object getKey()

Returns a key that can be used to unambiguously identify this AbstractEvent's resource.

This method may return null in exceptional cases, but normally does not.

Overrides of this method must not return null except in exceptional cases.

The default implementation of this method returns the return value of the HasMetadatas.getKey(HasMetadata) method.

Returns:

a key for this AbstractEvent, or null

See Also:

HasMetadatas.getKey(HasMetadata)

hashCode

public int hashCode()

Returns a hashcode for this AbstractEvent.

Overrides:

hashCode in class Object

Returns:

a hashcode for this AbstractEvent

equals

public boolean equals(Object other)

Returns true if the supplied Object is also an AbstractEvent and is equal in every respect to this one.

Overrides:

equals in class Object

Parameters:

other - the Object to test; may be null in which case false will be returned

Returns:

true if the supplied Object is also an AbstractEvent and is equal in every respect to this one; false otherwise

toString

public String toString()

Returns a String representation of this AbstractEvent.

This method never returns null.

Overrides of this method must not return null.

Overrides:

toString in class EventObject

Returns:

a non-null String representation of this AbstractEvent