apps/mappingmanagement/api/src/main/java/org/onosproject/mapping/MappingValue.java

/*
 * Copyright 2017-present Open Networking Laboratory
 *
 * 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.mapping;

import org.onosproject.mapping.address.MappingAddress;
import org.onosproject.mapping.instructions.MappingInstruction;

import java.util.List;

/**
 * Abstraction of value of mapping information.
 */
public interface MappingValue {

    /**
     * Obtains a mapping address.
     *
     * @return a mapping address
     */
    MappingAddress address();

    /**
     * Obtains a collection of mapping instructions.
     *
     * @return a collection of mapping instructions
     */
    List<MappingInstruction> instructions();

    interface Builder {

        /**
         * Specifies the mapping address.
         *
         * @param address mapping address
         * @return a mapping value builder
         */
        Builder withAddress(MappingAddress address);

        /**
         * Specifies a collection of mapping instructions.
         *
         * @param instructions a collection of mapping instructions
         * @return a mapping value builder
         */
        Builder withInstructions(List<MappingInstruction> instructions);

        /**
         * Builds an immutable mapping value.
         *
         * @return a mapping value
         */
        MappingValue build();
    }
}