org.eclipse.tracecompass.statesystem.core/src/org/eclipse/tracecompass/statesystem/core/StateSystemFactory.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Alexandre Montplaisir - Initial API and implementation
  11  ******************************************************************************/
  12
  13 package org.eclipse.tracecompass.statesystem.core;
  14
  15 import java.io.IOException;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.tracecompass.internal.statesystem.core.StateSystem;
  19 import org.eclipse.tracecompass.statesystem.core.backend.IStateHistoryBackend;
  20
  21 /**
  22  * Factory to create state systems.
  23  *
  24  * Since state system are meant to be accessed using the {@link ITmfStateSystem}
  25  * and {@link ITmfStateSystemBuilder} interfaces, you can use this factory to
  26  * instantiate new ones.
  27  *
  28  * @author Alexandre Montplaisir
  29  */
  30 @NonNullByDefault
  31 public final class StateSystemFactory {
  32
  33     private StateSystemFactory() {}
  34
  35     /**
  36      * New-file factory method. For when you build a state system with a new
  37      * file, or if the back-end does not require a file on disk.
  38      *
  39      * @param backend
  40      *            Back-end plugin to use
  41      * @return The new state system
  42      */
  43    public static ITmfStateSystemBuilder newStateSystem(IStateHistoryBackend backend) {
  44        return new StateSystem(backend);
  45    }
  46
  47     /**
  48      * General factory method. The backend may try to open or create a file on
  49      * disk (the file contents and location are defined by the backend).
  50      *
  51      * @param backend
  52      *            The "state history storage" back-end to use.
  53      * @param newFile
  54      *            Put true if this is a new history started from scratch (any
  55      *            existing file will be overwritten).
  56      * @return The new state system
  57      * @throws IOException
  58      *             If there was a problem creating the new history file
  59      */
  60     public static ITmfStateSystemBuilder newStateSystem(IStateHistoryBackend backend,
  61             boolean newFile) throws IOException {
  62         return new StateSystem(backend, newFile);
  63     }
  64
  65 }