/*
* Copyright (c) 2007, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the Classpath exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code 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 General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.btrace.api;
import com.sun.btrace.api.impl.BTraceEngineImpl;
/**
* This class serves as a factory for {@linkplain BTraceTask} instances
* <p>
* Usually, when using BTrace on a process with given PID one would do
* <pre>
* BTraceTask task = BTraceEngine.sharedInstance().createTask(PID)
* </pre>
* </p>
*
* @author Jaroslav Bachorik <jaroslav.bachorik@sun.com>
*/
public abstract class BTraceEngine {
final public static BTraceEngine newInstance() {
return new BTraceEngineImpl();
}
/**
* Abstract factory method for {@linkplain BTraceTask} instances
* @param pid The application PID to create the task for
* @return Returns a {@linkplain BTraceTask} instance bound to the particular java process
* or null if it is not possible to run BTrace against the application
*/
abstract public BTraceTask createTask(int pid);
}