src/main/java/org/opencord/cordvtn/api/net/SegmentId.java

/*
 * Copyright 2016-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.opencord.cordvtn.api.net;

import org.onlab.util.Identifier;

/**
 * Representation of the network segmentation identifier.
 */
public final class SegmentId extends Identifier<Long> {

    /**
     * Default constructor.
     *
     * @param id long segmentation identifier
     */
    private SegmentId(Long id) {
        super(id);
    }

    /**
     * Returns the segmentation identifier with the supplied value.
     *
     * @param id long segmentation identifier
     * @return segmentation identifier
     */
    public static SegmentId of(Long id) {
        if (id <= 0) {
            throw new IllegalArgumentException("Value 0 or less then 0 is not" +
                    "allowed for segment ID");
        }
        return new SegmentId(id);
    }
}