org.eclipse.equinox.internal.p2.metadata

Class TouchpointInstruction

java.lang.Object

org.eclipse.equinox.internal.p2.metadata.TouchpointInstruction

All Implemented Interfaces:

ITouchpointInstruction

public class TouchpointInstruction
extends java.lang.Object
implements ITouchpointInstruction

A touchpoint instruction contains either a sequence of instruction statements to be executed during a particular engine phase, or some simple string value that is needed by a touchpoint to execute its phases.

The format of a touchpoint instruction statement sequence is as follows: statement-sequence : | statement ';' | statement-sequence statement ; Where a statement is of the format: statement : | actionName '(' parameters ')' ; parameters : | // empty | parameter | parameters ',' parameter ; parameter : | paramName ':' paramValue ; actionName, paramName, paramValue : | String ;

See Also:

MetadataFactory.createTouchpointInstruction(String, String)

Constructor Summary

Constructors

Constructor and Description
TouchpointInstruction(java.lang.String body, java.lang.String importAttribute) Clients must use the factory method on MetadataFactory.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	encodeAction(java.lang.String actionName, java.util.Map<java.lang.String,java.lang.String> parameters) Encodes an action statement in string form.
boolean	equals(java.lang.Object obj) Returns whether this TouchpointInstruction is equal to the given object.
java.lang.String	getBody() Returns the body of this touchpoint instruction.
java.lang.String	getImportAttribute()
int	hashCode()
java.lang.String	toString() Returns a string representation of this instruction for debugging purposes only.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TouchpointInstruction

public TouchpointInstruction(java.lang.String body,
                             java.lang.String importAttribute)

Clients must use the factory method on MetadataFactory.

Method Detail

encodeAction

public static java.lang.String encodeAction(java.lang.String actionName,
                                            java.util.Map<java.lang.String,java.lang.String> parameters)

Encodes an action statement in string form. This method will take care of escaping any illegal characters in function parameter values.

Parameters:

actionName - The name of the action.

parameters - The function's parameters. This is a Map where the keys are parameter names, and the values are parameter values

Returns:

An encoded touchpoint instruction statement

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: ITouchpointInstruction

Returns whether this TouchpointInstruction is equal to the given object. This method returns true if:

• Both this object and the given object are of type ITouchpointInstruction
• The result of getBody() on both objects are equal
• The result of getImportAttribute() on both objects are equal

Specified by:

equals in interface ITouchpointInstruction

Overrides:

equals in class java.lang.Object

getBody

public java.lang.String getBody()

Returns the body of this touchpoint instruction. The body is either a sequence of instruction statements, or a simple string value.

Specified by:

getBody in interface ITouchpointInstruction

Returns:

The body of this touchpoint instruction

getImportAttribute

public java.lang.String getImportAttribute()

Specified by:

getImportAttribute in interface ITouchpointInstruction

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a string representation of this instruction for debugging purposes only.

Overrides:

toString in class java.lang.Object