1 /*

     2  * Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 /**

    27  * This package contains internal common code for implementing tracing

    28  * frameworks, and defined a number of existing frameworks.

    29  * <p>

    30  * There are four tracing frameworks currently defined.  The "Null" and

    31  * "Multiplex" frameworks are used internally as part of the implementation.

    32  * The "DTrace" framework is the prime consumer framework at the moment,

    33  * while the "PrintStream" framework is a functional, but hidden, framework

    34  * which can be used to track probe firings.  All but the "DTrace" framework

    35  * are defined in this package.  The "DTrace" framework is implemented in the

    36  * {@code sun.tracing.dtrace} package.

    37  * <p>

    38  * This package also contains the {@code ProviderSkeleton} class, which

    39  * holds most of the common code needed for implementing frameworks.

    40  * <p>

    41  * The "Null" framework is used when there are no other active frameworks.

    42  * It accomplishes absolutely nothing and is merely a placeholder so that

    43  * the application can call the tracing routines without error.

    44  * <p>

    45  * The "Multiplex" framework is used when there are multiple active frameworks.

    46  * It is initialized with the framework factories and create providers and

    47  * probes that dispatch to each active framework in turn.

    48  * <p>

    49  * The "PrintStream" framework is currently a debugging framework which

    50  * dispatches trace calls to a user-defined PrintStream class, defined by

    51  * a property.  It may some day be opened up to general use.

    52  * <p>

    53  * See the {@code sun.tracing.dtrace} and {@code com.sun.tracing.dtrace}

    54  * packages for information on the "DTrace" framework.

    55  */

    56 

    57 package sun.tracing;