/*
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2007 - 2009 Pentaho Corporation and Contributors.  All rights reserved.
 */

package org.pentaho.reporting.libraries.base.util;

/**
 * A helper class to print memory usage message if needed.
 *
 * @author Thomas Morgner
 */
public class MemoryUsageMessage
{

  /**
   * The message.
   */
  private final String message;

  /**
   * Creates a new message.
   *
   * @param message the message.
   */
  public MemoryUsageMessage(final String message)
  {
    this.message = message;
  }

  /**
   * Returns a string representation of the message (useful for debugging).
   *
   * @return the string.
   */
  public String toString()
  {
    return this.message + "Free: " + Runtime.getRuntime().freeMemory() + "; "
        + "Total: " + Runtime.getRuntime().totalMemory();
  }

}