de.mcs.jmeasurement.renderer.MeasureDataRendererSnapshot Maven / Gradle / Ivy

Go to download

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

JMeasurement profiling programs in production enviroment

There is a newer version: 1.1.226

/*
 * MCS Media Computer Software
 * Copyright (c) 2006 by MCS
 * --------------------------------------
 * Created on 22.03.2006 by w.klaas
 *
 * 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 de.mcs.jmeasurement.renderer;

import de.mcs.jmeasurement.SnapShot;

/**
 * This interface will be used in the getReport() of the
 * MeasureFactory for defining a header and a footer for the
 * report and for the pages of a report espacially for the snapshot part.
 * 
 * @author w.klaas
 */
public interface MeasureDataRendererSnapshot {

  /**
   * starting a new snap shot.
   * 
   * @param snapShot
   *            the snapshot to start with.
   * @return String
   */
  String startSnapShot(SnapShot snapShot);

  /**
   * ending a new snap shot.
   * 
   * @param snapShot
   *            the snapshot to end with.
   * @return String
   */
  String endSnapShot(SnapShot snapShot);

}