com.caoccao.javet.interop.monitoring.V8SharedMemoryStatistics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javet-macos Show documentation
Javet is Java + V8 (JAVa + V + EighT). It is an awesome way of embedding Node.js and V8 in Java.
There is a newer version: 4.0.0
/*
 * Copyright (c) 2021-2023. caoccao.com Sam Cao
 *
 * 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 com.caoccao.javet.interop.monitoring;

/**
 * The type V8 shared memory statistics is a collection of shared per-process V8 memory information.
 *
 * @since 1.0.0
 */
public final class V8SharedMemoryStatistics {
    private final long readOnlySpacePhysicalSize;
    private final long readOnlySpaceSize;
    private final long readOnlySpaceUsedSize;

    /**
     * Instantiates a new V8 shared memory statistics.
     *
     * @param readOnlySpacePhysicalSize the read only space physical size
     * @param readOnlySpaceSize         the read only space size
     * @param readOnlySpaceUsedSize     the read only space used size
     * @since 1.0.1
     */
    public V8SharedMemoryStatistics(
            long readOnlySpacePhysicalSize,
            long readOnlySpaceSize,
            long readOnlySpaceUsedSize) {
        this.readOnlySpacePhysicalSize = readOnlySpacePhysicalSize;
        this.readOnlySpaceSize = readOnlySpaceSize;
        this.readOnlySpaceUsedSize = readOnlySpaceUsedSize;
    }

    /**
     * Gets read only space physical size.
     *
     * @return the read only space physical size
     * @since 1.0.0
     */
    public long getReadOnlySpacePhysicalSize() {
        return readOnlySpacePhysicalSize;
    }

    /**
     * Gets read only space size.
     *
     * @return the read only space size
     * @since 1.0.0
     */
    public long getReadOnlySpaceSize() {
        return readOnlySpaceSize;
    }

    /**
     * Gets read only space used size.
     *
     * @return the read only space used size
     * @since 1.0.0
     */
    public long getReadOnlySpaceUsedSize() {
        return readOnlySpaceUsedSize;
    }

    /**
     * Minus the input V8 shared memory statistics to produce a diff.
     *
     * @param v8SharedMemoryStatistics the V8 shared memory statistics
     * @return the V8 shared memory statistics diff
     */
    public V8SharedMemoryStatistics minus(V8SharedMemoryStatistics v8SharedMemoryStatistics) {
        return new V8SharedMemoryStatistics(
                this.readOnlySpacePhysicalSize - v8SharedMemoryStatistics.readOnlySpacePhysicalSize,
                this.readOnlySpaceSize - v8SharedMemoryStatistics.readOnlySpaceSize,
                this.readOnlySpaceUsedSize - v8SharedMemoryStatistics.readOnlySpaceUsedSize);
    }

    @Override
    public String toString() {
        return toString(false);
    }

    /**
     * To string with zero value ignored or not.
     *
     * @param ignoreZero ignore zero
     * @return the string
     * @since 1.0.7
     */
    public String toString(boolean ignoreZero) {
        StringBuilder sb = new StringBuilder();
        sb.append("name = ").append(getClass().getSimpleName());
        if (!ignoreZero || readOnlySpacePhysicalSize != 0)
            sb.append(", ").append("readOnlySpacePhysicalSize = ").append(readOnlySpacePhysicalSize);
        if (!ignoreZero || readOnlySpaceSize != 0)
            sb.append(", ").append("readOnlySpaceSize = ").append(readOnlySpaceSize);
        if (!ignoreZero || readOnlySpaceUsedSize != 0)
            sb.append(", ").append("readOnlySpaceUsedSize = ").append(readOnlySpaceUsedSize);
        return sb.toString();
    }
}