PRoles.java example

Explorer
nmedit-master
/* Copyright (C) 2008 Christian Schneider
 * 
 * This file is part of Nomad.
 * 
 * Nomad is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * Nomad is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with Nomad; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
package net.sf.nmedit.jpatch;

import java.util.Collection;

/*
 * audio
 * in
 * out
 * level
 * mute
 * 
 * osc=oscillator
 * filter = filter
 * envelope
 * fx 
 * mixer
 * 
 * ui (affecting only the user interface)
 * assign (assignment of something to something else)
 */

/**
 * A set of strings defining the role of a component.
 */
public interface PRoles extends Collection<String>, Iterable<String>
{

    /**
     * Returns true if the set is empty.
     */
    boolean isEmpty();
    
    /**
     * Returns the number of strings in this set.
     */
    int size();
    
    /**
     * Computes the union of this and the specified set.
     * @param roles another set
     * @return the union of this and the specified set
     */
    PRoles union(PRoles roles);

    /**
     * Computes the difference of this and the specified set.
     * @param roles another set
     * @return the difference of this and the specified set
     */
    PRoles difference(PRoles roles);

    /**
     * Computes the intersection of this and the specified set.
     * @param roles another set
     * @return the intersection of this and the specified set
     */
    PRoles intersection(PRoles roles);

    /**
     * Returns true if this and the specified set intersect.
     * @param roles another set
     * @return true if this and the specified set intersect
     */
    boolean intersects(PRoles roles);
    
}