ProgressBar

java.lang.Object
- com.screenscraper.util.ProgressBar

Direct Known Subclasses:

AutoProgressBar
```
public class ProgressBar
extends java.lang.Object
```
Class for dealing with the progress of a scrape

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.time.ZonedDateTime`	`creationTime`
`protected double`	`currentRecord`
`protected java.time.ZonedDateTime`	`lastUpdate`
`protected double`	`progress`
`protected java.util.List<ProgressBar>`	`progressBars`
`protected ScrapingSession`	`session`
`protected double`	`totalRecords`

Constructor Summary

Constructors
Constructor and Description
`ProgressBar(java.util.List<ProgressBar> progressBarList, ScrapingSession session)` Perform the basic initialization.
`ProgressBar(java.lang.String title, java.util.List<ProgressBar> progressBarList, ScrapingSession session)` Perform the basic initialization

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(double amount)` Adds the amount specified to the current progress number
`java.time.ZonedDateTime`	`getCreationTime()` Returns the time, in milliseconds, this progress bar was created
`double`	`getCurrent()` Gets the current progress number
`int`	`getIndex()` Returns the index of this progress bar in the list of progress bars
`java.lang.String[]`	`getLogDisplay()` Gets Strings to output to the log to show the progress of this progress bar
`double`	`getPercent()` Returns the current percentage completion of this progress bar
`long`	`getRemainingTime()` Estimates the remaining time in nanoseconds until this progress bar reaches completion.
`java.lang.String`	`getTitle()` Returns the current title of the progress bar
`double`	`getTotal()` Gets the total progress number
`java.lang.String`	`getWebDisplay()` Gets the HTML required to display this progress bar
`void`	`setCreationTime(java.time.ZonedDateTime timestamp)` Sets the creation time (so a progress bar can be adjusted in expected duration)
`void`	`setCurrent(double current)` Sets the current number in the progress
`void`	`setCurrent(java.lang.String current)` Sets the current number in the progress
`void`	`setPercent(double percent)` Sets the progress of the scrape as a percentage.
`void`	`setProgress(double current)` Sets the current number in the progress
`void`	`setProgress(double current, double total)` Sets the current progress and total counts
`void`	`setTitle(java.lang.String titleString)` Sets the title of this progress bar
`void`	`setTotal(double total)` Sets the total for this progress bar
`void`	`setTotal(java.lang.String total)` Sets the total for this progress bar
`void`	`updateProgress()` Updates the current progress of this bar and all it's parents (since progress on a parent is affected by it's children).

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

- Field Detail
  - creationTime
```
@NotNull
protected java.time.ZonedDateTime creationTime
```
  - progress
```
protected double progress
```
  - currentRecord
```
protected double currentRecord
```
  - totalRecords
```
protected double totalRecords
```
  - lastUpdate
```
protected java.time.ZonedDateTime lastUpdate
```
  - progressBars
```
@Nullable
protected java.util.List<ProgressBar> progressBars
```
  - session
```
@Nullable
protected final ScrapingSession session
```
- Constructor Detail
  - ProgressBar
```
public ProgressBar(java.util.List<ProgressBar> progressBarList,
                   @Nullable
                   ScrapingSession session)
```
    Perform the basic initialization. Sets the title to "Progress"
    
    Parameters:
    
    progressBarList - The list of progress bars this belongs to
    
    session - The scraping session the progress bar is a part of, or null for none/unknown
  - ProgressBar
```
public ProgressBar(@Nullable
                   java.lang.String title,
                   @Nullable
                   java.util.List<ProgressBar> progressBarList,
                   @Nullable
                   ScrapingSession session)
```
    Perform the basic initialization
    
    Parameters:
    
    title - The Title of the progress bar
    
    progressBarList - The list of progress bars this belongs to
    
    session - The scraping session the progress bar is a part of, or null for none/unknown
- Method Detail
  - setCreationTime
```
public void setCreationTime(@NotNull
                            java.time.ZonedDateTime timestamp)
```
    Sets the creation time (so a progress bar can be adjusted in expected duration)
    
    Parameters:
    
    timestamp - The timestamp to use as the creation time
    
    Since:
    
    7.0.11a
  - setTotal
```
public void setTotal(@NotNull
                     java.lang.String total)
              throws java.lang.NumberFormatException
```
    Sets the total for this progress bar
    
    Parameters:
    
    total - Number at which this bar should indicate 100 percent completion
    
    Throws:
    
    java.lang.NumberFormatException - The string wasn't parseable as a number
  - setTotal
```
public void setTotal(double total)
```
    Sets the total for this progress bar
    
    Parameters:
    
    total - Number at which this bar should indicate 100 percent completion
  - setPercent
```
public void setPercent(double percent)
```
    Sets the progress of the scrape as a percentage. Note that when set this way, progress bars can't update this percentage based on theirs. For instance, if manually setting this to 50 percent, but it's sub-bar is at 0 percent, this will show 50. When the sub-bar reaches 100, this will still show 50.
    
    Parameters:
    
    percent - The percent, as a number from 0 to 100
  - setCurrent
```
public void setCurrent(@NotNull
                       java.lang.String current)
                throws java.lang.NumberFormatException
```
    Sets the current number in the progress
    
    Parameters:
    
    current - The current number
    
    Throws:
    
    java.lang.NumberFormatException - If the string wasn't parseable as an integer
  - setCurrent
```
public void setCurrent(double current)
```
    Sets the current number in the progress
    
    Parameters:
    
    current - The current number
  - setProgress
```
public void setProgress(double current)
```
    Sets the current number in the progress
    
    Parameters:
    
    current - The current number
  - setProgress
```
public void setProgress(double current,
                        double total)
```
    Sets the current progress and total counts
    
    Parameters:
    
    current - The current number
    
    total - The total number
  - add
```
public void add(double amount)
```
    Adds the amount specified to the current progress number
    
    Parameters:
    
    amount - Amount to add to the current progress
  - getPercent
```
public double getPercent()
```
    Returns the current percentage completion of this progress bar
    
    Returns:
    
    Current completion percent
  - setTitle
```
public void setTitle(@Nullable
                     java.lang.String titleString)
```
    Sets the title of this progress bar
    
    Parameters:
    
    titleString - The new title for the progress bar
  - getTitle
```
@Nullable
public java.lang.String getTitle()
```
    Returns the current title of the progress bar
    
    Returns:
    
    Current title of the progress bar
  - getCurrent
```
public double getCurrent()
```
    Gets the current progress number
    
    Returns:
    
    The current count or number of whatever is being monitored
  - getTotal
```
public double getTotal()
```
    Gets the total progress number
    
    Returns:
    
    The total count or number of whatever is being monitored
  - updateProgress
```
public void updateProgress()
```
    Updates the current progress of this bar and all it's parents (since progress on a parent is affected by it's children). Then updates the last update time for each of the progress bars.
  - getIndex
```
public int getIndex()
```
    Returns the index of this progress bar in the list of progress bars
    
    Returns:
    
    This progress bar's index
  - getRemainingTime
```
public long getRemainingTime()
```
    Estimates the remaining time in nanoseconds until this progress bar reaches completion. This is based on the creation time of the progress bar, the current progress as a percent, and the current time.
    
    Returns:
    
    Milliseconds until this progress bar should be finished, assuming progress continues at the same average rate.
  - getCreationTime
```
@NotNull
public java.time.ZonedDateTime getCreationTime()
```
    Returns the time, in milliseconds, this progress bar was created
    
    Returns:
    
    The time, in milliseconds, this progress bar was created
  - getWebDisplay
```
public java.lang.String getWebDisplay()
```
    Gets the HTML required to display this progress bar
    
    Returns:
    
    An HTML string that displays this progress bar's progress and estimated remaining time
  - getLogDisplay
```
public java.lang.String[] getLogDisplay()
```
    Gets Strings to output to the log to show the progress of this progress bar
    
    Returns:
    
    An array of lines to print to the log containing the information about this progress bar

Class ProgressBar

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

creationTime

progress

currentRecord

totalRecords

lastUpdate

progressBars

session

Constructor Detail

ProgressBar

ProgressBar

Method Detail

setCreationTime

setTotal

setTotal

setPercent

setCurrent

setCurrent

setProgress

setProgress

add

getPercent

setTitle

getTitle

getCurrent

getTotal

updateProgress

getIndex

getRemainingTime

getCreationTime

getWebDisplay

getLogDisplay