001/**
002 * Copyright (c) 2004-2011 QOS.ch
003 * All rights reserved.
004 *
005 * Permission is hereby granted, free  of charge, to any person obtaining
006 * a  copy  of this  software  and  associated  documentation files  (the
007 * "Software"), to  deal in  the Software without  restriction, including
008 * without limitation  the rights to  use, copy, modify,  merge, publish,
009 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
010 * permit persons to whom the Software  is furnished to do so, subject to
011 * the following conditions:
012 *
013 * The  above  copyright  notice  and  this permission  notice  shall  be
014 * included in all copies or substantial portions of the Software.
015 *
016 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
017 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
018 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
019 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
020 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
021 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
022 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
023 *
024 */
025package org.slf4j.profiler;
026
027/**
028 * 
029 * This demo illustrates usage of SLF4J profilers.
030 * 
031 * <p>
032 * We have been given the task of generating a large number, say N, 
033 * of random integers. We need to transform that array into a smaller array
034 * containing only prime numbers. The new array has to be sorted.
035 * 
036 * <p>
037 * While tackling this problem, we would like to measure the
038 * time spent in each subtask.
039 * 
040 * <p>
041 * A typical output for this demo would be:
042 <pre>
043 + Profiler [DEMO]
044|-- elapsed time                       [RANDOM]     0.089  seconds.
045|---+ Profiler [SORT_AND_PRUNE]
046&nbsp;&nbsp;&nbsp;&nbsp;|-- elapsed time                         [SORT]     0.221  seconds.
047&nbsp;&nbsp;&nbsp;&nbsp;|-- elapsed time             [PRUNE_COMPOSITES]    11.567  seconds.
048&nbsp;&nbsp;&nbsp;&nbsp;|-- Subtotal                   [SORT_AND_PRUNE]    11.788  seconds.
049|-- elapsed time               [SORT_AND_PRUNE]    11.788  seconds.
050|-- Total                                [DEMO]    11.877  seconds.
051</pre>
052 * 
053 * @author Ceki Gulcu
054 */
055public class NestedProfilerDemo {
056
057    public static void main(String[] args) {
058        // create a profiler called "DEMO"
059        Profiler profiler = new Profiler("DEMO");
060
061        // register this profiler in the thread context's profiler registry
062        ProfilerRegistry profilerRegistry = ProfilerRegistry.getThreadContextInstance();
063        profiler.registerWith(profilerRegistry);
064
065        // start a stopwatch called "RANDOM"
066        profiler.start("RANDOM");
067        RandomIntegerArrayGenerator riaGenerator = new RandomIntegerArrayGenerator();
068        int n = 10 * 1000;
069        int[] randomArray = riaGenerator.generate(n);
070
071        // create and start a nested profiler called "SORT_AND_PRUNE"
072        // By virtue of its parent-child relationship with the "DEMO"
073        // profiler, and the previous registration of the parent profiler,
074        // this nested profiler will be automatically registered
075        // with the thread context's profiler registry
076        profiler.startNested(SortAndPruneComposites.NESTED_PROFILER_NAME);
077
078        SortAndPruneComposites pruner = new SortAndPruneComposites(randomArray);
079        pruner.sortAndPruneComposites();
080
081        // stop and print the "DEMO" printer
082        profiler.stop().print();
083    }
084}