3819 add comments to explain what is meanth by depth in 7zipextractor

This commit is contained in:
William Schaefer 2018-06-08 13:39:20 -04:00
parent 1667784659
commit 486e5b9ad7

View File

@ -1210,6 +1210,7 @@ class SevenZipExtractor {
*/ */
static class Archive { static class Archive {
//depth will be 0 for the root archive unpack was called on, and increase as unpack recurses down through archives contained within
private final int depth; private final int depth;
private final long objectId; private final long objectId;
private final List<Archive> children; private final List<Archive> children;
@ -1218,7 +1219,10 @@ class SevenZipExtractor {
* Create a new Archive object. * Create a new Archive object.
* *
* @param objectId the unique object id of the archive object * @param objectId the unique object id of the archive object
* @param depth the depth in the archive structure * @param depth the depth in the archive structure - 0 will be the
* root archive unpack was called on, and it will
* increase as unpack recurses down through archives
* contained within
*/ */
Archive(long objectId, int depth) { Archive(long objectId, int depth) {
this.objectId = objectId; this.objectId = objectId;
@ -1248,8 +1252,9 @@ class SevenZipExtractor {
/** /**
* Get archive depth of this archive * Get archive depth of this archive
* *
* @return depth - an integer representing how many layers of archives * @return depth - an integer representing that represents how many
* this archive is inside. * times the upack method has been recursed from the root
* archive unpack was called on
*/ */
int getDepth() { int getDepth() {
return depth; return depth;