MemoryPoolUtilization.java

/*
 * Copyright to the original author or authors.
 *
 * 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.rioproject.system.measurable.memory.pool;

import org.rioproject.system.MeasuredResource;
import org.rioproject.watch.ThresholdValues;

/**
 * Measured JMX memory pool utilization
 */
public class MemoryPoolUtilization extends MeasuredResource {
    private final long committed;
    private final long init;
    private final long max;
    private final long used;

    /**
     * Create a {@code MemoryPoolUtilization} instance
     *
     * @param identifier The identifier to use
     * @param value The percentage of the pool that has een used
     * @param committed The amount of memory in bytes that is committed for the JVM to use.
     * @param init The amount of memory in bytes that the JVM initially requests from the operating system for
     *             memory management.
     * @param max  The maximum amount of memory in bytes that can be used for memory management.
     * @param used The amount of used memory in bytes.
     * @param thresholdValues {@code ThresholdValues} that have been applied.
     */
    public MemoryPoolUtilization(final String identifier,
                                 final double value,
                                 final long committed,
                                 final long init,
                                 final long max,
                                 final long used,
                                 final ThresholdValues thresholdValues) {
        super(identifier, value, thresholdValues);
        this.committed = committed;
        this.init = init;
        this.max = max;
        this.used = used;
    }

    public long getCommitted() {
        return committed;
    }

    public long getInit() {
        return init;
    }

    public long getMax() {
        return max;
    }

    public long getUsed() {
        return used;
    }       

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder();
        sb.append("MemoryPoolUtilization");
        sb.append(" {committed=").append(committed);
        sb.append(", init=").append(init);
        sb.append(", max=").append(max);
        sb.append(", used=").append(used);
        sb.append('}');
        return sb.toString();
    }
}