com.facebook.buck.jvm.java

Class UnusedDependenciesFinder

java.lang.Object

com.facebook.buck.jvm.java.UnusedDependenciesFinder

All Implemented Interfaces:

Step

public abstract class UnusedDependenciesFinder
extends Object
implements Step

The step that reports dependencies not used during Java compilation.

It uses class usage map produced during compilation and compares it to the outputs of the dependencies specified in Java libraries. The entries from classpath not used during compilation are resolved to the corresponding targets and reported back to the user either as an error (which halt the build) or as a warning.

Constructor Summary

Constructors

Constructor and Description
UnusedDependenciesFinder()

Method Summary

Modifier and Type	Method and Description
StepExecutionResult	execute(ExecutionContext context)
abstract Optional<String>	getBuildozerPath()
abstract BuildTarget	getBuildTarget()
abstract Path	getDepFileRelativePath()
abstract com.google.common.collect.ImmutableList<com.facebook.buck.jvm.java.UnusedDependenciesFinder.DependencyAndExportedDeps>	getDeps()
String	getDescription(ExecutionContext context)
abstract ProjectFilesystem	getProjectFilesystem()
abstract com.google.common.collect.ImmutableList<com.facebook.buck.jvm.java.UnusedDependenciesFinder.DependencyAndExportedDeps>	getProvidedDeps()
String	getShortName()
abstract SourcePathResolverAdapter	getSourcePathResolver()
abstract JavaBuckConfig.UnusedDependenciesAction	getUnusedDependenciesAction()
abstract boolean	isOnlyPrintCommands()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnusedDependenciesFinder

public UnusedDependenciesFinder()

Method Detail

getBuildTarget

public abstract BuildTarget getBuildTarget()

getProjectFilesystem

public abstract ProjectFilesystem getProjectFilesystem()

getDepFileRelativePath

public abstract Path getDepFileRelativePath()

getDeps

public abstract com.google.common.collect.ImmutableList<com.facebook.buck.jvm.java.UnusedDependenciesFinder.DependencyAndExportedDeps> getDeps()

getProvidedDeps

public abstract com.google.common.collect.ImmutableList<com.facebook.buck.jvm.java.UnusedDependenciesFinder.DependencyAndExportedDeps> getProvidedDeps()

getSourcePathResolver

public abstract SourcePathResolverAdapter getSourcePathResolver()

getUnusedDependenciesAction

public abstract JavaBuckConfig.UnusedDependenciesAction getUnusedDependenciesAction()

getBuildozerPath

public abstract Optional<String> getBuildozerPath()

isOnlyPrintCommands

public abstract boolean isOnlyPrintCommands()

execute

public StepExecutionResult execute(ExecutionContext context)
                            throws IOException

Specified by:

execute in interface Step

Throws:

IOException

getShortName

public String getShortName()

Specified by:

getShortName in interface Step

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getDescription

public String getDescription(ExecutionContext context)

Specified by:

getDescription in interface Step