Debian Codegraph @

bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/ITouchpointData.java

raw
1 /*******************************************************************************
2 * Copyright (c) 2008, 2017 EclipseSource and others.
3 *
4 * This
5 * program and the accompanying materials are made available under the terms of
6 * the Eclipse Public License 2.0 which accompanies this distribution, and is
7 * available at
8 * https://www.eclipse.org/legal/epl-2.0/
9 *
10 * SPDX-License-Identifier: EPL-2.0
11 *
12 * Contributors:
13 * EclipseSource - initial API and implementation
14 ******************************************************************************/
15 package org.eclipse.equinox.p2.metadata;
16
17 import java.util.Map;
18
19 /**
20 * ITouchpoint data instances contain the additional information needed by a touchpoint
21 * to execute each engine phase it participates in. This includes the sequence of
22 * instruction statements to be executed during each phase, and any additional
23 * supporting data needed to perform the phase.
24 *
25 * @see MetadataFactory#createTouchpointData(Map)
26 * @noimplement This interface is not intended to be implemented by clients.
27 * @noextend This interface is not intended to be extended by clients.
28 * @since 2.0
29 */
30 public interface ITouchpointData {
31
32 /**
33 * Returns the touchpoint instruction corresponding to the given key.
34 *
35 * @return the touchpoint instruction corresponding to the given key,
36 * or <code>null</code> if no such instruction exists.
37 */
38 public ITouchpointInstruction getInstruction(String instructionKey);
39
40 /**
41 * Returns an unmodifiable map of the touchpoint instructions. The map
42 * keys are strings, and the values are instances of {@link ITouchpointInstruction}.
43 *
44 * @return the touchpoint instructions
45 */
46 public Map<String, ITouchpointInstruction> getInstructions();
47
48 /**
49 * Returns whether this TouchpointData is equal to the given object.
50 *
51 * This method returns <i>true</i> if:
52 * <ul>
53 * <li> Both this object and the given object are of type ITouchpointData
54 * <li> The result of <b>getInstructions()</b> on both objects are equal
55 * </ul>
56 */
57 @Override
58 public boolean equals(Object obj);
59 }