bundles/org.simantics.nativemem/src/org/simantics/nativemem/ProcessMemoryInfo.java

   1 /*******************************************************************************
   2  * Copyright (c) 2016, 2017 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     Semantum Oy - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.nativemem;
  13
  14 /**
  15  * Architecture-independent representation of a native processes memory usage
  16  * state.
  17  *
  18  * @author Tuukka Lehtonen
  19  */
  20 public interface ProcessMemoryInfo {
  21
  22     /**
  23      * @return a non-structured human readable string representation of this instances contents
  24      */
  25     String toHumanReadableString();
  26
  27     /**
  28      * @return tab-separated row of text containing N columns of explanatory
  29      *         header text for writing a tab-separated "CSV" file
  30      */
  31     String headerRow();
  32
  33     /**
  34      * @return tab-separated row of text containing N columns of data values
  35      *         that match the explanations provided by {@link #headerRow()}
  36      */
  37     String dataRow();
  38
  39 }