Package org.codehaus.plexus.languages.java.jpms

Class ResolvePathsRequest<T>

java.lang.Object

org.codehaus.plexus.languages.java.jpms.ResolvePathsRequest<T>

public abstract class ResolvePathsRequest<T>
extends Object

Contains all information required to analyze the project

Since:

1.0.0

Author:

Robert Scholte

Method Summary

Modifier and Type	Method	Description
Collection<String>	getAdditionalModules()
Path	getJdkHome()
Path	getMainModuleDescriptor()
JavaModuleDescriptor	getModuleDescriptor()
Collection<T>	getPathElements()
boolean	isIncludeAllProviders()
boolean	isIncludeStatic()
static ResolvePathsRequest<File>	ofFiles(File... files)
static ResolvePathsRequest<File>	ofFiles(Collection<File> files)
static ResolvePathsRequest<Path>	ofPaths(Path... paths)
static ResolvePathsRequest<Path>	ofPaths(Collection<Path> paths)
static ResolvePathsRequest<String>	ofStrings(String... strings)
static ResolvePathsRequest<String>	ofStrings(Collection<String> strings)
ResolvePathsRequest<T>	setAdditionalModules(Collection<String> additionalModules)	The module names that are usually passed with --add-modules
ResolvePathsRequest<T>	setIncludeAllProviders(boolean includeAllProviders)	Will also include all modules that contain providers for used services, should only be used at runtime (not during compile nor test)
ResolvePathsRequest<T>	setIncludeStatic(boolean includeStatic)
ResolvePathsRequest<T>	setJdkHome(T jdkHome)	In case the JRE is Java 8 or before, this jdkHome is used to extract the module name.
ResolvePathsRequest<T>	setMainModuleDescriptor(T mainModuleDescriptor)	Must be either module-info.java or module-info.class
ResolvePathsRequest<T>	setModuleDescriptor(JavaModuleDescriptor mainModuleDescriptor)	Provide a resolved module descriptor
protected abstract Path	toPath(T t)
static ResolvePathsRequest<File>	withFiles(Collection<File> files)	Deprecated. use ofFiles(Collection) instead
static ResolvePathsRequest<Path>	withPaths(Collection<Path> paths)	Deprecated. use ofPaths(Collection) instead
static ResolvePathsRequest<String>	withStrings(Collection<String> strings)	Deprecated. use ofStrings(Collection) instead

Methods inherited from class java.lang.Object

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

Method Details

withFiles

@Deprecated
public static ResolvePathsRequest<File> withFiles(Collection<File> files)

Deprecated.

use ofFiles(Collection) instead

ofFiles

public static ResolvePathsRequest<File> ofFiles(File... files)

ofFiles

public static ResolvePathsRequest<File> ofFiles(Collection<File> files)

withPaths

@Deprecated
public static ResolvePathsRequest<Path> withPaths(Collection<Path> paths)

Deprecated.

use ofPaths(Collection) instead

ofPaths

public static ResolvePathsRequest<Path> ofPaths(Path... paths)

ofPaths

public static ResolvePathsRequest<Path> ofPaths(Collection<Path> paths)

withStrings

@Deprecated
public static ResolvePathsRequest<String> withStrings(Collection<String> strings)

Deprecated.

use ofStrings(Collection) instead

ofStrings

public static ResolvePathsRequest<String> ofStrings(String... strings)

ofStrings

public static ResolvePathsRequest<String> ofStrings(Collection<String> strings)

toPath

protected abstract Path toPath(T t)

getMainModuleDescriptor

public Path getMainModuleDescriptor()

getModuleDescriptor

public JavaModuleDescriptor getModuleDescriptor()

setMainModuleDescriptor

public ResolvePathsRequest<T> setMainModuleDescriptor(T mainModuleDescriptor)

Must be either module-info.java or module-info.class

Parameters:

mainModuleDescriptor -

Returns:

this request

setModuleDescriptor

public ResolvePathsRequest<T> setModuleDescriptor(JavaModuleDescriptor mainModuleDescriptor)

Provide a resolved module descriptor

Parameters:

mainModuleDescriptor -

Returns:

this request

getPathElements

public Collection<T> getPathElements()

setJdkHome

public ResolvePathsRequest<T> setJdkHome(T jdkHome)

In case the JRE is Java 8 or before, this jdkHome is used to extract the module name.

Parameters:

jdkHome -

Returns:

this request

getJdkHome

public Path getJdkHome()

setAdditionalModules

public ResolvePathsRequest<T> setAdditionalModules(Collection<String> additionalModules)

The module names that are usually passed with --add-modules

Parameters:

additionalModules -

Returns:

this request

getAdditionalModules

public Collection<String> getAdditionalModules()

setIncludeAllProviders

public ResolvePathsRequest<T> setIncludeAllProviders(boolean includeAllProviders)

Will also include all modules that contain providers for used services, should only be used at runtime (not during compile nor test)

Parameters:

includeAllProviders -

Returns:

this request

isIncludeAllProviders

public boolean isIncludeAllProviders()

isIncludeStatic

public boolean isIncludeStatic()

Returns:

true if the result will include all static dependencies

Since:

1.0.5

setIncludeStatic

public ResolvePathsRequest<T> setIncludeStatic(boolean includeStatic)

Parameters:

includeStatic - true if the result must include all static dependencies

Returns:

this request

Since:

1.0.5