com.atlassian.audit.entity

Class AuditAttribute

java.lang.Object

com.atlassian.audit.entity.AuditAttribute

public class AuditAttribute
extends Object

A name value pair represents extra info of an auditing entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditAttribute.Builder

Constructor Summary

Constructors

Constructor and Description
AuditAttribute(String name, String value) Deprecated. since 1.7.0 use fromI18nKeys(String, String) and provide the name i18n key.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
static AuditAttribute.Builder	fromI18nKeys(String nameI18nKey, String value) Audit Attribute name i18n key and value.
String	getName() The attribute name - translation of getNameI18nKey() by the auditing framework.
String	getNameI18nKey() The attribute name i18n key.
String	getValue()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditAttribute

@Deprecated
public AuditAttribute(String name,
                                  String value)

Deprecated. since 1.7.0 use fromI18nKeys(String, String) and provide the name i18n key.

Method Detail

fromI18nKeys

public static AuditAttribute.Builder fromI18nKeys(@Nonnull
                                                  String nameI18nKey,
                                                  String value)

Audit Attribute name i18n key and value. Example - for Audit Attribute "Extras" we expect input "audit.product.attribute.extras" for the name key which we will then translate before displaying to user, value will not be translated.

getName

@Nullable
public String getName()

The attribute name - translation of getNameI18nKey() by the auditing framework.

getNameI18nKey

@Nonnull
public String getNameI18nKey()

The attribute name i18n key. Expected unique for an attribute type and not expect to change. Eg - for Audit Attribute "Extras" - "audit.product.myplugin.attribute.extras" which would then be used for translation purposes.

getValue

@Nullable
public String getValue()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object