GcProvoker.java

/*
 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package utils;

/**
 * This is an interface used to provoke GC and perform other GC-related
 * procedures
 *
 */
public interface GcProvoker {

    /**
     * The default implementation
     *
     * @return the default GC provoker
     */
    public static GcProvoker createGcProvoker() {
        return new GcProvokerImpl();
    }

    /**
     * This method provokes a GC
     */
    public void provokeGc();

    /**
     * Eats heap and metaspace Upon exit targetMemoryUsagePercent percents of
     * heap and metaspace is have been eaten
     *
     * @param targetMemoryUsagePercent how many percent of heap and metaspace to
     * eat
     */
    public void eatMetaspaceAndHeap(float targetMemoryUsagePercent);

}