ProgressEstimator (Buck)

java.lang.Object
- com.facebook.buck.event.listener.util.ProgressEstimator

All Implemented Interfaces:: AutoCloseable

public class ProgressEstimator
extends Object
implements AutoCloseable

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXPECTED_NUMBER_OF_GENERATED_PROJECT_FILES`
`static String`	`EXPECTED_NUMBER_OF_PARSED_BUCK_FILES`
`static String`	`EXPECTED_NUMBER_OF_PARSED_RULES`
`static String`	`PROGRESS_ESTIMATIONS_JSON`

Constructor Summary

Constructors
Constructor and Description

ProgressEstimator(Optional<Path> storageFile, BuckEventBus buckEventBus)

Constructors
Constructor and Description
`ProgressEstimator(Optional<Path> storageFile, BuckEventBus buckEventBus)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`didFinishBuild()`
`Future<?>`	`didFinishParsing()` Indicates that buck has finished parsing, updating the progress estimation accordingly
`Future<?>`	`didFinishProjectGeneration()` Indicates that project generation is finished
`void`	`didFinishRule()`
`Future<?>`	`didGenerateProjectForTarget()` Indicates that a project file has been generated
`Future<?>`	`didParseBuckRules(int amount)` Updates the amount of rules done parsing
`void`	`didStartBuild()`
`Optional<Double>`	`getApproximateBuildProgress()`
`ProgressEstimation`	`getEstimatedProgressOfCreatingActionGraph()`
`Optional<Double>`	`getEstimatedProgressOfGeneratingProjectFiles()`
`ProgressEstimation`	`getEstimatedProgressOfParsingBuckFiles()`
`Future<?>`	`setCurrentCommand(String commandName, com.google.common.collect.ImmutableList<String> commandArgs)` Sets the current command that we are estimating
`void`	`setNumberOfRules(int count)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXPECTED_NUMBER_OF_PARSED_RULES
```
public static final String EXPECTED_NUMBER_OF_PARSED_RULES
```
    See Also:
    
    Constant Field Values
  - EXPECTED_NUMBER_OF_PARSED_BUCK_FILES
```
public static final String EXPECTED_NUMBER_OF_PARSED_BUCK_FILES
```
    See Also:
    
    Constant Field Values
  - EXPECTED_NUMBER_OF_GENERATED_PROJECT_FILES
```
public static final String EXPECTED_NUMBER_OF_GENERATED_PROJECT_FILES
```
    See Also:
    
    Constant Field Values
  - PROGRESS_ESTIMATIONS_JSON
```
public static final String PROGRESS_ESTIMATIONS_JSON
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProgressEstimator
```
public ProgressEstimator(Optional<Path> storageFile,
                         BuckEventBus buckEventBus)
```
- Method Detail
  - setCurrentCommand
```
public Future<?> setCurrentCommand(String commandName,
                                   com.google.common.collect.ImmutableList<String> commandArgs)
```
    Sets the current command that we are estimating
    
    Parameters:
    
    commandName - the name of the command
    
    commandArgs - the arguments to the command
    
    Returns:
    
    a future that completes when estimation calculation is complete
  - didParseBuckRules
```
public Future<?> didParseBuckRules(int amount)
```
    Updates the amount of rules done parsing
    
    Parameters:
    
    amount - the number of rules done parsing
    
    Returns:
    
    a future that completes when estimation calculation is complete
  - didFinishParsing
```
public Future<?> didFinishParsing()
```
    Indicates that buck has finished parsing, updating the progress estimation accordingly
    
    Returns:
    
    a future that completes when estimation calculation is complete
  - didGenerateProjectForTarget
```
public Future<?> didGenerateProjectForTarget()
```
    Indicates that a project file has been generated
    
    Returns:
    
    a future that completes when estimation calculation is complete
  - didFinishProjectGeneration
```
public Future<?> didFinishProjectGeneration()
```
    Indicates that project generation is finished
    
    Returns:
    
    a future that completes when estimation calculation is complete
  - setNumberOfRules
```
public void setNumberOfRules(int count)
```
  - didFinishRule
```
public void didFinishRule()
```
  - didStartBuild
```
public void didStartBuild()
```
  - didFinishBuild
```
public void didFinishBuild()
```
  - getEstimatedProgressOfParsingBuckFiles
```
public ProgressEstimation getEstimatedProgressOfParsingBuckFiles()
```
    Returns:
    
    Estimated progress of parsing files stage.
  - getEstimatedProgressOfCreatingActionGraph
```
public ProgressEstimation getEstimatedProgressOfCreatingActionGraph()
```
    Returns:
    
    Estimated progress of parsing files in action graph stage.
  - getEstimatedProgressOfGeneratingProjectFiles
```
public Optional<Double> getEstimatedProgressOfGeneratingProjectFiles()
```
    Returns:
    
    Estimated progress of generating projects stage. If return value is absent, it's impossible to compute the estimated progress.
  - getApproximateBuildProgress
```
public Optional<Double> getApproximateBuildProgress()
```
    Returns:
    
    Approximated progress of current build. Returns absent value if number of rules wasn't determined.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class ProgressEstimator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXPECTED_NUMBER_OF_PARSED_RULES

EXPECTED_NUMBER_OF_PARSED_BUCK_FILES

EXPECTED_NUMBER_OF_GENERATED_PROJECT_FILES

PROGRESS_ESTIMATIONS_JSON

Constructor Detail

ProgressEstimator

Method Detail

setCurrentCommand

didParseBuckRules

didFinishParsing

didGenerateProjectForTarget

didFinishProjectGeneration

setNumberOfRules

didFinishRule

didStartBuild

didFinishBuild

getEstimatedProgressOfParsingBuckFiles

getEstimatedProgressOfCreatingActionGraph

getEstimatedProgressOfGeneratingProjectFiles

getApproximateBuildProgress

close