Eclipse Plug-in Developer Guide (Galileo) - ActiveShellExpression (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui
Class ActiveShellExpression


java.lang.Object
  

org.eclipse.core.expressions.Expression
      
org.eclipse.ui.ActiveShellExpression

public final class ActiveShellExpression
extends Expression
extends Expression

An expression that checks the active shell variable. The variable name is ISources.ACTIVE_SHELL_NAME and falls back to ISources.ACTIVE_WORKBENCH_WINDOW. That is, if the active shell doesn't match, then it will be allowed to match the active workbench window.

Since:: 3.1

Field Summary

static int SOURCES
          The sources value to use with this expression.

Fields inherited from class org.eclipse.core.expressions. Expression

ATT_VALUE, FALSE, HASH_CODE_NOT_COMPUTED, HASH_FACTOR, TRUE

Constructor Summary

ActiveShellExpression ( Shell activeShell)
          Constructs a new instance of ActiveShellExpression

Method Summary

void collectExpressionInfo ( ExpressionInfo info)
          Expression information for this expression.

protected int computeHashCode ()
          Method to compute the hash code for this object.

boolean equals ( Object object)


EvaluationResult evaluate ( IEvaluationContext context)
          Evaluates this expression.

String toString ()


Methods inherited from class org.eclipse.core.expressions. Expression

computeExpressionInfo, equals, equals, hashCode, hashCode, hashCode

Methods inherited from class java.lang. Object

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

Field Detail

SOURCES

public static final int SOURCES

The sources value to use with this expression.

See Also:: Constant Field Values

Constructor Detail

ActiveShellExpression

public ActiveShellExpression(
Shell activeShell)

Constructs a new instance of ActiveShellExpression

Parameters:: activeShell - The shell to match with the active shell; null if it will match any active shell.

Method Detail

collectExpressionInfo

public final void collectExpressionInfo(
ExpressionInfo info)

Expression information for this expression. Namely active shell and active workbench window name.

Overrides:: collectExpressionInfo in class Expression

Parameters:: info - the expression information object used to collect the information
Since:: 3.2

computeHashCode

protected final int computeHashCode()

Description copied from class: Expression

Method to compute the hash code for this object. The result returned from this method in cached in the fHashCode field. If the value returned from the method equals Expression.HASH_CODE_NOT_COMPUTED (e.g. -1) then the value is incremented by one.

This default implementation calls super.hashCode()

Overrides:: computeHashCode in class Expression

Returns:: a hash code for this object.

equals

public final boolean equals(
Object object)

Overrides:: equals in class Object

evaluate

public final 
EvaluationResult evaluate(
IEvaluationContext context)

Evaluates this expression. If the active shell defined by the context matches the shell from this expression, then this evaluates to EvaluationResult.TRUE. Similarly, if the active workbench window shell defined by the context matches the shell from this expression, then this evaluates to EvaluationResult.TRUE.

Specified by:: evaluate in class Expression

Parameters:: context - The context from which the current state is determined; must not be null.
Returns:: EvaluationResult.TRUE if the shell is active; EvaluationResult.FALSE otherwise.