com.helger.photon.audit.v2.domain

Class AuditField

java.lang.Object

com.helger.photon.audit.v2.domain.AuditField

All Implemented Interfaces:

Serializable

@Immutable
public class AuditField
extends Object
implements Serializable

A single field of an AuditEvent. Has a mandatory name and an optional value.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuditField(String sName, String sValue) Constructor

Method Summary

Modifier and Type	Method and Description
static AuditField	createWithHiddenValue(String sFieldName) Factory method to create an AuditField with a value that indicates, that the real value is not to be persisted or displayed.
boolean	equals(Object o)
String	getName()
String	getValue()
int	hashCode()
boolean	hasName()
boolean	hasValue()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditField

public AuditField(@Nullable
                  String sName,
                  @Nullable
                  String sValue)

Constructor

Parameters:

sName - The field name. May be null.

sValue - The field value. May be null.

Method Detail

getName

@Nullable
public String getName()

Returns:

The name from the constructor. May be null.

hasName

public boolean hasName()

Returns:

true if a name is present, false if not.

getValue

@Nullable
public String getValue()

Returns:

The value from the constructor. May be null.

hasValue

public boolean hasValue()

Returns:

true if a value is present, false if not.

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

createWithHiddenValue

@Nonnull
public static AuditField createWithHiddenValue(@Nullable
                                                         String sFieldName)

Factory method to create an AuditField with a value that indicates, that the real value is not to be persisted or displayed.

Parameters:

sFieldName - Field name. May be null.

Returns:

A new AuditField and never null.