com.facebook.buck.support.fix

Class BuckFixSpecWriter

java.lang.Object

com.facebook.buck.support.fix.BuckFixSpecWriter

public class BuckFixSpecWriter
extends Object

Simple class that writes a serialized to json BuckFixSpec to the log directory

Method Summary

Modifier and Type	Method and Description
static void	writeSpec(Path fixSpecPath, BuckFixSpec spec) Writes the json representation of the fix spec to be consumed by the fix script, it's usually information found in logs too but in a much easier format for the script to consume, plus command data that might be captured only in runtime.
static Path	writeSpecToLogDir(Path rootPath, InvocationInfo info, BuckFixSpec spec) Writes the json representation of the fix spec to the logs directory, derived from the rootPath and the InvocationInfo

Methods inherited from class java.lang.Object

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

Method Detail

writeSpecToLogDir

public static Path writeSpecToLogDir(Path rootPath,
                                     InvocationInfo info,
                                     BuckFixSpec spec)
                              throws IOException

Writes the json representation of the fix spec to the logs directory, derived from the rootPath and the InvocationInfo

Parameters:

rootPath - The root of the project that contains buck-out

info - The invocation info. Used to find the log directories to write into

spec - the spec to write to disk

Returns:

the path to which the spec was written to

Throws:

IOException - The file could not be written to

writeSpec

public static void writeSpec(Path fixSpecPath,
                             BuckFixSpec spec)
                      throws IOException

Writes the json representation of the fix spec to be consumed by the fix script, it's usually information found in logs too but in a much easier format for the script to consume, plus command data that might be captured only in runtime.

Parameters:

fixSpecPath - a path to the file where the spec is to be written

spec - the spec to write to disk

Throws:

IOException