com.sleepycat.je.utilint.BaseStat Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of je Show documentation

Berkeley DB Java Edition is a open source, transactional storage solution for Java applications. The Direct Persistence Layer (DPL) API is faster and easier to develop, deploy, and manage than serialized object files or ORM-based Java persistence solutions. The Collections API enhances the standard java.util.collections classes allowing them to be persisted to a local file system and accessed concurrently while protected by ACID transactions. Data is stored by serializing objects and managing class and instance data separately so as not to waste space. Berkeley DB Java Edition is the reliable drop-in solution for complex, fast, and scalable storage. Source for this release is in 'je-4.0.92-sources.jar', the Javadoc is located at 'http://download.oracle.com/berkeley-db/docs/je/4.0.92/'.

There is a newer version: 5.0.73

Show newest version

/*-
 * Copyright (C) 2002, 2018, Oracle and/or its affiliates. All rights reserved.
 *
 * This file was distributed by Oracle as part of a version of Oracle Berkeley
 * DB Java Edition made available at:
 *
 * http://www.oracle.com/technetwork/database/database-technologies/berkeleydb/downloads/index.html
 *
 * Please see the LICENSE file included in the top-level directory of the
 * appropriate version of Oracle Berkeley DB Java Edition for a copy of the
 * license and additional information.
 */

package com.sleepycat.je.utilint;

import java.io.Serializable;

/**
 * The basic interface for accessing and clearing statistics for use in both
 * standalone statistics and component statistics contained in a {@link
 * MapStat}.
 *
 * @param  the type of the statistic value
 */
public abstract class BaseStat implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * Returns the value of the statistic.
     *
     * @return the value
     */
    public abstract T get();

    /** Resets the statistic to its initial state. */
    public abstract void clear();

    /**
     * Returns a copy of this statistic.
     *
     * @return a copy
     */
    public abstract BaseStat copy();

    /**
     * Returns the value of the statistic as a formatted string.
     *
     * @return the value as a formatted string
     */
    protected abstract String getFormattedValue();

    /**
     * Returns whether the statistic is in its initial state.
     *
     * @return if the statistic is in its initial state
     */
    public abstract boolean isNotSet();
}