langtools/src/share/classes/com/sun/tools/javac/api/MultiTaskListener.java
author briangoetz
Wed, 18 Dec 2013 16:05:18 -0500
changeset 22163 3651128c74eb
parent 14049 3207422a0f9b
permissions -rw-r--r--
8030244: Update langtools to use Diamond Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
12016
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     1
/*
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     2
 * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     4
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    10
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    15
 * accompanied this code).
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    16
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    20
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    23
 * questions.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    24
 */
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    25
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    26
package com.sun.tools.javac.api;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    27
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    28
import java.util.Arrays;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    29
import java.util.Collection;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    30
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    31
import com.sun.source.util.TaskEvent;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    32
import com.sun.source.util.TaskListener;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    33
import com.sun.tools.javac.util.Context;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    34
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    35
/**
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    36
 * TODO.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    37
 *
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    38
 * <p><b>This is NOT part of any supported API.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    39
 * If you write code that depends on this, you do so at your own risk.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    40
 * This code and its internal interfaces are subject to change or
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    41
 * deletion without notice.</b>
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    42
 */
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    43
public class MultiTaskListener implements TaskListener {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    44
    /** The context key for the MultiTaskListener. */
22163
3651128c74eb 8030244: Update langtools to use Diamond
briangoetz
parents: 14049
diff changeset
    45
    public static final Context.Key<MultiTaskListener> taskListenerKey = new Context.Key<>();
12016
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    46
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    47
    /** Get the MultiTaskListener instance for this context. */
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    48
    public static MultiTaskListener instance(Context context) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    49
        MultiTaskListener instance = context.get(taskListenerKey);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    50
        if (instance == null)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    51
            instance = new MultiTaskListener(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    52
        return instance;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    53
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    54
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    55
    protected MultiTaskListener(Context context) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    56
        context.put(taskListenerKey, this);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    57
        ccw = ClientCodeWrapper.instance(context);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    58
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    59
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    60
    /**
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    61
     * The current set of registered listeners.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    62
     * This is a mutable reference to an immutable array.
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    63
     */
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    64
    TaskListener[] listeners = { };
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    65
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    66
    ClientCodeWrapper ccw;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    67
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    68
    public Collection<TaskListener> getTaskListeners() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    69
        return Arrays.asList(listeners);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    70
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    71
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    72
    public boolean isEmpty() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    73
        return (listeners.length == 0);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    74
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    75
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    76
    public void add(TaskListener listener) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    77
        for (TaskListener l: listeners) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    78
            if (ccw.unwrap(l) == listener)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    79
                throw new IllegalStateException();
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    80
        }
14049
3207422a0f9b 7193657: provide internal ArrayUtils class to simplify common usage of arrays in javac
jjg
parents: 12016
diff changeset
    81
        listeners = Arrays.copyOf(listeners, listeners.length + 1);
3207422a0f9b 7193657: provide internal ArrayUtils class to simplify common usage of arrays in javac
jjg
parents: 12016
diff changeset
    82
        listeners[listeners.length - 1] = ccw.wrap(listener);
12016
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    83
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    84
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    85
    public void remove(TaskListener listener) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    86
        for (int i = 0; i < listeners.length; i++) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    87
            if (ccw.unwrap(listeners[i]) == listener) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    88
                TaskListener[] newListeners = new TaskListener[listeners.length - 1];
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    89
                System.arraycopy(listeners, 0, newListeners, 0, i);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    90
                System.arraycopy(listeners, i + 1, newListeners, i, newListeners.length - i);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    91
                listeners = newListeners;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    92
                break;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    93
            }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    94
        }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    95
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    96
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    97
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    98
    public void started(TaskEvent e) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
    99
        // guard against listeners being updated by a listener
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   100
        TaskListener[] ll = this.listeners;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   101
        for (TaskListener l: ll)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   102
            l.started(e);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   103
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   104
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   105
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   106
    public void finished(TaskEvent e) {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   107
        // guard against listeners being updated by a listener
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   108
        TaskListener[] ll = this.listeners;
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   109
        for (TaskListener l: ll)
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   110
            l.finished(e);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   111
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   112
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   113
    @Override
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   114
    public String toString() {
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   115
        return Arrays.toString(listeners);
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   116
    }
1990493b64db 7093891: support multiple task listeners
jjg
parents:
diff changeset
   117
}