com.atlassian.audit.entity

Class AuditEvent.Builder

java.lang.Object

com.atlassian.audit.entity.AuditEvent.Builder

Enclosing class:

AuditEvent

public static class AuditEvent.Builder
extends Object

The Builder class for AuditEvent

Constructor Summary

Constructors

Constructor and Description
Builder(AuditEvent event)
Builder(AuditType type)
Builder(String action, String category, CoverageLevel level) Deprecated. since 1.7.0, use a variant with i18n keys
Builder(String action, String category, CoverageLevel level, CoverageArea area) Deprecated. since 1.7.0, use a variant with i18n keys

Method Summary

Modifier and Type	Method and Description
AuditEvent.Builder	action(String action) Deprecated. since 1.7.0 use actionI18nKey(String) and provide the action i18n key.
AuditEvent.Builder	actionI18nKey(String actionI18nKey) Action i18n key.
AuditEvent.Builder	addChangedValueIfDifferent(ChangedValue changedValue) Adds ChangedValue only if the value changed.
AuditEvent.Builder	affectedObject(AuditResource affectedObject)
AuditEvent.Builder	affectedObjects(List<AuditResource> affectedObjects)
AuditEvent.Builder	appendAffectedObjects(List<AuditResource> affectedObjects)
AuditEvent.Builder	appendChangedValues(Collection<ChangedValue> changedValues)
AuditEvent.Builder	appendExtraAttributes(Collection<AuditAttribute> extraAttributes)
AuditEvent.Builder	area(CoverageArea area)
AuditEvent	build()
AuditEvent.Builder	category(String category) Deprecated. since 1.7.0 use categoryI18nKey(String) and provide the category i18n key.
AuditEvent.Builder	categoryI18nKey(String categoryI18nKey) Category i18n key.
AuditEvent.Builder	changedValue(ChangedValue changedValue)
AuditEvent.Builder	changedValues(List<ChangedValue> changedValues)
AuditEvent.Builder	extraAttribute(AuditAttribute extraAttribute)
AuditEvent.Builder	extraAttributes(Collection<AuditAttribute> extraAttributes)
AuditEvent.Builder	level(CoverageLevel level)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@Nonnull
               AuditType type)

Builder

@Deprecated
public Builder(@Nonnull
                           String action,
                           @Nonnull
                           String category,
                           @Nonnull
                           CoverageLevel level)

Deprecated. since 1.7.0, use a variant with i18n keys

Builder

@Deprecated
public Builder(@Nonnull
                           String action,
                           @Nonnull
                           String category,
                           @Nonnull
                           CoverageLevel level,
                           @Nullable
                           CoverageArea area)

Deprecated. since 1.7.0, use a variant with i18n keys

Builder

public Builder(@Nonnull
               AuditEvent event)

Method Detail

action

@Deprecated
public AuditEvent.Builder action(@Nonnull
                                             String action)

Deprecated. since 1.7.0 use actionI18nKey(String) and provide the action i18n key.

Action - translation of actionI18nKey Example - for action "Pull Request Created" we expect input "Pull Request Created". Not stored.

actionI18nKey

public AuditEvent.Builder actionI18nKey(@Nonnull
                                        String actionI18nKey)

Action i18n key. Example - for action "Pull Request Created" we expect input "audit.product.action.pr.created" which we will then translate before displaying to user.

categoryI18nKey

public AuditEvent.Builder categoryI18nKey(@Nonnull
                                          String categoryI18nKey)

Category i18n key. Example - for category "Pull Requests" we expect input "audit.product.category.pr" which we will then translate before displaying to user.

category

@Deprecated
public AuditEvent.Builder category(@Nonnull
                                               String category)

Deprecated. since 1.7.0 use categoryI18nKey(String) and provide the category i18n key.

Category - translation of categoryI18nKey Example - for category "Pull Requests" we expect input "Pull Request". Not stored.

level

public AuditEvent.Builder level(@Nonnull
                                CoverageLevel level)

area

public AuditEvent.Builder area(@Nonnull
                               CoverageArea area)

affectedObjects

public AuditEvent.Builder affectedObjects(@Nonnull
                                          List<AuditResource> affectedObjects)

appendAffectedObjects

public AuditEvent.Builder appendAffectedObjects(@Nonnull
                                                List<AuditResource> affectedObjects)

affectedObject

public AuditEvent.Builder affectedObject(@Nonnull
                                         AuditResource affectedObject)

changedValues

public AuditEvent.Builder changedValues(@Nonnull
                                        List<ChangedValue> changedValues)

appendChangedValues

public AuditEvent.Builder appendChangedValues(@Nonnull
                                              Collection<ChangedValue> changedValues)

changedValue

public AuditEvent.Builder changedValue(@Nonnull
                                       ChangedValue changedValue)

addChangedValueIfDifferent

public AuditEvent.Builder addChangedValueIfDifferent(@Nonnull
                                                     ChangedValue changedValue)

Adds ChangedValue only if the value changed.

Parameters:

changedValue - New ChangedValue to be added.

Returns:

AuditEvent.Builder instance

Since:

1.1.0

extraAttributes

public AuditEvent.Builder extraAttributes(@Nonnull
                                          Collection<AuditAttribute> extraAttributes)

appendExtraAttributes

public AuditEvent.Builder appendExtraAttributes(@Nonnull
                                                Collection<AuditAttribute> extraAttributes)

extraAttribute

public AuditEvent.Builder extraAttribute(@Nonnull
                                         AuditAttribute extraAttribute)

build

public AuditEvent build()