com.atlassian.bitbucket.audit

Interface AuditEventConverter<T>

Type Parameters:

T - the type of the original event

All Known Implementing Classes:

DefaultAuditEventConverter

public interface AuditEventConverter<T>

Converts an Auditable event into a AuditEvent (a representation suitable for auditing). Implementations must have a nullary (no argument) constructor and are intended to be lightweight, stateless classes. Converters are instantiated for each event and discarded after the event has been converted.

Since:

7.0

See Also:

AuditEvent, Auditable

Method Summary

Modifier and Type	Method and Description
com.atlassian.audit.entity.AuditEvent	convert(T event, com.atlassian.audit.entity.AuditEvent.Builder builder) Converts an Auditable event into an AuditEvent.

Method Detail

convert

@Nonnull
com.atlassian.audit.entity.AuditEvent convert(@Nonnull
                                                       T event,
                                                       @Nonnull
                                                       com.atlassian.audit.entity.AuditEvent.Builder builder)

Converts an Auditable event into an AuditEvent.

Parameters:

builder - a builder for the auditing representation of the event, which may have some fields already set

event - the original annotated event

Returns:

the details of the original event in a representation suitable for auditing