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

Class LibrariesNode.Builder

java.lang.Object

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

Enclosing class:

LibrariesNode

public static final class LibrariesNode.Builder
extends Object

Builder for LibrariesNode.

Since:

1.63

Constructor Summary

Constructors

Constructor and Description
Builder(Project project, PropertyEvaluator eval, UpdateHelper helper, ReferenceHelper refHelper, ClassPathSupport cs)

Method Summary

Modifier and Type	Method and Description
LibrariesNode.Builder	addClassPathIgnoreRefs(String... refs) Adds references to ignore from libraries.
LibrariesNode.Builder	addClassPathProperties(String... propNames) Adds classpaths to display.
LibrariesNode.Builder	addLibrariesNodeActions(Action... actions) Adds actions to libraries node.
LibrariesNode.Builder	addModulePathIgnoreRefs(String... refs) Adds references to ignore from the module path.
LibrariesNode.Builder	addModulePathProperties(String... props) Adds module path properties.
LibrariesNode	build() Creates configured LibrariesNode.
LibrariesNode.Builder	setBootPath(ClassPath bootPath) Sets bootstrap libraries to display under the platform node.
LibrariesNode.Builder	setExtraNodes(NodeList<LibrariesNode.Key> extraNodes) Sets a factory to create additional nodes.
LibrariesNode.Builder	setModuleInfoBasedPath(ClassPath moduleInfoBasedClassPath) Sets module-info base module path.
LibrariesNode.Builder	setModuleSourcePath(ClassPath moduleSourcePath) Sets the module source path for multi module project.
LibrariesNode.Builder	setName(String name) Sets node name.
LibrariesNode.Builder	setPlatformProperty(String platformProperty) Sets platform property.
LibrariesNode.Builder	setPlatformType(String platformType) Sets platform type.
LibrariesNode.Builder	setSourcePath(ClassPath sourcePath) Sets the main source path for the LibrariesNode.
LibrariesNode.Builder	setWebModuleElementName(String elementName) Sets web module element.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               Project project,
               @NonNull
               PropertyEvaluator eval,
               @NonNull
               UpdateHelper helper,
               @NonNull
               ReferenceHelper refHelper,
               @NonNull
               ClassPathSupport cs)

Method Detail

setName

@NonNull
public LibrariesNode.Builder setName(@NonNull
                                              String name)

Sets node name.

Parameters:

name - the node name

Returns:

the LibrariesNode.Builder

addClassPathIgnoreRefs

@NonNull
public LibrariesNode.Builder addClassPathIgnoreRefs(@NonNull
                                                             String... refs)

Adds references to ignore from libraries.

Parameters:

refs - the references to ignore

Returns:

the LibrariesNode.Builder

addClassPathProperties

@NonNull
public LibrariesNode.Builder addClassPathProperties(@NonNull
                                                             String... propNames)

Adds classpaths to display.

Parameters:

propNames - the names of properties holding the paths to be displayed

Returns:

the LibrariesNode.Builder

setPlatformType

@NonNull
public LibrariesNode.Builder setPlatformType(@NonNull
                                                      String platformType)

Sets platform type.

Parameters:

platformType - the type of platform, by default "j2se"

Returns:

the LibrariesNode.Builder

setPlatformProperty

@NonNull
public LibrariesNode.Builder setPlatformProperty(@NonNull
                                                          String platformProperty)

Sets platform property.

Parameters:

platformProperty - the property holding the reference on JavaPlatform

Returns:

the LibrariesNode.Builder

setBootPath

@NonNull
public LibrariesNode.Builder setBootPath(@NonNull
                                                  ClassPath bootPath)

Sets bootstrap libraries to display under the platform node. In case when project's bootstrap libraries differ from JavaPlatform's bootstrap libraries this method can be used to override the shown JavaPlatform's libraries.

Parameters:

bootPath - the libraries to show

Returns:

the LibrariesNode.Builder

Since:

1.68

addLibrariesNodeActions

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

Adds actions to libraries node.

Parameters:

actions - the actions to be added.

Returns:

the LibrariesNode.Builder

setWebModuleElementName

@NonNull
public LibrariesNode.Builder setWebModuleElementName(@NonNull
                                                              String elementName)

Sets web module element.

Parameters:

elementName - the web module element name

Returns:

the LibrariesNode.Builder

setExtraNodes

@NonNull
public LibrariesNode.Builder setExtraNodes(@NonNull
                                                    NodeList<LibrariesNode.Key> extraNodes)

Sets a factory to create additional nodes.

Parameters:

extraNodes - the NodeList to create additional nodes

Returns:

the LibrariesNode.Builder

setModuleInfoBasedPath

@NonNull
public LibrariesNode.Builder setModuleInfoBasedPath(@NonNull
                                                             ClassPath moduleInfoBasedClassPath)

Sets module-info base module path.

Parameters:

moduleInfoBasedClassPath - the effective module info based path used for filtering the module path entries.

Returns:

the LibrariesNode.Builder

Since:

1.87

addModulePathProperties

@NonNull
public LibrariesNode.Builder addModulePathProperties(@NonNull
                                                              String... props)

Adds module path properties.

Parameters:

props - the properties to be added

Returns:

the LibrariesNode.Builder

Since:

1.87

addModulePathIgnoreRefs

@NonNull
public LibrariesNode.Builder addModulePathIgnoreRefs(@NonNull
                                                              String... refs)

Adds references to ignore from the module path.

Parameters:

refs - the references to ignore

Returns:

the LibrariesNode.Builder

Since:

1.88

setSourcePath

@NonNull
public LibrariesNode.Builder setSourcePath(@NonNull
                                                    ClassPath sourcePath)

Sets the main source path for the LibrariesNode. The given source path is used as a hint for module-info lookup.

Parameters:

sourcePath - the source ClassPath

Returns:

the LibrariesNode.Builder

Since:

1.114

setModuleSourcePath

@NonNull
public LibrariesNode.Builder setModuleSourcePath(@NonNull
                                                          ClassPath moduleSourcePath)

Sets the module source path for multi module project. The module source path is used to lookup project own modules.

Parameters:

moduleSourcePath - the project module source path

Returns:

the LibrariesNode.Builder

Since:

1.114

build

@NonNull
public LibrariesNode build()

Creates configured LibrariesNode.

Returns:

the LibrariesNode.