PackStatistics (JGit - Core 5.1.9.201908210455-r API)

java.lang.Object
- org.eclipse.jgit.storage.pack.PackStatistics

```
public class PackStatistics
extends Object
```
Statistics about PackWriter pack creation.

Since:

4.1

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PackStatistics.Accumulator` POJO for accumulating the statistics.
`static class`	`PackStatistics.ObjectType` Statistics about a single type of object (commits, tags, trees and blobs).

Constructor Summary

Constructors
Constructor and Description

PackStatistics(PackStatistics.Accumulator accumulator)
Creates a new PackStatistics object from the accumulator.

Constructors
Constructor and Description
`PackStatistics(PackStatistics.Accumulator accumulator)` Creates a new `PackStatistics` object from the accumulator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PackStatistics.ObjectType`	`byObjectType(int typeCode)` Get information about this type of object in the pack.
`long`	`getAdvertised()` Get the count of references in the ref advertisement.
`long`	`getBitmapIndexMisses()` Get the count of objects that needed to be discovered through an object walk because they were not found in bitmap indices.
`Set<ObjectId>`	`getClientShallowCommits()` Get unmodifiable collection of objects that were shallow commits on the client.
`int`	`getDeltaSearchNonEdgeObjects()` Get number of objects in the output pack that went through the delta search process in order to find a potential delta base.
`int`	`getDeltasFound()` Get number of objects in the output pack that went through delta base search and found a suitable base.
`int`	`getDepth()` Get depth (in commits) the pack includes if shallow.
`long`	`getHaves()` Get the count of client haves.
`Set<ObjectId>`	`getInterestingObjects()` Get unmodifiable collection of objects to be included in the pack.
`String`	`getMessage()` Get formatted message string for display to clients.
`Map<Integer,PackStatistics.ObjectType>`	`getObjectTypes()` Get a map containing ObjectType statistics.
`long`	`getReusedDeltas()` Get number of deltas whose existing representation was reused in the output.
`long`	`getReusedObjects()` Get number of objects whose existing representation was reused in the output.
`List<CachedPack>`	`getReusedPacks()` Get unmodifiable list of the cached packs that were reused in the output
`Set<ObjectId>`	`getRootCommits()` Get unmodifiable collection of the root commits of the history.
`long`	`getThinPackBytes()` Get size of the thin pack in bytes.
`long`	`getTimeCompressing()` Get time in milliseconds spent on delta compression.
`long`	`getTimeCounting()` Get time in milliseconds spent enumerating the objects that need to be included in the output.
`long`	`getTimeNegotiating()` Time in ms spent in the negotiation phase.
`long`	`getTimeSearchingForReuse()` Get time in milliseconds spent matching existing representations against objects that will be transmitted.
`long`	`getTimeSearchingForSizes()` Get time in milliseconds spent finding the sizes of all objects that will enter the delta compression search window.
`long`	`getTimeTotal()` Get total time spent processing this pack.
`long`	`getTimeWriting()` Get time in milliseconds spent writing the pack output, from start of header until end of trailer.
`long`	`getTotalBytes()` Get total number of bytes written.
`long`	`getTotalDeltas()` Get total number of deltas output.
`long`	`getTotalObjects()` Get total number of objects output.
`double`	`getTransferRate()` Get the average output speed in terms of bytes-per-second.
`Set<ObjectId>`	`getUninterestingObjects()` Get unmodifiable collection of objects that should be excluded from the pack
`long`	`getWants()` Get the count of client wants.
`boolean`	`isShallow()` Whether the resulting pack file was a shallow pack.

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

- Constructor Detail
  - PackStatistics
```
public PackStatistics(PackStatistics.Accumulator accumulator)
```
    Creates a new PackStatistics object from the accumulator.
    
    Parameters:
    
    accumulator - the accumulator of the statistics
- Method Detail
  - getAdvertised
```
public long getAdvertised()
```
    Get the count of references in the ref advertisement.
    
    Returns:
    
    count of refs in the ref advertisement.
    
    Since:
    
    4.11
  - getWants
```
public long getWants()
```
    Get the count of client wants.
    
    Returns:
    
    count of client wants.
    
    Since:
    
    4.11
  - getHaves
```
public long getHaves()
```
    Get the count of client haves.
    
    Returns:
    
    count of client haves.
    
    Since:
    
    4.11
  - getTimeNegotiating
```
public long getTimeNegotiating()
```
    Time in ms spent in the negotiation phase. For non-bidirectional transports (e.g., HTTP), this is only for the final request that sends back the pack file.
    
    Returns:
    
    time for ref advertisement in ms.
    
    Since:
    
    4.11
  - getInterestingObjects
```
public Set<ObjectId> getInterestingObjects()
```
    Get unmodifiable collection of objects to be included in the pack.
    
    Returns:
    
    unmodifiable collection of objects to be included in the pack. May be null if the pack was hand-crafted in a unit test.
  - getUninterestingObjects
```
public Set<ObjectId> getUninterestingObjects()
```
    Get unmodifiable collection of objects that should be excluded from the pack
    
    Returns:
    
    unmodifiable collection of objects that should be excluded from the pack, as the peer that will receive the pack already has these objects.
  - getClientShallowCommits
```
public Set<ObjectId> getClientShallowCommits()
```
    Get unmodifiable collection of objects that were shallow commits on the client.
    
    Returns:
    
    unmodifiable collection of objects that were shallow commits on the client.
  - getReusedPacks
```
public List<CachedPack> getReusedPacks()
```
    Get unmodifiable list of the cached packs that were reused in the output
    
    Returns:
    
    unmodifiable list of the cached packs that were reused in the output, if any were selected for reuse.
  - getRootCommits
```
public Set<ObjectId> getRootCommits()
```
    Get unmodifiable collection of the root commits of the history.
    
    Returns:
    
    unmodifiable collection of the root commits of the history.
  - getDeltaSearchNonEdgeObjects
```
public int getDeltaSearchNonEdgeObjects()
```
    Get number of objects in the output pack that went through the delta search process in order to find a potential delta base.
    
    Returns:
    
    number of objects in the output pack that went through the delta search process in order to find a potential delta base.
  - getDeltasFound
```
public int getDeltasFound()
```
    Get number of objects in the output pack that went through delta base search and found a suitable base.
    
    Returns:
    
    number of objects in the output pack that went through delta base search and found a suitable base. This is a subset of getDeltaSearchNonEdgeObjects().
  - getTotalObjects
```
public long getTotalObjects()
```
    Get total number of objects output.
    
    Returns:
    
    total number of objects output. This total includes the value of getTotalDeltas().
  - getBitmapIndexMisses
```
public long getBitmapIndexMisses()
```
    Get the count of objects that needed to be discovered through an object walk because they were not found in bitmap indices.
    
    Returns:
    
    the count of objects that needed to be discovered through an object walk because they were not found in bitmap indices. Returns -1 if no bitmap indices were found.
  - getTotalDeltas
```
public long getTotalDeltas()
```
    Get total number of deltas output.
    
    Returns:
    
    total number of deltas output. This may be lower than the actual number of deltas if a cached pack was reused.
  - getReusedObjects
```
public long getReusedObjects()
```
    Get number of objects whose existing representation was reused in the output.
    
    Returns:
    
    number of objects whose existing representation was reused in the output. This count includes getReusedDeltas().
  - getReusedDeltas
```
public long getReusedDeltas()
```
    Get number of deltas whose existing representation was reused in the output.
    
    Returns:
    
    number of deltas whose existing representation was reused in the output, as their base object was also output or was assumed present for a thin pack. This may be lower than the actual number of reused deltas if a cached pack was reused.
  - getTotalBytes
```
public long getTotalBytes()
```
    Get total number of bytes written.
    
    Returns:
    
    total number of bytes written. This size includes the pack header, trailer, thin pack, and reused cached pack(s).
  - getThinPackBytes
```
public long getThinPackBytes()
```
    Get size of the thin pack in bytes.
    
    Returns:
    
    size of the thin pack in bytes, if a thin pack was generated. A thin pack is created when the client already has objects and some deltas are created against those objects, or if a cached pack is being used and some deltas will reference objects in the cached pack. This size does not include the pack header or trailer.
  - byObjectType
```
public PackStatistics.ObjectType byObjectType(int typeCode)
```
    Get information about this type of object in the pack.
    
    Parameters:
    
    typeCode - object type code, e.g. OBJ_COMMIT or OBJ_TREE.
    
    Returns:
    
    information about this type of object in the pack.
  - isShallow
```
public boolean isShallow()
```
    Whether the resulting pack file was a shallow pack.
    
    Returns:
    
    true if the resulting pack file was a shallow pack.
  - getDepth
```
public int getDepth()
```
    Get depth (in commits) the pack includes if shallow.
    
    Returns:
    
    depth (in commits) the pack includes if shallow.
  - getTimeCounting
```
public long getTimeCounting()
```
    Get time in milliseconds spent enumerating the objects that need to be included in the output.
    
    Returns:
    
    time in milliseconds spent enumerating the objects that need to be included in the output. This time includes any restarts that occur when a cached pack is selected for reuse.
  - getTimeSearchingForReuse
```
public long getTimeSearchingForReuse()
```
    Get time in milliseconds spent matching existing representations against objects that will be transmitted.
    
    Returns:
    
    time in milliseconds spent matching existing representations against objects that will be transmitted, or that the client can be assumed to already have.
  - getTimeSearchingForSizes
```
public long getTimeSearchingForSizes()
```
    Get time in milliseconds spent finding the sizes of all objects that will enter the delta compression search window.
    
    Returns:
    
    time in milliseconds spent finding the sizes of all objects that will enter the delta compression search window. The sizes need to be known to better match similar objects together and improve delta compression ratios.
  - getTimeCompressing
```
public long getTimeCompressing()
```
    Get time in milliseconds spent on delta compression.
    
    Returns:
    
    time in milliseconds spent on delta compression. This is observed wall-clock time and does not accurately track CPU time used when multiple threads were used to perform the delta compression.
  - getTimeWriting
```
public long getTimeWriting()
```
    Get time in milliseconds spent writing the pack output, from start of header until end of trailer.
    
    Returns:
    
    time in milliseconds spent writing the pack output, from start of header until end of trailer. The transfer speed can be approximated by dividing getTotalBytes() by this value.
  - getTimeTotal
```
public long getTimeTotal()
```
    Get total time spent processing this pack.
    
    Returns:
    
    total time spent processing this pack.
  - getTransferRate
```
public double getTransferRate()
```
    Get the average output speed in terms of bytes-per-second.
    
    Returns:
    
    the average output speed in terms of bytes-per-second. getTotalBytes() / (getTimeWriting() / 1000.0).
  - getMessage
```
public String getMessage()
```
    Get formatted message string for display to clients.
    
    Returns:
    
    formatted message string for display to clients.
  - getObjectTypes
```
public Map<Integer,PackStatistics.ObjectType> getObjectTypes()
```
    Get a map containing ObjectType statistics.
    
    Returns:
    
    a map containing ObjectType statistics.

Class PackStatistics

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PackStatistics

Method Detail

getAdvertised

getWants

getHaves

getTimeNegotiating

getInterestingObjects

getUninterestingObjects

getClientShallowCommits

getReusedPacks

getRootCommits

getDeltaSearchNonEdgeObjects

getDeltasFound

getTotalObjects

getBitmapIndexMisses

getTotalDeltas

getReusedObjects

getReusedDeltas

getTotalBytes

getThinPackBytes

byObjectType

isShallow

getDepth

getTimeCounting

getTimeSearchingForReuse

getTimeSearchingForSizes

getTimeCompressing

getTimeWriting

getTimeTotal

getTransferRate

getMessage

getObjectTypes