core/api/src/main/java/org/onlab/onos/net/resource/BandwidthResourceRequest.java

/*
 * Copyright 2014 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.onlab.onos.net.resource;

import com.google.common.base.MoreObjects;

/**
 * Representation of a request for bandwidth resource.
 */
public class BandwidthResourceRequest implements ResourceRequest {
    private final Bandwidth bandwidth;

    /**
     * Creates a new {@link BandwidthResourceRequest} with {@link Bandwidth}
     * object.
     *
     * @param bandwidth {@link Bandwidth} object to be requested
     */
    public BandwidthResourceRequest(Bandwidth bandwidth) {
        this.bandwidth = bandwidth;
    }

    /**
     * Creates a new {@link BandwidthResourceRequest} with bandwidth value.
     *
     * @param bandwidth bandwidth value to be requested
     */
    public BandwidthResourceRequest(double bandwidth) {
        this.bandwidth = Bandwidth.valueOf(bandwidth);
    }

    /**
     * Returns the bandwidth resource.
     *
     * @return the bandwidth resource
     */
    public Bandwidth bandwidth() {
        return bandwidth;
    }

    @Override
    public ResourceType type() {
        return ResourceType.BANDWIDTH;
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                .add("bandwidth", bandwidth)
                .toString();
    }
}