com.memority.toolkit.rule.api.ConfigurableRule 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;

/**
 * A Rule implementing ConfigurableRule becomes configurable by passing a RuleConfiguration of R
 * to the configure method.
 *
 * @param  the type of RuleConfiguration this rule is configured with
 */
public interface ConfigurableRule {

    /**
     * Configure the rule with the given configuration
     * @param configuration the configuration
     */
    void configure(R configuration);

    /**
     *
     * @return true if the rule is configured and ready for use, false otherwise
     */
    boolean isConfigured();
}