01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: package java.lang.management;
19:
20: /**
21: * <p>
22: * <code>GarbageCollectorMXBean</code> is an interface used by the management
23: * system to access garbage collector properties.
24: * </p>
25: * <p>
26: * <code>ObjectName</code> pattern: java.lang:type=GarbageCollector,name=<i>collector_name</i>
27: * </p>
28: *
29: * @since 1.5
30: */
31: public interface GarbageCollectorMXBean extends MemoryManagerMXBean {
32: /**
33: * <p>
34: * The number of collections that have been executed by this collector. A
35: * value of <code>-1</code> means that collection counts are undefined for
36: * this collector.
37: * </p>
38: *
39: * @return The number of collections executed.
40: */
41: long getCollectionCount();
42:
43: /**
44: * <p>
45: * The approximate, cumulative time (in milliseconds) spent executing
46: * collections for this collector.
47: * </p>
48: *
49: * @return The time spent collecting garbage.
50: */
51: long getCollectionTime();
52: }
|