1 /*-
2  * Automatically built by dist/s_java_stat.
3  * Only the javadoc comments can be edited.
4  *
5  * See the file LICENSE for redistribution information.
6  *
7  * Copyright (c) 2002, 2013 Oracle and/or its affiliates.  All rights reserved.
8  */
9 
10 package com.sleepycat.db;
11 
12 /**
13 The HeapStats object is used to return Heap database statistics.
14 */
15 public class HeapStats extends DatabaseStats {
16     // no public constructor
HeapStats()17     /* package */ HeapStats() {}
18 
19     private int heap_magic;
20     /**
21 	Magic number that identifies the file as a Heap file.
22     */
getHeapMagic()23     public int getHeapMagic() {
24         return heap_magic;
25     }
26 
27     private int heap_version;
28     /**
29 	The version of the Heap database.
30     */
getHeapVersion()31     public int getHeapVersion() {
32         return heap_version;
33     }
34 
35     private int heap_metaflags;
36     /**
37        Reports internal flags. For internal use only.
38     */
getHeapMetaFlags()39     public int getHeapMetaFlags() {
40         return heap_metaflags;
41     }
42 
43     private int heap_nrecs;
44     /**
45        Reports the number of records in the Heap database.
46     */
getHeapNumRecs()47     public int getHeapNumRecs() {
48         return heap_nrecs;
49     }
50 
51     private int heap_pagecnt;
52     /**
53        The number of pages in the database.
54     */
getHeapPageCount()55     public int getHeapPageCount() {
56         return heap_pagecnt;
57     }
58 
59     private int heap_pagesize;
60     /**
61        The underlying database page (and bucket) size, in bytes.
62     */
getHeapPageSize()63     public int getHeapPageSize() {
64         return heap_pagesize;
65     }
66 
67     private int heap_nregions;
68     /**
69        The number of regions in the Heap database.
70     */
getHeapNumRegions()71     public int getHeapNumRegions() {
72         return heap_nregions;
73     }
74 
75     private int heap_regionsize;
76     /** TODO */
getHeapRegionSize()77     public int getHeapRegionSize() {
78         return heap_regionsize;
79     }
80 
81     /**
82     For convenience, the HeapStats class has a toString method
83     that lists all the data fields.
84     */
toString()85     public String toString() {
86         return "HeapStats:"
87             + "\n  heap_magic=" + heap_magic
88             + "\n  heap_version=" + heap_version
89             + "\n  heap_metaflags=" + heap_metaflags
90             + "\n  heap_nrecs=" + heap_nrecs
91             + "\n  heap_pagecnt=" + heap_pagecnt
92             + "\n  heap_pagesize=" + heap_pagesize
93             + "\n  heap_nregions=" + heap_nregions
94             + "\n  heap_regionsize=" + heap_regionsize
95             ;
96     }
97 }
98