com.googlecode.htmlcompressor.compressor.HtmlCompressorStatistics Maven / Gradle / Ivy

Go to download

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

HtmlCompressor is a small, fast and very easy to use Java library that minifies given HTML or XML source by removing extra whitespaces, comments and other unneeded characters without breaking the content structure. As a result pages become smaller in size and load faster. A command-line version of the compressor is also available.

There is a newer version: 2.0.2

Show newest version

/**
 *    Copyright 2009-2017 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package com.googlecode.htmlcompressor.compressor;

/**
 * Class that stores HTML compression statistics.
 *
 * @author Sergiy Kovalchuk
 * @see HtmlCompressor#getStatistics()
 */
public class HtmlCompressorStatistics {

    /** The original metrics. */
    private HtmlMetrics originalMetrics   = new HtmlMetrics();

    /** The compressed metrics. */
    private HtmlMetrics compressedMetrics = new HtmlMetrics();

    /** The time. */
    private long        time;

    /** The preserved size. */
    private int         preservedSize;

    /**
     * Returns metrics of an uncompressed document.
     *
     * @return metrics of an uncompressed document
     * @see HtmlMetrics
     */
    public HtmlMetrics getOriginalMetrics() {
        return originalMetrics;
    }

    /**
     * Sets the original metrics.
     *
     * @param originalMetrics
     *            the originalMetrics to set
     */
    public void setOriginalMetrics(HtmlMetrics originalMetrics) {
        this.originalMetrics = originalMetrics;
    }

    /**
     * Returns metrics of a compressed document.
     *
     * @return metrics of a compressed document
     * @see HtmlMetrics
     */
    public HtmlMetrics getCompressedMetrics() {
        return compressedMetrics;
    }

    /**
     * Sets the compressed metrics.
     *
     * @param compressedMetrics
     *            the compressedMetrics to set
     */
    public void setCompressedMetrics(HtmlMetrics compressedMetrics) {
        this.compressedMetrics = compressedMetrics;
    }

    /**
     * Returns total compression time.
     * 
     * 
     * Please note that compression performance varies very significantly depending on whether it was a cold run or not
     * (specifics of Java VM), so for accurate real world results it is recommended to take measurements accordingly.
     * 
     * @return the compression time, in milliseconds
     * 
     */
    public long getTime() {
        return time;
    }

    /**
     * Sets the time.
     *
     * @param time
     *            the time to set
     */
    public void setTime(long time) {
        this.time = time;
    }

    /**
     * Returns total size of blocks that were skipped by the compressor (for example content inside
     * <pre> tags or inside <script> tags with disabled javascript compression).
     *
     * @return the total size of blocks that were skipped by the compressor, in bytes
     */
    public int getPreservedSize() {
        return preservedSize;
    }

    /**
     * Sets the preserved size.
     *
     * @param preservedSize
     *            the preservedSize to set
     */
    public void setPreservedSize(int preservedSize) {
        this.preservedSize = preservedSize;
    }

    @Override
    public String toString() {
        return String.format("Time=%d, Preserved=%d, Original={%s}, Compressed={%s}", time, preservedSize,
                originalMetrics.toString(), compressedMetrics.toString());
    }
}