/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2015 The ZAP Development Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.zaproxy.zap.extension.fuzz.messagelocations;

import java.util.SortedSet;
import org.zaproxy.zap.extension.httppanel.Message;
import org.zaproxy.zap.model.InvalidMessageException;

public interface MultipleMessageLocationsReplacer<T extends Message> {

    boolean isInitialised();

    void init(
            MessageLocationReplacer<T> replacer,
            SortedSet<? extends MessageLocationReplacementGenerator<?, ?>>
                    messageLocationReplacementGenerator);

    long getNumberOfReplacements();

    boolean hasNext();

    T next() throws ReplacementException, InvalidMessageException;

    SortedSet<MessageLocationReplacement<?>> currentReplacements();

    void close();
}
