com.facebook.buck.support.fix

Class BuckFixSpec

java.lang.Object

com.facebook.buck.support.fix.BuckFixSpec

public abstract class BuckFixSpec
extends Object

Information about the build that is provided to 'fix' scripts as a json file

Constructor Summary

Constructors

Constructor and Description
BuckFixSpec()

Method Summary

Modifier and Type	Method and Description
abstract com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableList<String>>	getBuckProvidedScripts() Get a mapping of names to paths of fix-scripts that are built into buck (such as the original JASABI fix script).
abstract BuildId	getBuildId() The build ID.
abstract String	getCommand() The name of the command that was run.
abstract Optional<Object>	getCommandData() Arbitrary additional data from the specific command.
abstract int	getExitCode() The exit code of the command
abstract com.google.common.collect.ImmutableList<String>	getExpandedArgs() The fully evaluated arguments to this buck invocation.
abstract com.google.common.collect.ImmutableMap<String,Optional<Path>>	getLogs() Get a mapping of log short names to paths for those logs.
abstract boolean	getManuallyInvoked() Whether the fix script was requested explicitly (through `buck fix`), or automatically from another command
abstract com.google.common.collect.ImmutableList<String>	getUserArgs() The arguments that the user sent to buck.

Methods inherited from class java.lang.Object

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

Constructor Detail

BuckFixSpec

public BuckFixSpec()

Method Detail

getBuildId

public abstract BuildId getBuildId()

The build ID. Generally a UUID

getCommand

public abstract String getCommand()

The name of the command that was run. e.g. 'build' or 'query'

getExitCode

public abstract int getExitCode()

The exit code of the command

getUserArgs

public abstract com.google.common.collect.ImmutableList<String> getUserArgs()

The arguments that the user sent to buck. This may include unexpanded arguments such as flagfiles

getExpandedArgs

public abstract com.google.common.collect.ImmutableList<String> getExpandedArgs()

The fully evaluated arguments to this buck invocation.

getManuallyInvoked

public abstract boolean getManuallyInvoked()

Whether the fix script was requested explicitly (through `buck fix`), or automatically from another command

getCommandData

public abstract Optional<Object> getCommandData()

Arbitrary additional data from the specific command. This is used to allow the script to not need to know how to parse the buck machine log or the main buck log

Returns:

Additional data for the specific command

getBuckProvidedScripts

public abstract com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableList<String>> getBuckProvidedScripts()

Get a mapping of names to paths of fix-scripts that are built into buck (such as the original JASABI fix script). These will generally be in the .buckd resources directory

getLogs

public abstract com.google.common.collect.ImmutableMap<String,Optional<Path>> getLogs()

Get a mapping of log short names to paths for those logs.