org.netbeans.modules.java.api.common.project

Class ProjectHooks.ProjectXmlSavedHookBuilder

java.lang.Object

org.netbeans.modules.java.api.common.project.ProjectHooks.ProjectXmlSavedHookBuilder

Enclosing class:

ProjectHooks

public static final class ProjectHooks.ProjectXmlSavedHookBuilder
extends Object

The builder for default Ant project ProjectXmlSavedHook implementation.

Method Summary

Modifier and Type	Method and Description
ProjectHooks.ProjectXmlSavedHookBuilder	addPostAction(Runnable action) Adds an action invoked at the end of the ProjectXmlSavedHook.projectXmlSaved().
ProjectHooks.ProjectXmlSavedHookBuilder	addPreAction(Runnable action) Adds an action invoked at the beginning of the ProjectXmlSavedHook.projectXmlSaved().
ProjectXmlSavedHook	build() Creates a new configured ProjectXmlSavedHook.
ProjectHooks.ProjectXmlSavedHookBuilder	setBuildImplTemplate(URL template) Sets a XSL template to generate build-impl.xml file.
ProjectHooks.ProjectXmlSavedHookBuilder	setBuildScriptProperty(String propertyName) Sets the name of property referencing the project build script.
ProjectHooks.ProjectXmlSavedHookBuilder	setBuildTemplate(URL template) Sets a XSL template to generate build.xml file.
ProjectHooks.ProjectXmlSavedHookBuilder	setOverrideModifiedBuildImplPredicate(Callable<Boolean> predicate) Sets the predicate to control regeneration of modified build-impl.

Methods inherited from class java.lang.Object

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

Method Detail

addPreAction

@NonNull
public ProjectHooks.ProjectXmlSavedHookBuilder addPreAction(@NonNull
                                                                     Runnable action)

Adds an action invoked at the beginning of the ProjectXmlSavedHook.projectXmlSaved().

Parameters:

action - the action to be added.

Returns:

the ProjectHooks.ProjectXmlSavedHookBuilder

addPostAction

@NonNull
public ProjectHooks.ProjectXmlSavedHookBuilder addPostAction(@NonNull
                                                                      Runnable action)

Adds an action invoked at the end of the ProjectXmlSavedHook.projectXmlSaved().

Parameters:

action - the action to be added.

Returns:

the ProjectHooks.ProjectXmlSavedHookBuilder

setBuildTemplate

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

Sets a XSL template to generate build.xml file.

Parameters:

template - the URL of the template

Returns:

the ProjectHooks.ProjectXmlSavedHookBuilder

setBuildImplTemplate

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

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

Parameters:

template - the URL of the template

Returns:

the ProjectHooks.ProjectXmlSavedHookBuilder

setBuildScriptProperty

@NonNull
public ProjectHooks.ProjectXmlSavedHookBuilder 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

setOverrideModifiedBuildImplPredicate

@NonNull
public ProjectHooks.ProjectXmlSavedHookBuilder setOverrideModifiedBuildImplPredicate(@NonNull
                                                                                              Callable<Boolean> predicate)

Sets the predicate to control regeneration of modified build-impl.

Parameters:

predicate - the predicate returning true if the user modified build-impl.xml should be backed up and regenerated.

Returns:

the ProjectHooks.ProjectXmlSavedHookBuilder

build

@NonNull
public ProjectXmlSavedHook build()

Creates a new configured ProjectXmlSavedHook.

Returns:

the ProjectXmlSavedHook instance