Debian Codegraph @

bundles/org.eclipse.equinox.p2.metadata/src/org/eclipse/equinox/p2/metadata/ITouchpointInstruction.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 /**
18 * A touchpoint instruction contains either a sequence of instruction statements
19 * to be executed during a particular engine phase, or some simple string value
20 * that is needed by a touchpoint to execute its phases.
21 * <p>
22 * The format of a touchpoint instruction statement sequence is as follows:
23 *
24 * statement-sequence :
25 * | statement ';'
26 * | statement-sequence statement
27 * ;
28 *
29 *Where a statement is of the format:
30 *
31 * statement :
32 * | actionName '(' parameters ')'
33 * ;
34 *
35 * parameters :
36 * | // empty
37 * | parameter
38 * | parameters ',' parameter
39 * ;
40 *
41 * parameter :
42 * | paramName ':' paramValue
43 * ;
44 *
45 * actionName, paramName, paramValue :
46 * | String
47 * ;
48 *
49 * @noimplement This interface is not intended to be implemented by clients.
50 * @noextend This interface is not intended to be extended by clients.
51 * @since 2.0
52 * @see MetadataFactory#createTouchpointInstruction(String, String)
53 */
54 public interface ITouchpointInstruction {
55
56 /**
57 * Returns the body of this touchpoint instruction. The body is either a sequence
58 * of instruction statements, or a simple string value.
59 *
60 * @return The body of this touchpoint instruction
61 */
62 public String getBody();
63
64 //TODO What is this? Please doc
65 public String getImportAttribute();
66
67 /**
68 * Returns whether this TouchpointInstruction is equal to the given object.
69 *
70 * This method returns <i>true</i> if:
71 * <ul>
72 * <li> Both this object and the given object are of type ITouchpointInstruction
73 * <li> The result of <b>getBody()</b> on both objects are equal
74 * <li> The result of <b>getImportAttribute()</b> on both objects are equal
75 * </ul>
76 */
77 @Override
78 public boolean equals(Object obj);
79
80 }