com.facebook.buck.core.rules.actions

Interface ActionRegistry

All Known Implementing Classes:

DefaultActionRegistry

public interface ActionRegistry

The registry for Actions, which creates its corresponding ActionWrapperData.

This helps to hide and enforce the relationship between ActionAnalysisDataKey, ActionAnalysisData, Action, and BuildArtifact.

There is one registry per BuildTarget, such that all Actions registered by this are considered to be associated with the build target.

Method Summary

Modifier and Type	Method and Description
default Artifact	declareArtifact(Path output)
Artifact	declareArtifact(Path output, com.google.devtools.build.lib.events.Location location)
Artifact	declareArtifact(String output, com.google.devtools.build.lib.events.Location location) Simple helper behaves like declareArtifact(Path, Location), but validates that the string is a valid path
BuildTarget	getOwner()
String	registerActionAnalysisDataForAction(Action action) Creates the ActionWrapperData from its Action and registers the ActionWrapperData to the ActionAnalysisDataRegistry.
void	verifyAllArtifactsBound() Verifies that all the Artifacts declared via declareArtifact(Path) has been bound with an Action via registerActionAnalysisDataForAction(Action)

Method Detail

declareArtifact

default Artifact declareArtifact(Path output)
                          throws ArtifactDeclarationException

Parameters:

output - the output Path relative to the package path for the current rule that the Actions are being created for

Returns:

a Artifact for the given path

Throws:

ArtifactDeclarationException - if the provided output path is invalid

declareArtifact

Artifact declareArtifact(String output,
                         com.google.devtools.build.lib.events.Location location)
                  throws ArtifactDeclarationException

Simple helper behaves like declareArtifact(Path, Location), but validates that the string is a valid path

Parameters:

output - the output path relative to the package path for hte current rule that the Actions are being created for

location - if provided, the location within the extension file where this artifact was declared

Returns:

a Artifact for hte given path

Throws:

ArtifactDeclarationException - if the provided output path is invalid

declareArtifact

Artifact declareArtifact(Path output,
                         com.google.devtools.build.lib.events.Location location)
                  throws ArtifactDeclarationException

Parameters:

output - the output Path relative to the package path for the current rule that the Actions are being created for

location - if provided, the location within the extension file where this artifact was declared

Returns:

a Artifact for the given path

Throws:

ArtifactDeclarationException - if the provided output path is invalid

registerActionAnalysisDataForAction

String registerActionAnalysisDataForAction(Action action)
                                    throws ActionCreationException

Creates the ActionWrapperData from its Action and registers the ActionWrapperData to the ActionAnalysisDataRegistry.

This will materialize the declared Artifacts and bind them to the action. These Artifacts that can be passed via Providers to be consumed.

Parameters:

action - the Action to create an ActionWrapperData for and registers it

Returns:

the assigned unique ID for this Action

Throws:

ActionCreationException

getOwner

BuildTarget getOwner()

Returns:

the BuildTarget responsible for all the Actions registered to this factory.

verifyAllArtifactsBound

void verifyAllArtifactsBound()

Verifies that all the Artifacts declared via declareArtifact(Path) has been bound with an Action via registerActionAnalysisDataForAction(Action)