ProjectHooks.ProjectOpenedHookBuilder (Java Common Project API)

java.lang.Object
- org.netbeans.modules.java.api.common.project.ProjectHooks.ProjectOpenedHookBuilder

Enclosing class:

ProjectHooks
```
public static final class ProjectHooks.ProjectOpenedHookBuilder
extends Object
```
The builder for default Ant project ProjectOpenedHook implementation.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProjectHooks.ProjectOpenedHookBuilder`	`addClassPathType(String classPathType)` Adds a class path type among important class path types.
`ProjectHooks.ProjectOpenedHookBuilder`	`addClosePostAction(Runnable action)` Adds an action invoked at the end of `ProjectOpenedHook.projectClosed()`.
`ProjectHooks.ProjectOpenedHookBuilder`	`addClosePreAction(Runnable action)` Adds an action invoked at the beginning of `ProjectOpenedHook.projectClosed()`.
`ProjectHooks.ProjectOpenedHookBuilder`	`addOpenPostAction(Runnable action)` Adds an action invoked at the end of the `ProjectOpenedHook.projectOpened()`.
`ProjectHooks.ProjectOpenedHookBuilder`	`addOpenPreAction(Runnable action)` Adds an action invoked at the beginning of the `ProjectOpenedHook.projectOpened()`.
`ProjectOpenedHook`	`build()` Creates a new configured `ProjectOpenedHook`.
`ProjectHooks.ProjectOpenedHookBuilder`	`setBuildImplTemplate(URL template)` Sets a XSL template to generate build-impl.xml file.
`ProjectHooks.ProjectOpenedHookBuilder`	`setBuildScriptProperty(String propertyName)` Sets the name of property referencing the project build script.
`ProjectHooks.ProjectOpenedHookBuilder`	`setBuildTemplate(URL template)` Sets a XSL template to generate build.xml file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addClassPathType
```
@NonNull
public ProjectHooks.ProjectOpenedHookBuilder addClassPathType(@NonNull
                                                                       String classPathType)
```
Adds a class path type among important class path types. The important class path types are registered to GlobalPathRegistry when the project is opened and unregistered when the project is closed.

Parameters:

classPathType - the class path type to add.

Returns:

the ProjectHooks.ProjectOpenedHookBuilder

addOpenPreAction

@NonNull
public ProjectHooks.ProjectOpenedHookBuilder addOpenPreAction(@NonNull
                                                                       Runnable action)

Adds an action invoked at the beginning of the ProjectOpenedHook.projectOpened().

Parameters:: action - the action to be added.
Returns:: the ProjectHooks.ProjectOpenedHookBuilder

addOpenPostAction

@NonNull
public ProjectHooks.ProjectOpenedHookBuilder addOpenPostAction(@NonNull
                                                                        Runnable action)

Adds an action invoked at the end of the ProjectOpenedHook.projectOpened().

Parameters:: action - the action to be added.
Returns:: the ProjectHooks.ProjectOpenedHookBuilder

addClosePreAction

@NonNull
public ProjectHooks.ProjectOpenedHookBuilder addClosePreAction(@NonNull
                                                                        Runnable action)

Adds an action invoked at the beginning of ProjectOpenedHook.projectClosed().

Parameters:: action - the action to be added.
Returns:: the ProjectHooks.ProjectOpenedHookBuilder

addClosePostAction

@NonNull
public ProjectHooks.ProjectOpenedHookBuilder addClosePostAction(@NonNull
                                                                         Runnable action)

Adds an action invoked at the end of ProjectOpenedHook.projectClosed().

Parameters:: action - the action to be added.
Returns:: the ProjectHooks.ProjectOpenedHookBuilder

setBuildTemplate

@NonNull
public ProjectHooks.ProjectOpenedHookBuilder setBuildTemplate(@NonNull
                                                                       URL template)

Sets a XSL template to generate build.xml file.

Parameters:: template - the URL of the template
Returns:: the ProjectHooks.ProjectOpenedHookBuilder

setBuildImplTemplate

@NonNull
public ProjectHooks.ProjectOpenedHookBuilder setBuildImplTemplate(@NonNull
                                                                           URL template)

Sets a XSL template to generate build-impl.xml file.

Parameters:: template - the URL of the template
Returns:: the ProjectHooks.ProjectOpenedHookBuilder

setBuildScriptProperty
```
@NonNull
public ProjectHooks.ProjectOpenedHookBuilder setBuildScriptProperty(@NonNull
                                                                             String propertyName)
```
Sets the name of property referencing the project build script. If not set the ProjectProperties.BUILD_SCRIPT is used.

Parameters:

propertyName - the name of property holding the name of project's build script.

Returns:

the ProjectOperations.ProjectOperationsBuilder

build
```
@NonNull
public ProjectOpenedHook build()
```
Creates a new configured ProjectOpenedHook.

Returns:

the ProjectOpenedHook instance

Class ProjectHooks.ProjectOpenedHookBuilder

Method Summary

Methods inherited from class java.lang.Object