org.netbeans.api.intent

Class IntentAction

java.lang.Object

org.netbeans.api.intent.IntentAction

public final class IntentAction
extends Object

Actual action for an Intent. Pair of an Intent and one of its handlers.

See Also:

Intent.getIntentActions()

Method Summary

Modifier and Type	Method and Description
Future<Object>	execute() Execute the intent action.
void	execute(Callback callback) Execute the intent action.
String	getDisplayName() Get display name of this action.
String	getIcon() Get icon of this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

execute

public void execute(@NullAllowed
                    Callback callback)

Execute the intent action. The operation will be run asynchronously.

Parameters:

callback - Callback object that will be notified when the execution completes. If callback is null, the result will be ignored.

execute

@NonNull
public Future<Object> execute()

Execute the intent action. The operation will be run asynchronously.

If the result is ignored, it's recommended to use intentAction.execute(null);

Returns:

Future for result of the action. The type of result depends on implementation of chosen intent handler, it can be null.

getDisplayName

@NonNull
public String getDisplayName()

Get display name of this action.

Returns:

The localized display name.

getIcon

@NonNull
public String getIcon()

Get icon of this action.

Returns:

Some resource identifier, e.g. icon id, path or URI. Depends on the platform. If not available, empty string is returned.