core/api/src/main/java/org/onosproject/net/key/CommunityName.java

/*
 * Copyright 2016 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.net.key;

/**
 * Representation of an SNMP community name authentication token.
 */
public final class CommunityName extends DeviceKey {
    private final String name;

    /**
     * Private constructor for a community name.
     *
     * @param name community name
     */
    private CommunityName(String name) {
        this.name = name;
    }

    /**
     * Static method to construct a community name.
     *
     * @param name community name
     * @return community name
     */
    static CommunityName communityName(String name) {
        return new CommunityName(name);
    }

    /**
     * Returns the community name.
     *
     * @return name
     */
    public String name() {
        return name;
    }
}