com.atlassian.johnson

Class DefaultJohnsonEventContainer

java.lang.Object

com.atlassian.johnson.DefaultJohnsonEventContainer

All Implemented Interfaces:

JohnsonEventContainer

@ParametersAreNonnullByDefault
public class DefaultJohnsonEventContainer
extends Object
implements JohnsonEventContainer

A default implementation of JohnsonEventContainer which stores events in a list.

Note: This implementation is thread-safe.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
DefaultJohnsonEventContainer()

Method Summary

Modifier and Type	Method and Description
void	addEvent(Event event) Adds the provided Event to the list.
Optional<Event>	firstEvent(Predicate<? super Event> predicate) Returns the first event (if any) that satisfies the given predicate.
List<Event>	getEvents() Retrieves an unmodifiable view of the current Event list.
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 any Events in the list.
void	removeEvent(Event event) Removes the provided Event from the list, if it can be found.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultJohnsonEventContainer

public DefaultJohnsonEventContainer()

Method Detail

addEvent

public void addEvent(Event event)

Adds the provided Event to the list.

Specified by:

addEvent in interface JohnsonEventContainer

Parameters:

event - the event to add

getEvents

@Nonnull
public List<Event> getEvents()

Retrieves an unmodifiable view of the current Event list.

Specified by:

getEvents in interface JohnsonEventContainer

Returns:

an unmodifiable collection of zero or more events

hasEvents

public boolean hasEvents()

Retrieves a flag indicating whether there are any Events in the list.

Specified by:

hasEvents in interface JohnsonEventContainer

Returns:

true if the event list is not empty; otherwise, false

removeEvent

public void removeEvent(Event event)

Removes the provided Event from the list, if it can be found.

Specified by:

removeEvent in interface JohnsonEventContainer

Parameters:

event - the event to remove

getEvents

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

Description copied from interface: JohnsonEventContainer

Returns any events that satisfy the given predicate.

Specified by:

getEvents in interface JohnsonEventContainer

Parameters:

predicate - the predicate to evaluate

Returns:

any matching events in their original iteration order

hasEvent

public boolean hasEvent(Predicate<? super Event> predicate)

Description copied from interface: JohnsonEventContainer

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

Specified by:

hasEvent in interface JohnsonEventContainer

Parameters:

predicate - the predicate to evaluate

Returns:

falseif no events match

firstEvent

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

Description copied from interface: JohnsonEventContainer

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

Specified by:

firstEvent in interface JohnsonEventContainer

Parameters:

predicate - the predicate to evaluate

Returns:

the first such event in container iteration order

See Also:

JohnsonEventContainer.getEvents()