com.facebook.buck.core.rulekey

Annotation Type ExcludeFromRuleKey

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface ExcludeFromRuleKey

Marks a field/method of a class explicitly excluded from rulekeys. Usage of this should be very rare. In general, we consider uses of it to indicate likely correctness problems. Instead annotate the field with @AddToRuleKey.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends CustomFieldInputsTag>	inputs Indicates how inputs should be derived from this field.
Class<? extends CustomFieldSerializationTag>	serialization Indicates how serialization of this field should be handled.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends CustomFieldDepsTag>	deps Indicates how deps should be derived from this field.
String	reason This indicates the reason we exclude a value from rulekeys.
boolean	shouldReport We really do think that using this annotation indicates a likely source of problems.

Element Detail

serialization

public abstract Class<? extends CustomFieldSerializationTag> serialization

Indicates how serialization of this field should be handled. For default serialization, use DefaultFieldSerialization If serialization cannot possibly be supported, use ThrowingSerialization.

inputs

public abstract Class<? extends CustomFieldInputsTag> inputs

Indicates how inputs should be derived from this field. For default inputs derivation, use DefaultFieldInputs. If this field should not contribute to inputs, use IgnoredFieldInputs.

reason

public abstract String reason

This indicates the reason we exclude a value from rulekeys. It's currently only used for logging.

Default:

""

deps

public abstract Class<? extends CustomFieldDepsTag> deps

Indicates how deps should be derived from this field. For default deps derivation, use DefaultFieldDeps. If this field should not contribute to deps, use IgnoredFieldDeps. If you would like to provide custom logic, see CustomFieldDeps.

Default:

com.facebook.buck.core.rulekey.IgnoredFieldDeps.class

shouldReport

public abstract boolean shouldReport

We really do think that using this annotation indicates a likely source of problems. By default, the first time we encounter such an annotated field/method, we will log that information to the buck log.

Default:

true