com.facebook.buck.core.starlark.rule.names

Class UserDefinedRuleNames

java.lang.Object

com.facebook.buck.core.starlark.rule.names.UserDefinedRuleNames

public class UserDefinedRuleNames
extends Object

Helper methods to create, validate, and parse the identifier used by the parser for the buck.type attribute on targets of user defined rules.

Method Summary

Modifier and Type	Method and Description
static Pair<com.google.devtools.build.lib.cmdline.Label,String>	fromIdentifier(String identifier) Parses the extension label and the rule name from an identifier
static String	getIdentifier(com.google.devtools.build.lib.cmdline.Label extensionLabel, String exportedName) Creates an identifier that can be used in buck.type in the parser
static com.google.devtools.build.lib.syntax.SkylarkImport	importFromIdentifier(String identifier) Convert a 'buck.type' string into a SkylarkImport object
static boolean	isUserDefinedRuleIdentifier(String identifier) Determines whether the given identifier is for a user defined rule

Methods inherited from class java.lang.Object

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

Method Detail

getIdentifier

public static String getIdentifier(com.google.devtools.build.lib.cmdline.Label extensionLabel,
                                   String exportedName)

Creates an identifier that can be used in buck.type in the parser

Parameters:

extensionLabel - the label of the extension file that this rule was defined in

exportedName - the name of the rule in the extension file

Returns:

An identifier of the form cell//package:extension.bzl:extension_name

isUserDefinedRuleIdentifier

public static boolean isUserDefinedRuleIdentifier(String identifier)

Determines whether the given identifier is for a user defined rule

Parameters:

identifier - the identifier from buck.type

Returns:

Whether this looks like an identifier for a user defined rule

fromIdentifier

@Nullable
public static Pair<com.google.devtools.build.lib.cmdline.Label,String> fromIdentifier(String identifier)

Parses the extension label and the rule name from an identifier

Parameters:

identifier - the identifier from buck.type

Returns:

a pair of the label of the extension file that contains this rule, and the rule's name. If the identifier could not be parsed, null is returned.

importFromIdentifier

@Nullable
public static com.google.devtools.build.lib.syntax.SkylarkImport importFromIdentifier(String identifier)

Convert a 'buck.type' string into a SkylarkImport object

Parameters:

identifier - the result from buck.type

Returns:

A SkylarkImport object if identifier is parsable as a UDR identifier, else null