001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2014-2015 ForgeRock AS
025 */
026package org.opends.server.backends.pluggable.spi;
027
028import org.forgerock.opendj.ldap.ByteSequence;
029
030/**
031 * Function that computes the new value of a record for a Read-Modify-Write operation inside a transaction.
032 */
033// @FunctionalInterface
034public interface UpdateFunction {
035    /**
036     * Computes the new value for a record based on the record's existing
037     * content.
038     *
039     * @param oldValue
040     *            The record's existing content, or {@code null} if the record
041     *            does not exist at the moment and is about to be created.
042     * @return The new value for the record (which may be {@code null} if the record should be removed),
043     *         or the old value if no update is required.
044     */
045    ByteSequence computeNewValue(ByteSequence oldValue);
046}