Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: b75d14f5090d7eb1fab51509bedd3b0ffe577370 (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
/*******************************************************************************
 * 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.locator;

import java.util.Iterator;

import org.eclipse.jst.jsf.common.internal.policy.IIteratorPolicy;
import org.eclipse.jst.jsf.common.internal.strategy.IteratorPolicyBasedStrategyComposite;

/**
 * @author cbateman
 *
 * @param <LOCATORTYPE>
 * @param <COMPOSITETYPE>
 * @param <CONTEXTTYPE>
 * @param <IDTYPE>
 */
public abstract class CompositeLocator<LOCATORTYPE, COMPOSITETYPE, CONTEXTTYPE, IDTYPE> extends
IteratorPolicyBasedStrategyComposite<CONTEXTTYPE, LOCATORTYPE, COMPOSITETYPE, IDTYPE, ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE>>
implements ILocator<COMPOSITETYPE, CONTEXTTYPE, IDTYPE>, ILocatorChangeListener
{
    private DefaultComposingLocatorDelegate<LOCATORTYPE, COMPOSITETYPE, CONTEXTTYPE, IDTYPE> _delegate;
    private final COMPOSITETYPE _noResultValue;

    /**
     * @param id
     * @param displayName
     * @param policy
     * @param noResultValue
     * @param compositionStrategy
     */
    public CompositeLocator(
            final IDTYPE id,
            final String displayName,
            final IIteratorPolicy<IDTYPE> policy,
            final COMPOSITETYPE noResultValue,
            final DefaultCompositionStrategy<CONTEXTTYPE, LOCATORTYPE, COMPOSITETYPE, ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE>> compositionStrategy)
    {
        super(policy, compositionStrategy);
        _delegate = new DefaultComposingLocatorDelegate<LOCATORTYPE, COMPOSITETYPE, CONTEXTTYPE, IDTYPE>(id, displayName)
        {
            @Override
            protected COMPOSITETYPE doLocate(final CONTEXTTYPE context)
            {
                return CompositeLocator.this.doLocate(context);
            }
        };
        _noResultValue = noResultValue;
    }

    /**
     * @param context
     * @return the located value.
     */
    protected abstract COMPOSITETYPE doLocate(CONTEXTTYPE context);

    public final IDTYPE getId()
    {
        return _delegate.getId();
    }

    public String getDisplayName()
    {
        return _delegate.getDisplayName();
    }

    public void start(final CONTEXTTYPE initialContext)
    {
        if (canStart())
        {
            final Iterator<ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE>> iterator = getIterator();
            while (iterator.hasNext())
            {

                final ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE> next = iterator.next();
                next.addListener(this);
                next.start(initialContext);
            }
            _delegate.start(initialContext);
        }
        throw new IllegalStateException("canStart must be called before calling start"); //$NON-NLS-1$
    }

    public boolean canStart()
    {
        boolean canStart = true;
        final Iterator<ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE>> iterator = getIterator();
        while (canStart && iterator.hasNext())
        {
            canStart &= iterator.next().canStart();
        }

        return canStart && _delegate.canStart();
    }

    public boolean isStarted()
    {
        return _delegate.isStarted();
    }

    public void stop()
    {
        if (!isStarted())
        {
            final Iterator<ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE>> iterator = getIterator();
            while (iterator.hasNext())
            {
                final ILocator<LOCATORTYPE, CONTEXTTYPE, IDTYPE> next = iterator.next();
                next.removeListener(this);
                next.stop();
            }

            _delegate.stop();
        }
    }

    public COMPOSITETYPE locate(final CONTEXTTYPE context)
    {
        return _delegate.locate(context);
    }

    @Override
    public COMPOSITETYPE getNoResult()
    {
        return _noResultValue;
    }


    public void changed(final LocatorChangeEvent event)
    {
        _delegate.fireChangeEvent(event);
    }


    public void addListener(final ILocatorChangeListener listener)
    {
        _delegate.addListener(listener);
    }


    public void removeListener(final ILocatorChangeListener listener)
    {
        _delegate.removeListener(listener);
    }

    /**
     * Re-fire events from composed strategies.
     * 
     * @param event
     */
    protected void fireChangeEvent(final LocatorChangeEvent event)
    {
        _delegate.fireChangeEvent(event);
    }

}

Back to the top