com.facebook.buck.skylark.function.attr

Interface AttrModuleApi

All Superinterfaces:

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

All Known Implementing Classes:

AttrModule

public interface AttrModuleApi
extends com.google.devtools.build.lib.skylarkinterface.SkylarkValue

Skylark module used to configure the attribute schema for user defined rules

Method Summary

Modifier and Type	Method and Description
AttributeHolder	boolAttribute(boolean defaultValue, String doc, boolean mandatory)
AttributeHolder	depAttribute(Object defaultValue, String doc, boolean mandatory, com.google.devtools.build.lib.syntax.SkylarkList<Provider<?>> providers)
AttributeHolder	depListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue, String doc, boolean mandatory, boolean allowEmpty, com.google.devtools.build.lib.syntax.SkylarkList<Provider<?>> providers)
AttributeHolder	intAttribute(Integer defaultValue, String doc, Boolean mandatory, com.google.devtools.build.lib.syntax.SkylarkList<Integer> values)
AttributeHolder	intListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<Integer> defaultValue, String doc, boolean mandatory, boolean allowEmpty)
AttributeHolder	outputAttribute(Object defaultValue, String doc, boolean mandatory, com.google.devtools.build.lib.events.Location location)
AttributeHolder	outputListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue, String doc, boolean mandatory, boolean allowEmpty)
AttributeHolder	sourceAttribute(Object defaultValue, String doc, boolean mandatory)
AttributeHolder	sourceListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue, String doc, boolean mandatory, boolean allowEmpty)
AttributeHolder	stringAttribute(String defaultValue, String doc, Boolean mandatory, com.google.devtools.build.lib.syntax.SkylarkList<String> values)
AttributeHolder	stringListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue, String doc, boolean mandatory, boolean allowEmpty)

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, repr, str

Method Detail

intAttribute

AttributeHolder intAttribute(Integer defaultValue,
                             String doc,
                             Boolean mandatory,
                             com.google.devtools.build.lib.syntax.SkylarkList<Integer> values)
                      throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

intListAttribute

AttributeHolder intListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<Integer> defaultValue,
                                 String doc,
                                 boolean mandatory,
                                 boolean allowEmpty)
                          throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

stringAttribute

AttributeHolder stringAttribute(String defaultValue,
                                String doc,
                                Boolean mandatory,
                                com.google.devtools.build.lib.syntax.SkylarkList<String> values)
                         throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

stringListAttribute

AttributeHolder stringListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue,
                                    String doc,
                                    boolean mandatory,
                                    boolean allowEmpty)
                             throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

boolAttribute

AttributeHolder boolAttribute(boolean defaultValue,
                              String doc,
                              boolean mandatory)
                       throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

sourceListAttribute

AttributeHolder sourceListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue,
                                    String doc,
                                    boolean mandatory,
                                    boolean allowEmpty)
                             throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

sourceAttribute

AttributeHolder sourceAttribute(Object defaultValue,
                                String doc,
                                boolean mandatory)
                         throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

depAttribute

AttributeHolder depAttribute(Object defaultValue,
                             String doc,
                             boolean mandatory,
                             com.google.devtools.build.lib.syntax.SkylarkList<Provider<?>> providers)
                      throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

depListAttribute

AttributeHolder depListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue,
                                 String doc,
                                 boolean mandatory,
                                 boolean allowEmpty,
                                 com.google.devtools.build.lib.syntax.SkylarkList<Provider<?>> providers)
                          throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

outputAttribute

AttributeHolder outputAttribute(Object defaultValue,
                                String doc,
                                boolean mandatory,
                                com.google.devtools.build.lib.events.Location location)
                         throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException

outputListAttribute

AttributeHolder outputListAttribute(com.google.devtools.build.lib.syntax.SkylarkList<String> defaultValue,
                                    String doc,
                                    boolean mandatory,
                                    boolean allowEmpty)
                             throws com.google.devtools.build.lib.syntax.EvalException

Throws:

com.google.devtools.build.lib.syntax.EvalException