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

Class StringAttribute

java.lang.Object

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

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

All Implemented Interfaces:

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

public abstract class StringAttribute
extends Attribute<String>

Class that represents a String attribute to a user defined rule

Constructor Summary

Constructors

Constructor and Description
StringAttribute()

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
abstract String	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 StringAttribute	of(String preCoercionDefaultValue, String doc, boolean mandatory, List<String> values)
void	repr(com.google.devtools.build.lib.skylarkinterface.SkylarkPrinter printer)
protected void	validateCoercedValue(String value) Validates values post-coercion to ensure other properties besides 'type' are valid

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

getAttribute, getGenericType, getPostCoercionTransform, getValue, 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

StringAttribute

public StringAttribute()

Method Detail

getPreCoercionDefaultValue

public abstract String 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>

validateCoercedValue

protected void validateCoercedValue(String value)
                             throws CoerceFailedException

Description copied from class: Attribute

Validates values post-coercion to ensure other properties besides 'type' are valid

Overrides:

validateCoercedValue in class Attribute<String>

Parameters:

value - The value to check

Throws:

CoerceFailedException - if the value is invalid (e.g. not in a list of pre-approved values)

of

public static StringAttribute of(String preCoercionDefaultValue,
                                 String doc,
                                 boolean mandatory,
                                 List<String> values)