com.facebook.buck.log.thrift

Class ThriftRuleKeyLogger

java.lang.Object

com.facebook.buck.log.thrift.ThriftRuleKeyLogger

All Implemented Interfaces:

AutoCloseable

public class ThriftRuleKeyLogger
extends Object
implements AutoCloseable

Writes out length prefixed ThriftCompact serialized representations of Rule Keys to an output stream.

Constructor Summary

Constructors

Constructor and Description
ThriftRuleKeyLogger(OutputStream writer) Creates a ThriftRuleKeyLogger

Method Summary

Modifier and Type	Method and Description
void	close() Close the output stream
static ThriftRuleKeyLogger	create(Path filename) Create an instance of a logger that writes to the given file name
void	write(com.facebook.buck.log.thrift.rulekeys.FullRuleKey ruleKey) Writes a serialized form of the rule key to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThriftRuleKeyLogger

public ThriftRuleKeyLogger(OutputStream writer)

Creates a ThriftRuleKeyLogger

Parameters:

writer - The stream to write serialized data to

Method Detail

close

public void close()

Close the output stream

Specified by:

close in interface AutoCloseable

write

public void write(com.facebook.buck.log.thrift.rulekeys.FullRuleKey ruleKey)

Writes a serialized form of the rule key to the output stream. Serialization is Thrift Compact, with a 4 byte length prefix. Serialization or write errors are swallowed, and logged so that failures to write do not terminate buck

Parameters:

ruleKey - The non-null ruleKey to write out to the ifle

create

public static ThriftRuleKeyLogger create(Path filename)
                                  throws IOException

Create an instance of a logger that writes to the given file name

An attempt is made to create all subdirectories before opening the file

Parameters:

filename - The file to write thrift data to

Returns:

A binary logger

Throws:

FileNotFoundException - Thrown if the subdirectory containing the filename could not be created

IOException