core/api/src/main/java/org/onosproject/store/service/AtomicIdGenerator.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.store.service;

/**
 * Generator for globally unique numeric identifiers.
 */
public interface AtomicIdGenerator extends DistributedPrimitive {

    @Override
    default Type primitiveType() {
        return Type.ID_GENERATOR;
    }

    /**
     * Gets the next globally unique numeric identifier.
     *
     * @return the next globally unique numeric identifier
     */
    long nextId();

}