core/api/src/main/java/org/onosproject/core/GroupId.java

/*
 * Copyright 2014-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.core;

/**
 * Group identifier.
 */
// TODO: require refactor to extend from Identifier base class
public interface GroupId {

    /**
     * Returns a group ID as an integer value.
     * The method is not intended for use by application developers.
     * Return data type may change in the future release.
     *
     * @return a group ID as integer value
     */
    int id();
}