Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 122f64de810a9833fcd34e2f33895737550e44ee (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/*******************************************************************************
 * Copyright (c) 2010, 2019 IBM Corporation and others.
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jst.jsf.common.internal.resource;

import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jdt.core.ElementChangedEvent;
import org.eclipse.jdt.core.IElementChangedListener;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IJavaElementDelta;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jst.jsf.common.JSFCommonPlugin;
import org.eclipse.jst.jsf.common.internal.resource.IClasspathLifecycleListener.ClasspathLifecycleEvent;

/**
 * @author cbateman
 */
public class ClasspathEntryLifecycleListener
        extends
        AbstractLifecycleListener<IClasspathLifecycleListener.ClasspathLifecycleEvent, IClasspathLifecycleListener, IProject>
        implements IElementChangedListener
{
    private final JavaCoreMediator _mediator;

    /**
     * Initialize an inactive lifecycle listener. A classpath listener will not
     * be installed by this constructor. The object created using this
     * constructor will not fire any events until addClasspathEntry is called at
     * least once to add a target resource
     * 
     * @param mediator
     *            the mediator to use to access JavaCore operations
     * @throws NullPointerException
     *             if mediator is null.
     */
    public ClasspathEntryLifecycleListener(final JavaCoreMediator mediator)
    {
        if (mediator == null)
        {
            throw new NullPointerException(CANNOT_ADD_NULL_RESOURCE);
        }
        _mediator = mediator;
    }

    /**
     * Create a new lifecycle listener for the res
     * 
     * @param entry
     * @param mediator
     *            the workspace to listen to for changes.
     * @throws NullPointerException
     *             if res or workspace is null.
     */
    public ClasspathEntryLifecycleListener(final IProject entry,
            final JavaCoreMediator mediator)
    {
        this(mediator);
        if (entry == null)
        {
            throw new NullPointerException(CANNOT_ADD_NULL_RESOURCE);
        }
        addLifecycleObject(entry);
    }

    public void elementChanged(final ElementChangedEvent event)
    {
        // we are only interested in package fragment roots that are listening
        // for
        if (event.getType() == ElementChangedEvent.POST_CHANGE)
        {
            handlePostChangeEvent(event);
        }
    }

    private void handlePostChangeEvent(final ElementChangedEvent event)
    {
        final IJavaElementDelta delta = event.getDelta();
        new DeltaAcceptor().accept(new DeltaAcceptor.DeltaVisitor()
        {
            public void visit(final IJavaElementDelta visitDelta)
            {
                // we are only interested in package_fragment_root's
                final IJavaElement element = visitDelta.getElement();
                // only interested if a project in our entries list owns the
                // element.
                final IJavaProject javaProject = element.getJavaProject();
                if (javaProject == null
                        || !getLifecycleObjects().contains(
                                javaProject.getProject()))
                {
                    return;
                }
                if (element.getElementType() == IJavaElement.PACKAGE_FRAGMENT_ROOT)
                {
                    handlePackageFragmentRoot(visitDelta);
                } else if (element.getElementType() == IJavaElement.JAVA_PROJECT
                        && visitDelta.getResourceDeltas() != null)
                {
                    handleProject(visitDelta);
                }
                // need to test the flags only for package fragment roots
            }

            private void handleProject(final IJavaElementDelta visitDelta)
            {
                for (final IResourceDelta resDelta : visitDelta
                        .getResourceDeltas())
                {
                    try
                    {
                        resDelta.accept(new IResourceDeltaVisitor()
                        {
                            public boolean visit(final IResourceDelta resDelta2)
                                    throws CoreException
                            {
                                if (resDelta2.getKind() == IResourceDelta.REMOVED
                                        && resDelta2.getResource().getType() == IResource.FILE
                                        && "jar".equals(resDelta2.getResource().getFileExtension())) //$NON-NLS-1$
                                {
                                    fireLifecycleEvent(new ClasspathLifecycleEvent(
                                            ClasspathEntryLifecycleListener.this,
                                            visitDelta.getElement(),
                                            ClasspathLifecycleEvent.Type.REMOVED_DELTA,
                                            resDelta2.getResource()));
                                }
                                return true;
                            }
                        });
                    } catch (final CoreException e)
                    {
                        JSFCommonPlugin.log(e);
                    }
                }
            }

            private void handlePackageFragmentRoot(
                    final IJavaElementDelta visitDelta)
            {
                final int flags = visitDelta.getFlags();
                switch (visitDelta.getKind())
                {
                    case IJavaElementDelta.ADDED:
                    {
                        fireLifecycleEvent(new ClasspathLifecycleEvent(
                                ClasspathEntryLifecycleListener.this,
                                visitDelta.getElement(),
                                ClasspathLifecycleEvent.Type.ADDED));
                    }
                    break;
                    case IJavaElementDelta.REMOVED:
                    {
                        fireLifecycleEvent(new ClasspathLifecycleEvent(
                                ClasspathEntryLifecycleListener.this,
                                visitDelta.getElement(),
                                ClasspathLifecycleEvent.Type.REMOVED));
                    }
                    break;
                    case IJavaElementDelta.CHANGED:
                        if ((flags & IJavaElementDelta.F_ADDED_TO_CLASSPATH) != 0)
                        {
                            fireLifecycleEvent(new ClasspathLifecycleEvent(
                                    ClasspathEntryLifecycleListener.this,
                                    visitDelta.getElement(),
                                    ClasspathLifecycleEvent.Type.ADDED));
                        } else if ((flags & IJavaElementDelta.F_REMOVED_FROM_CLASSPATH) != 0)
                        {
                            fireLifecycleEvent(new ClasspathLifecycleEvent(
                                    ClasspathEntryLifecycleListener.this,
                                    visitDelta.getElement(),
                                    ClasspathLifecycleEvent.Type.REMOVED));
                        } else if ((flags & IJavaElementDelta.F_REORDER) != 0)
                        {
                            // TODO: how important is the case of a classpath
                            // reordering?
                        }
                    break;
                }
            }
        }, delta);
    }

    @Override
    protected void addSystemChangeListener()
    {
        _mediator.addElementChangedListener(this);
    }

    @Override
    protected void removeSystemChangeListener()
    {
        _mediator.removeElementChangeListener(this);
    }

    private static class DeltaAcceptor
    {
        public interface DeltaVisitor
        {
            public void visit(final IJavaElementDelta delta);
        }

        public void accept(final DeltaVisitor visitor,
                final IJavaElementDelta delta)
        {
            visitor.visit(delta);
            for (final IJavaElementDelta childDelta : delta
                    .getAffectedChildren())
            {
                accept(visitor, childDelta);
            }
        }
    }
}

Back to the top