org.onosproject.net.intent.IntentId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of onos-api Show documentation
There is a newer version: 2.7.0
/*
 * Copyright 2014-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.intent;

import com.google.common.annotations.Beta;

import static com.google.common.base.Preconditions.checkArgument;

import org.onlab.util.Identifier;
import org.onosproject.net.resource.ResourceConsumer;
import org.onosproject.net.resource.ResourceConsumerId;

/**
 * Intent identifier suitable as an external key.
 * This class is immutable.
 */
@Beta
public final class IntentId extends Identifier implements ResourceConsumer {

    private static final String HEX_PREFIX = "0x";

    /**
     * Creates an intent identifier from the specified long representation.
     *
     * @param value long value
     * @return intent identifier
     */
    public static IntentId valueOf(long value) {
        return new IntentId(value);
    }

    /**
     * Creates an intent identifier from the specified String representation.
     *
     * @param id hexadecimal String prefixed with 0x
     * @return intent identifier
     */
    public static IntentId valueOf(String id) {
        checkArgument(id.startsWith(HEX_PREFIX), "Invalid id: %s", id);
        return valueOf(Long.parseUnsignedLong(id.substring(2), 16));
    }

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

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

    /**
     * Returns the backing value.
     *
     * @return the value
     */
    public long fingerprint() {
        return identifier;
    }

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

    @Override
    public ResourceConsumerId consumerId() {
        return ResourceConsumerId.of(this);
    }
}