org.amplecode.cave.process.queue.ProcessQueueConstraints Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cave-process Show documentation

Framework for running background processes and keeping track with their states.

The newest version!

package org.amplecode.cave.process.queue;

/*
 * Copyright (c) 2008, the original author or authors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the AmpleCode project nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * Process queue constraints are values which define which processes can be part
 * of the {@link ProcessQueue}'s head processes.
 * 
 * @author Torgeir Lorange Ostby
 * @version $Id: ProcessQueueConstraints.java 58 2008-02-02 14:38:01Z torgeilo $
 */
public interface ProcessQueueConstraints
{
    /**
     * Returns the process group name. Must not return null if
     * {@link #isSerialToGroup()} returns true.
     */
    String getGroup();

    /**
     * If returns true, then the process can not be in head together with other
     * processes with the same group name. {@link #getGroup()} must return
     * something.
     */
    boolean isSerialToGroup();

    /**
     * If returns true, then the process can only be in head alone, and values
     * returned from {@link #getGroup()} and {@link #isSerialToGroup()} are
     * ignored.
     */
    boolean isSerialToAll();
}