com.facebook.buck.core.starlark.rule.attr.impl

Class OutputAttribute

java.lang.Object

com.facebook.buck.core.starlark.rule.attr.Attribute<String>

com.facebook.buck.core.starlark.rule.attr.impl.OutputAttribute

All Implemented Interfaces:

AttributeHolder, com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable, com.google.devtools.build.lib.skylarkinterface.SkylarkValue

public abstract class OutputAttribute
extends Attribute<String>

Represents a single output file.

The string value is turned into a relative path which is then converted to a declared artifact automatically before executing the user's implementation function

Constructor Summary

Constructors

Constructor and Description
OutputAttribute()

Method Summary

Modifier and Type	Method and Description
abstract String	getDoc() The docstring to use for this attribute
abstract boolean	getMandatory() Whether this attribute is mandatory or not
PostCoercionTransform<RuleAnalysisContext,?>	getPostCoercionTransform()
abstract Object	getPreCoercionDefaultValue() The default value to use if no value is provided.
TypeCoercer<?,String>	getTypeCoercer() The type coercer to use to convert raw values from the parser into something usable internally.
static OutputAttribute	of(Object preCoercionDefaultValue, String doc, boolean mandatory)
void	repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)

Methods inherited from class com.facebook.buck.core.starlark.rule.attr.Attribute

getAttribute, getGenericType, getValue, validateCoercedValue, validateProvidersPresent, validateValueInList

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkValue

isHashable, isImmutable

Methods inherited from interface com.google.devtools.build.lib.skylarkinterface.SkylarkPrintable

debugPrint, str

Constructor Detail

OutputAttribute

public OutputAttribute()

Method Detail

getPreCoercionDefaultValue

public abstract Object getPreCoercionDefaultValue()

Description copied from class: Attribute

The default value to use if no value is provided.

This will be validated against Attribute.getTypeCoercer(), so may return a value whose type does not match CoercedType (e.g. a list of strings, rather than a list of SourcePath)

Specified by:

getPreCoercionDefaultValue in class Attribute<String>

getDoc

public abstract String getDoc()

Description copied from class: Attribute

The docstring to use for this attribute

Specified by:

getDoc in class Attribute<String>

getMandatory

public abstract boolean getMandatory()

Description copied from class: Attribute

Whether this attribute is mandatory or not

Specified by:

getMandatory in class Attribute<String>

repr

public void repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)

getTypeCoercer

public TypeCoercer<?,String> getTypeCoercer()

Description copied from class: Attribute

The type coercer to use to convert raw values from the parser into something usable internally. This coercer also performs validation

Specified by:

getTypeCoercer in class Attribute<String>

getPostCoercionTransform

public PostCoercionTransform<RuleAnalysisContext,?> getPostCoercionTransform()

Overrides:

getPostCoercionTransform in class Attribute<String>

Returns:

a method that transforms a coerced value into something more useful to users, taking into account the rule's dependencies

of

public static OutputAttribute of(Object preCoercionDefaultValue,
                                 String doc,
                                 boolean mandatory)