com.espertech.esper.client.deploy.DeploymentOrderOptions Maven / Gradle / Ivy

Go to download

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

Complex event processing and event series analysis component

There is a newer version: 7.1.0

/*
 * *************************************************************************************
 *  Copyright (C) 2006-2015 EsperTech, Inc. All rights reserved.                       *
 *  http://www.espertech.com/esper                                                     *
 *  http://www.espertech.com                                                           *
 *  ---------------------------------------------------------------------------------- *
 *  The software in this package is published under the terms of the GPL license       *
 *  a copy of which has been included with this distribution in the license.txt file.  *
 * *************************************************************************************
 */

package com.espertech.esper.client.deploy;

import java.io.Serializable;

/**
 * Options class passed to {@link EPDeploymentAdmin#getDeploymentOrder(java.util.Collection, DeploymentOrderOptions)} for controlling the behavior of ordering and dependency checking logic.
 */
public class DeploymentOrderOptions implements Serializable
{
    private static final long serialVersionUID = -8132499950780690395L;

    private boolean checkCircularDependency = true;
    private boolean checkUses = true;

    /**
     * Returns true (the default) to indicate that the algorithm checks for circular dependencies among the uses-dependency graph,
     * or false to not perform this check.
     * @return indicator.
     */
    public boolean isCheckCircularDependency()
    {
        return checkCircularDependency;
    }

    /**
     * Set this indicator to true (the default) to indicate that the algorithm checks for circular dependencies among the uses-dependency graph,
     * or false to not perform this check.
     * @param checkCircularDependency indicator.
     */
    public void setCheckCircularDependency(boolean checkCircularDependency)
    {
        this.checkCircularDependency = checkCircularDependency;
    }

    /**
     * Returns true (the default) to cause the algorithm to check uses-dependencies ensuring all dependencies are satisfied i.e.
     * all dependent modules are either deployed or are part of the modules passed in, or false to not perform the checking.
     * @return indicator
     */
    public boolean isCheckUses()
    {
        return checkUses;
    }

    /**
     * Set this indicator to true (the default) to cause the algorithm to check uses-dependencies ensuring all dependencies are satisfied i.e.
     * all dependent modules are either deployed or are part of the modules passed in, or false to not perform the checking.
     * @param checkUses indicator
     */
    public void setCheckUses(boolean checkUses)
    {
        this.checkUses = checkUses;
    }
}