com.atlassian.johnson

Interface JohnsonEventContainer

All Known Implementing Classes:

DefaultJohnsonEventContainer

@ParametersAreNonnullByDefault
public interface JohnsonEventContainer

Interface defining a container for Johnson Events

Johnson maintains exactly one event container, which is accessed statically. As a result, all implementations of this interface are required to be thread-safe. However, because Johnson may be used to filter all requests to the application, implementations should be careful in how they achieve that thread-safety. Using heavy synchronisation techniques may impose significant performance penalties.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
void	addEvent(Event event) Adds the provided event to the collection.
Optional<Event>	firstEvent(Predicate<? super Event> predicate) Returns the first event (if any) that satisfies the given predicate.
Collection<Event>	getEvents() Retrieves an immutable view of the contained Events.
Collection<Event>	getEvents(Predicate<? super Event> predicate) Returns any events that satisfy the given predicate.
boolean	hasEvent(Predicate<? super Event> predicate) Indicates whether this container has any events that satisfy the given predicate.
boolean	hasEvents() Retrieves a flag indicating whether there are Events in the container.
void	removeEvent(Event event) Removes the specified Event from the container, if it can be found.

Method Detail

addEvent

void addEvent(Event event)

Adds the provided event to the collection.

Parameters:

event - the event to add

getEvents

@Nonnull
Collection<Event> getEvents()

Retrieves an immutable view of the contained Events.

Returns:

the current events

hasEvents

boolean hasEvents()

Retrieves a flag indicating whether there are Events in the container.

This can be thought of as a shortcut for !getEvents().isEmpty().

Returns:

true if there are events; otherwise, false

removeEvent

void removeEvent(Event event)

Removes the specified Event from the container, if it can be found.

Warning: Due to how Event.equals(Object) and Event.hashCode() are implemented, an exact match on every field is required in order to match an event. As a result, it may be necessary to iterate over the events in the collection and remove the event using the exact instance already in the collection.

Parameters:

event - the event to remove

getEvents

Collection<Event> getEvents(Predicate<? super Event> predicate)

Returns any events that satisfy the given predicate.

Parameters:

predicate - the predicate to evaluate

Returns:

any matching events in their original iteration order

Since:

3.2

hasEvent

boolean hasEvent(Predicate<? super Event> predicate)

Indicates whether this container has any events that satisfy the given predicate. This is equivalent to calling firstEvent(Predicate) followed by Optional.isPresent().

Parameters:

predicate - the predicate to evaluate

Returns:

falseif no events match

Since:

3.2

firstEvent

Optional<Event> firstEvent(Predicate<? super Event> predicate)

Returns the first event (if any) that satisfies the given predicate.

Parameters:

predicate - the predicate to evaluate

Returns:

the first such event in container iteration order

Since:

3.2

See Also:

getEvents()