com.sun.btrace.api.BTraceEngine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of btrace-client Show documentation
The newest version!
/*
 * Copyright 2007-2010 Sun Microsystems, Inc.  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.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.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
 * 
 * Usually, when using BTrace on a process with given PID one would do
 * 
 * BTraceTask task = BTraceEngine.sharedInstance().createTask(PID)
 * 
 * 
 *
 * @author Jaroslav Bachorik 
 */
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);
}