com.facebook.buck.rules.keys.hasher

Class ThriftRuleKeyHasher

java.lang.Object

com.facebook.buck.rules.keys.hasher.ThriftRuleKeyHasher

All Implemented Interfaces:

RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

public class ThriftRuleKeyHasher
extends Object
implements RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

A rule key hasher that attempts to create thrift structures representing rule keys as hashing occurs, and writes out the serialized data once the rule key is "complete"

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.rules.keys.hasher.RuleKeyHasher

RuleKeyHasher.Container, RuleKeyHasher.Wrapper

Constructor Summary

Constructors

Constructor and Description
ThriftRuleKeyHasher(ThriftRuleKeyLogger ruleKeyLogger) Creates a ThriftRuleKeyHasher

Method Summary

Modifier and Type	Method and Description
void	flushToLogger() Writes the object out to the logger
com.facebook.buck.log.thrift.rulekeys.FullRuleKey	hash() Finishes populating the ruleKey with remaining key/value pairs and returns it
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putArchiveMemberPath(Path relativeArchivePath, Path archiveMemberPath, com.google.common.hash.HashCode hash)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putBoolean(boolean val)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putBuildTarget(BuildTarget buildTarget)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putBuildTargetSourcePath(BuildTargetSourcePath buildTargetSourcePath)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putBytes(byte[] bytes)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putCharacter(char val)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putContainer(RuleKeyHasher.Container container, int length) Adds a container to the stack.
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putKey(String key) Puts the field's key (i.e.
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putKeyPath(Path key) Puts the stringified path as a key.
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putNonHashingPath(Path path)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putNull() Puts the field's value, Java types
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putNumber(Number val)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putPath(Path path, com.google.common.hash.HashCode hash)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putPattern(Pattern pattern)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putRuleKey(RuleKey ruleKey)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putRuleType(RuleType ruleType)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putSha1(Sha1HashCode sha1) Puts the field's value, Buck specific types
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putString(String val)
RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>	putWrapper(RuleKeyHasher.Wrapper wrapper)
void	setHashKey(com.google.common.hash.HashCode code) Sets the hash key on the ruleKey object

Methods inherited from class java.lang.Object

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

Constructor Detail

ThriftRuleKeyHasher

public ThriftRuleKeyHasher(ThriftRuleKeyLogger ruleKeyLogger)

Creates a ThriftRuleKeyHasher

Parameters:

ruleKeyLogger - The ruleKeyLogger used to write serialized thrift structures out

Method Detail

putKey

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putKey(String key)

Description copied from interface: RuleKeyHasher

Puts the field's key (i.e. the name of the field)

Specified by:

putKey in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putKeyPath

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putKeyPath(Path key)

Description copied from interface: RuleKeyHasher

Puts the stringified path as a key.

Specified by:

putKeyPath in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putNull

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putNull()

Description copied from interface: RuleKeyHasher

Puts the field's value, Java types

Specified by:

putNull in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putCharacter

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putCharacter(char val)

Specified by:

putCharacter in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putBoolean

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putBoolean(boolean val)

Specified by:

putBoolean in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putNumber

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putNumber(Number val)

Specified by:

putNumber in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putString

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putString(String val)

Specified by:

putString in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putBytes

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putBytes(byte[] bytes)

Specified by:

putBytes in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putPattern

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putPattern(Pattern pattern)

Specified by:

putPattern in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putSha1

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putSha1(Sha1HashCode sha1)

Description copied from interface: RuleKeyHasher

Puts the field's value, Buck specific types

Specified by:

putSha1 in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putPath

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putPath(Path path,
                                                                                com.google.common.hash.HashCode hash)

Specified by:

putPath in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putArchiveMemberPath

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putArchiveMemberPath(Path relativeArchivePath,
                                                                                             Path archiveMemberPath,
                                                                                             com.google.common.hash.HashCode hash)

Specified by:

putArchiveMemberPath in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

Parameters:

relativeArchivePath - relative path to archive.

archiveMemberPath - path to archive member.

putNonHashingPath

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putNonHashingPath(Path path)

Specified by:

putNonHashingPath in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putRuleKey

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putRuleKey(RuleKey ruleKey)

Specified by:

putRuleKey in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putRuleType

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putRuleType(RuleType ruleType)

Specified by:

putRuleType in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putBuildTarget

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putBuildTarget(BuildTarget buildTarget)

Specified by:

putBuildTarget in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putBuildTargetSourcePath

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putBuildTargetSourcePath(BuildTargetSourcePath buildTargetSourcePath)

Specified by:

putBuildTargetSourcePath in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

putContainer

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putContainer(RuleKeyHasher.Container container,
                                                                                     int length)

Adds a container to the stack. This will pop down the stack of already hashed values in order to populate the container. The container Value is then put back on the stack

Specified by:

putContainer in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

Parameters:

container - The container type

length - The number of elements in the container. This can vary slightly by container type

Returns:

The original RuleKeyHasher object

putWrapper

public RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey> putWrapper(RuleKeyHasher.Wrapper wrapper)

Specified by:

putWrapper in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

hash

public com.facebook.buck.log.thrift.rulekeys.FullRuleKey hash()

Finishes populating the ruleKey with remaining key/value pairs and returns it

Specified by:

hash in interface RuleKeyHasher<com.facebook.buck.log.thrift.rulekeys.FullRuleKey>

Returns:

The fully populated ruleKey

setHashKey

public void setHashKey(com.google.common.hash.HashCode code)

Sets the hash key on the ruleKey object

Parameters:

code - The hash code to use

flushToLogger

public void flushToLogger()

Writes the object out to the logger