com.ocadotechnology.indexedcache.Index Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of OcavaCore Show documentation

There is a newer version: 16.6.21

/*
 * Copyright © 2017-2023 Ocado (Ocava)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ocadotechnology.indexedcache;

import javax.annotation.Nullable;

import com.ocadotechnology.id.Identified;

/**
 * An abstract class rather than an interface so that access to modification can be hidden for the implementations.
 */
public abstract class Index> {
    /**
     * Update the index with a single change.
     * @param newObject - the new value of an object.  Null if the object is being removed
     * @param oldObject - the old value of an object.  Null if the object is being added.
     * @throws IndexUpdateException - if the update fails and has been successfully rolled back.
     */
    protected abstract void update(@Nullable C newObject, @Nullable C oldObject) throws IndexUpdateException;

    /**
     * Update the index with a single change.
     * @param changes - the collection of changes to be applied to the index
     * @throws IndexUpdateException - if the update fails and has been successfully rolled back.
     */
    protected abstract void updateAll(Iterable> changes) throws IndexUpdateException;
}