org.netbeans.api.intent

Class Intent

java.lang.Object

org.netbeans.api.intent.Intent

public final class Intent
extends Object

Description of some intended operation. The operation is described by an action and a URI.

If the intent is executed, proper registered handler is chosen to perform the actual operation.

For example, the following code can be used to open a file in editor (if the environment is suitable for such operation).

new Intent(Intent.ACTION_VIEW, new URI("file://path/file.txt")).execute();

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_EDIT Standard EDIT action type.
static String	ACTION_VIEW Standard VIEW action type.

Constructor Summary

Constructors

Constructor and Description
Intent(String action, URI uri) Constructor for an intended operation.

Method Summary

Modifier and Type	Method and Description
Future<Object>	execute() Execute the intent.
void	execute(Callback callback) Execute the intent.
String	getAction() Get action type.
SortedSet<? extends IntentAction>	getIntentActions() Get available actions for the intent.
URI	getUri() Get URI specifying this intent.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_VIEW

public static final String ACTION_VIEW

Standard VIEW action type.

See Also:

Constant Field Values

ACTION_EDIT

public static final String ACTION_EDIT

Standard EDIT action type.

See Also:

Constant Field Values

Constructor Detail

Intent

public Intent(@NonNull
              String action,
              @NonNull
              URI uri)

Constructor for an intended operation.

Parameters:

action - Action type to perform. It is recommended to use either standard actions predefined in Intent class (see ACTION_EDIT, ACTION_VIEW), or strings similar to fully qualified field names (e.g. "org.some.package.ClassName.ACTION_CUSTOM").

uri - URI specifying the operation.

Method Detail

getAction

@NonNull
public String getAction()

Get action type.

Returns:

The action type.

getUri

@NonNull
public URI getUri()

Get URI specifying this intent.

Returns:

The URI.

execute

@NonNull
public Future<Object> execute()

Execute the intent. The operation will be run asynchronously.

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

Returns:

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

execute

public void execute(@NullAllowed
                    Callback callback)

Execute the intent. 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.

getIntentActions

@NonNull
public SortedSet<? extends IntentAction> getIntentActions()

Get available actions for the intent.

Returns:

Immutable set of available actions, sorted by priority.

toString

public String toString()

Overrides:

toString in class Object