com.kenshoo.pl.entity.spi.audit.AuditFieldValueFormatter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of persistence-layer Show documentation

A Java persistence layer based on JOOQ for high performance and business flow support.

There is a newer version: 0.1.121-jooq-3.16.3

package com.kenshoo.pl.entity.spi.audit;

import com.kenshoo.pl.entity.EntityField;

/**
 * A formatter for field values to be included in an audit record.
 */
public interface AuditFieldValueFormatter {

    /**
     * Format the given value of the given field for an audit record
     *
     * @param field the field whose value is to be formatted; required
     * @param value the value to be formatted; must not be {@code null}
     * @param    the type of value to be formatted
     * @return the formatted value
     * @throws NullPointerException if any of the inputs is {@code null}
     */
     String format(final EntityField field, final T value);

    /**
     * An invalid implementation that should not be used,
     * only exists because we can't provide a default of {@code null} for an annotation parameter
     */
    final class MissingAuditFieldValueFormatter implements AuditFieldValueFormatter {

        @Override
        public  String format(EntityField field, T value) {
            throw new IllegalStateException("This formatter is only for indicating emptiness of the annotation param and should not be used!!");
        }
    }
}