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

/**
 * Describes a configurer for an object of the {@link Context}. A configurer
 * helps preparing a context on the fly. Its DSL methods can be called at any time,
 * the underlying context is always ready to be used.
 *
 * 
 *     This basic interface only declares two common methods, one to return to the parent
 *     configurer object, and another to return the initial context (usually a {@link Context}.
 * 
 *
 * @param  the parent configurer we might return to when continuing configuration
 * @param  the initial context we might returned when finished
 */
public interface ContextConfigurer {
    /**
     * Used to return to the parent context or configurer.
     * @return the parent configurer or context
     */
    P and();

    /**
     * Used to return the initial context, for easy retrieval
     * @return the initial context we are configuring
     */
    C end();
}