dk.cloudcreate.essentials.components.eventsourced.aggregates.decider.IsStateFinalResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eventsourced-aggregates Show documentation

This library focuses on providing different flavors of eventsourced aggregrates

There is a newer version: 0.40.19

Show newest version

/*
 * Copyright 2021-2024 the original author or authors.
 *
 * 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
 *
 *      https://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 dk.cloudcreate.essentials.components.eventsourced.aggregates.decider;

/**
 * {@link Decider} related interface that resolves if the aggregate's state is final and no more changes can occur, i.e. no more events can be persisted (i.e. {@link Handler#handle(Object, Object)} will return an ERROR)
 *
 * @param  The type of Aggregate State that this {@link Decider} works with in {@link Handler#handle(Object, Object)}, {@link InitialStateProvider#initialState()},
 *                {@link StateEvolver#applyEvent(Object, Object)} and {@link #isFinal(Object)}
 */
public interface IsStateFinalResolver {
    /**
     * Return true from this method IF the aggregate's state is final and no more changes can occur, i.e. no more events can be persisted (i.e. {@link Handler#handle(Object, Object)} will return an ERROR)

     * Note: This method is called isTerminal in the decider pattern

     *
     * @param state the current STATE of the aggregate
     * @return true IF the aggregate's state is final, otherwise false
     */
    boolean isFinal(STATE state);
}