org.netbeans.api.extexecution.startup

Class StartupExtender

java.lang.Object

org.netbeans.api.extexecution.startup.StartupExtender

public final class StartupExtender
extends Object

The API class allowing clients, typically server plugins or project, to query process startup extenders.

Since:

1.30

See Also:

StartupExtenderImplementation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StartupExtender.StartMode Class representing the startup mode of the process.

Method Summary

Modifier and Type	Method and Description
List<String>	getArguments() The list of arguments.
String	getDescription() Returns the description of the extender.
static List<StartupExtender>	getExtenders(Lookup context, StartupExtender.StartMode mode) Returns all registered StartupExtenders for the given start mode.
List<String>	getRawArguments() List of arguments.

Methods inherited from class java.lang.Object

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

Method Detail

getExtenders

@NonNull
public static List<StartupExtender> getExtenders(@NonNull
                                                          Lookup context,
                                                          @NonNull
                                                          StartupExtender.StartMode mode)

Returns all registered StartupExtenders for the given start mode.

The contents of the context parameter will depend on the kind of execution. For a simple Java SE program being run in the Java launcher, a org.netbeans.api.project.Project can be expected; where available, a org.netbeans.api.java.platform.JavaPlatform will be present as well. For a Java EE program being run in an application server, a org.netbeans.api.server.ServerInstance can be expected in the context. Other kinds of API objects may be present according to contracts not specified here.

This method should not be called unless and until the program is really about to be run, i.e. all known preconditions have been satisfied.

Parameters:

context - the lookup providing the contract between client and provider

mode - the startup mode the client is going to use

Returns:

the extenders representing all registered StartupExtenderImplementation

getDescription

@NonNull
public String getDescription()

Returns the description of the extender.

Returns:

the description of the extender

getArguments

@NonNull
public List<String> getArguments()

The list of arguments.

Returns:

list of arguments

getRawArguments

public List<String> getRawArguments()

List of arguments. Items of the list are literal values that should be used by the process, without escaping. They can contain spaces, and any quote, doublequote or backslashes in their literal meaning. It is up to the caller to appropriately quote or escape the values.

Returns:

list of arguments.

Since:

1.62