1 /*
   2  * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 package utils;
  24 
  25 /**
  26  * This is an interface used to provoke GC and perform other GC-related
  27  * procedures
  28  *
  29  */
  30 public interface GcProvoker {
  31 
  32     /**
  33      * The default implementation
  34      *
  35      * @return the default GC provoker
  36      */
  37     public static GcProvoker createGcProvoker() {
  38         return new GcProvokerImpl();
  39     }
  40 
  41     /**
  42      * This method provokes a GC
  43      */
  44     public void provokeGc();
  45 
  46     /**
  47      * Eats heap and metaspace Upon exit targetMemoryUsagePercent percents of
  48      * heap and metaspace is have been eaten
  49      *
  50      * @param targetMemoryUsagePercent how many percent of heap and metaspace to
  51      * eat
  52      */
  53     public void eatMetaspaceAndHeap(float targetMemoryUsagePercent);
  54 
  55 }