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

Class MultiModuleNodeFactory.Builder

java.lang.Object

org.netbeans.modules.java.api.common.project.ui.MultiModuleNodeFactory.Builder

Enclosing class:

MultiModuleNodeFactory

public static final class MultiModuleNodeFactory.Builder
extends Object

A builder of the MultiModuleNodeFactory.

Method Summary

Modifier and Type	Method and Description
MultiModuleNodeFactory.Builder	addLibrariesNodeActions(Action... actions) Adds actions into the modules libraries nodes.
MultiModuleNodeFactory.Builder	addLibrariesNodes() Adds libraries nodes into the logical view.
MultiModuleNodeFactory.Builder	addTestLibrariesNodeActions(Action... actions) Adds actions into the modules test libraries nodes.
MultiModuleNodeFactory	build() Builds the MultiModuleNodeFactory.
static MultiModuleNodeFactory.Builder	create(UpdateHelper helper, PropertyEvaluator eval, ReferenceHelper refHelper) Creates a new MultiModuleNodeFactory.Builder.
MultiModuleNodeFactory.Builder	setAnnotationProcessorsGeneratedSourcesProperty(String propName) Sets the property holding the location of the annotation processors source output.
MultiModuleNodeFactory.Builder	setSources(SourceRoots sourceModules, SourceRoots srcRoots) Adds project's source modules into the logical view.
MultiModuleNodeFactory.Builder	setTests(SourceRoots testModules, SourceRoots testRoots) Adds project's test modules into the logical view.

Methods inherited from class java.lang.Object

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

Method Detail

setSources

@NonNull
public MultiModuleNodeFactory.Builder setSources(@NonNull
                                                          SourceRoots sourceModules,
                                                          @NonNull
                                                          SourceRoots srcRoots)

Adds project's source modules into the logical view.

Parameters:

sourceModules - the module roots

srcRoots - the source roots

Returns:

the MultiModuleNodeFactory.Builder

setTests

@NonNull
public MultiModuleNodeFactory.Builder setTests(@NonNull
                                                        SourceRoots testModules,
                                                        @NonNull
                                                        SourceRoots testRoots)

Adds project's test modules into the logical view.

Parameters:

testModules - the module roots

testRoots - the source roots

Returns:

the MultiModuleNodeFactory.Builder

addLibrariesNodes

@NonNull
public MultiModuleNodeFactory.Builder addLibrariesNodes()

Adds libraries nodes into the logical view.

Returns:

the MultiModuleNodeFactory.Builder

addLibrariesNodeActions

@NonNull
public MultiModuleNodeFactory.Builder addLibrariesNodeActions(@NonNull
                                                                       Action... actions)

Adds actions into the modules libraries nodes. If the Action is an instance of ContextAwareAction the Lookup with source path is injected into the Action. The source path can be used to identify actual module of an multi module project.

Parameters:

actions - the Actions to add

Returns:

the MultiModuleNodeFactory.Builder

addTestLibrariesNodeActions

@NonNull
public MultiModuleNodeFactory.Builder addTestLibrariesNodeActions(@NonNull
                                                                           Action... actions)

Adds actions into the modules test libraries nodes. If the Action is an instance of ContextAwareAction the Lookup with source path is injected into the Action. The source path can be used to identify actual module of an multi module project.

Parameters:

actions - the Actions to add

Returns:

the MultiModuleNodeFactory.Builder

setAnnotationProcessorsGeneratedSourcesProperty

@NonNull
public MultiModuleNodeFactory.Builder setAnnotationProcessorsGeneratedSourcesProperty(@NonNull
                                                                                               String propName)

Sets the property holding the location of the annotation processors source output. Default value is ProjectProperties.ANNOTATION_PROCESSING_SOURCE_OUTPUT

Parameters:

propName - the name of the property.

Returns:

the MultiModuleNodeFactory.Builder

build

@NonNull
public MultiModuleNodeFactory build()

Builds the MultiModuleNodeFactory.

Returns:

the new MultiModuleNodeFactory instance

create

@NonNull
public static MultiModuleNodeFactory.Builder create(@NonNull
                                                             UpdateHelper helper,
                                                             @NonNull
                                                             PropertyEvaluator eval,
                                                             @NonNull
                                                             ReferenceHelper refHelper)

Creates a new MultiModuleNodeFactory.Builder.

Parameters:

helper - the UpdateHelper

eval - the PropertyEvaluator

refHelper - the ReferenceHelper

Returns:

the MultiModuleNodeFactory.Builder