core/api/src/main/java/org/onosproject/net/pi/service/PiTranslationEvent.java

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * 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.onosproject.net.pi.service;

import com.google.common.annotations.Beta;
import org.onosproject.event.AbstractEvent;
import org.onosproject.net.pi.runtime.PiEntity;

/**
 * Signals an event related to the translation of a protocol-dependent (PD)
 * entity to a protocol-independent (PI) one.
 */
@Beta
public final class PiTranslationEvent<T extends PiTranslatable, E extends PiEntity>
        extends AbstractEvent<PiTranslationEvent.Type, PiTranslatedEntity<T, E>> {

    /**
     * Type of event.
     */
    public enum Type {
        /**
         * Signals that A PD entity has been translated to a PI one, and the
         * mapping between the two entities has been learned by the system.
         */
        LEARNED,

        /**
         * Signals that a previously learned mapping between a PD entity and its
         * PI counterpart has been removed.
         */
        FORGOT,
    }

    /**
     * Creates a new translation event.
     *
     * @param type    type of event
     * @param subject subject of event
     */
    public PiTranslationEvent(Type type, PiTranslatedEntity<T, E> subject) {
        super(type, subject);
    }
}