com.memority.toolkit.rule.api.ChoicesRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of toolkit-rule-api Show documentation

This artifact provides the API classes that are necessary to implement the contracts of Memority configuration Rules.

There is a newer version: 3.43.1

/*
 * Copyright (c) 2016-2023 Memority. All Rights Reserved.
 *
 * This file is part of Memority Toolkit API , a Memority project.
 *
 * This file is released under the Memority Public Artifacts End-User License Agreement,
 * see 
 * Unauthorized copying of this file, via any medium is strictly prohibited.
 */
package com.memority.toolkit.rule.api;

import com.memority.toolkit.rule.api.context.Context;

import static java.util.Objects.requireNonNull;

/**
 * A choices Rule is used to provide a set of available choices, given a certain Context. The returned
 * value is a {@link ChoicesRuleResult}.
 *
 * @see Context
 */
public interface ChoicesRule extends Rule {

    @Override
    default RuleType getRuleType() {
        return RuleType.CHOICES;
    }

    /**
     * Run the Choices Rule with the given context and return an {@link ChoicesRuleResult}.
     *
     * @param context the execution context
     * @return the choices result, never null
     */
    ChoicesRuleResult choices(final Context context);

}