subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/api/IMatchUpdateListener.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

/*******************************************************************************
 * Copyright (c) 2010-2012, Bergmann Gabor, Istvan Rath and Daniel Varro
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-v20.html.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/
package tools.refinery.viatra.runtime.api;

/**
 * An interface for low-level notifications about match appearance and disappearance.
 * 
 * <p>
 * See {@link ViatraQueryMatcher#addCallbackOnMatchUpdate(IMatchUpdateListener, boolean)} for usage. Clients should
 * consider using {@link MatchUpdateAdapter} or deriving their implementation from it.
 * 
 * @author Bergmann Gabor
 * 
 */
public interface IMatchUpdateListener<Match extends IPatternMatch> {
    /**
     * Will be invoked on each new match that appears.
     * 
     * @param match
     *            the match that has just appeared.
     */
    public void notifyAppearance(Match match);

    /**
     * Will be invoked on each existing match that disappears.
     * 
     * @param match
     *            the match that has just disappeared.
     */
    public void notifyDisappearance(Match match);
}