proguard.analysis.cpa.interfaces.ReachedSet Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of proguard-core Show documentation

ProGuardCORE is a free library to read, analyze, modify, and write Java class files.

There is a newer version: 9.1.7

/*
 * ProGuardCORE -- library to process Java bytecode.
 *
 * Copyright (c) 2002-2022 Guardsquare NV
 *
 * 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 proguard.analysis.cpa.interfaces;

import java.util.Collection;

/**
 * The {@link ReachedSet} stores reached {@code State}s discovered by the {@link Algorithm}.
 *
 * @author Dmitry Ivanov
 */
public interface ReachedSet
{

    /**
     * Adds an abstract state.
     */
    boolean add(AbstractState abstractState);

    /**
     * Adds multiple abstract states.
     */
    boolean addAll(Collection abstractStates);

    /**
     * Removes an abstract state.
     */
    boolean remove(AbstractState abstractState);

    /**
     * Removes multiple abstract states.
     */
    boolean removeAll(Collection abstractStates);

    /**
     * Returns a collection representation of itself.
     */
    Collection asCollection();

    /**
     * Returns a collection of abstract states mergeable with the {@code abstractState}.
     */
    Collection getReached(AbstractState abstractState);
}