apps/vtn/vtnrsc/src/main/java/org/onosproject/vtnrsc/TenantNetworkId.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.vtnrsc;

import org.onlab.util.Identifier;

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

/**
 * Immutable representation of a tenantNetwork identity.
 */
public final class TenantNetworkId extends Identifier<String> {
    // Public construction is prohibited
    private TenantNetworkId(String networkId) {
        super(networkId);
    }

    /**
     * Creates a TenantNetwork identifier.
     *
     * @param networkId tenantNetwork identify string
     * @return the attached tenantNetwork identifier
     */
    public static TenantNetworkId networkId(String networkId) {
        checkNotNull(networkId, "Networkid cannot be null");
        return new TenantNetworkId(networkId);
    }

    /**
     * Returns tenantNetwork identifier.
     *
     * @return the tenantNetwork identifier
     */
    public String networkId() {
        return identifier;
    }
}