incubator/api/src/main/java/org/onosproject/incubator/net/tunnel/DomainTunnelId.java

/*
 * Copyright 2015-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.incubator.net.tunnel;

import org.onlab.util.Identifier;

/**
 * A wrapper class for a long used to identify domain level tunnels.
 */
public final class DomainTunnelId extends Identifier<Long> {

    /**
     * Creates a tunnel identifier from the specified tunnel.
     *
     * @param value long value
     * @return domain tunnel identifier
     */
    public static DomainTunnelId valueOf(long value) {
        return new DomainTunnelId(value);
    }

    /**
     * Creates a tunnel identifier from the specified tunnel.
     *
     * @param value long value as a string
     * @return domain tunnel identifier
     */
    public static DomainTunnelId valueOf(String value) {
        return new DomainTunnelId(Long.parseLong(value));
    }

    /**
     * Constructor for serializer.
     */
    protected DomainTunnelId() {
        super(0L);
    }

    /**
     * Constructs the Domain ID corresponding to a given long value.
     *
     * @param value the underlying value of this domain ID
     */
    public DomainTunnelId(long value) {
        super(value);
    }

    @Override
    public String toString() {
        return "0x" + Long.toHexString(identifier);
    }
}