/*
 * Quasar: lightweight threads and actors for the JVM.
 * Copyright (c) 2013-2015, Parallel Universe Software Co. All rights reserved.
 * 
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *  
 *   or (per the licensee's choosing)
 *  
 * under the terms of the GNU Lesser General Public License version 3.0
 * as published by the Free Software Foundation.
 */
package co.paralleluniverse.strands.channels;

import co.paralleluniverse.fibers.SuspendExecution;
import java.util.Map;
import java.util.Objects;

/**
 * {@link ReceivePort} with Mix operations.
 *
 * @author circlespainter
 */
public interface Mix<M> extends ReceivePort<M> {

    public static enum SoloEffect { PAUSE_OTHERS, MUTE_OTHERS };

    public static enum Mode { NORMAL, PAUSE, MUTE };

    public static class State {
        public final Mode mode;
        public final Boolean solo;

        public State(final Mode mode, final Boolean solo) {
            this.mode = mode;
            this.solo = solo;
        }

        // Null has meaning only on write operations and it means "don't set"
        public State(final Mode mode) {
            this(mode, null);
        }

        public State(final boolean solo) {
            this(null, solo);
        }

        public Mode getMode() {
            return mode;
        }

        public Boolean getSolo() {
            return solo;
        }

        @Override
        public int hashCode() {
            int hash = 3;
            hash = 79 * hash + Objects.hashCode(this.mode);
            hash = 79 * hash + Objects.hashCode(this.solo);
            return hash;
        }

        @Override
        public boolean equals(Object obj) {
            if (obj == null)
                return false;
            if (getClass() != obj.getClass())
                return false;
            final State other = (State) obj;
            if (this.mode != other.mode)
                return false;
            if (!Objects.equals(this.solo, other.solo))
                return false;
            return true;
        }

        @Override
        public String toString() {
            return "State{" + "solo=" + solo + ", mode=" + mode + '}';
        }
    }

    public <T extends ReceivePort<? extends M>> void add(final T... items) throws SuspendExecution, InterruptedException;

    /**
     * @param items If {@code null} or empty, all items will be removed.
     */
    public <T extends ReceivePort<? extends M>> void remove(final T... items) throws SuspendExecution, InterruptedException;

    /**
     * @param items If {@code null} or empty, all items will be removed.
     */
    public <T extends ReceivePort<? extends M>> Map<T, State> getState(final T... items);

    /**
     * @param items If {@code null} or empty, all items state will be set to {@code state}.
     */
    public <T extends ReceivePort<? extends M>> void setState(final State state, final T... items) throws SuspendExecution, InterruptedException;

    public <T extends ReceivePort<? extends M>> void setState(final Map<T, State> states) throws SuspendExecution, InterruptedException;

    public SoloEffect getSoloEffect();

    public void setSoloEffect(final SoloEffect effect) throws SuspendExecution, InterruptedException;   
 }