Tune Javadoc for RedundancyScheme

kaloyan-raev · kaloyan-raev · commit 67b7afa41c2b · 2019-10-23T21:33:46.000+03:00
diff --git a/libuplink-android/src/main/java/io/storj/RedundancyScheme.java b/libuplink-android/src/main/java/io/storj/RedundancyScheme.java
@@ -34,7 +34,7 @@ public RedundancyAlgorithm getAlgorithm() {
     }
 
     /**
-     * Returns the required number of erasure share for reconstructing the original data.
+     * Returns the required number of erasure share to recover the original data.
      *
      * @return the required number of erasure shares
      */
@@ -43,27 +43,26 @@ public short getRequiredShares() {
     }
 
     /**
-     * Returns the number of pieces that form the repair threshold. If the number of available
-     * pieces on the network fall below this threshold, the repair of the data will trigger.
+     * Returns the minimum number of safe erasure shares that can remain before a repair is
+     * triggered.
      *
-     * @return the repair threshold in number of pieces
+     * @return the minimum number of safe erasure shares
      */
-    public short getRepairShares() {
+    public short getRepairThreshold() {
         return repair;
     }
 
     /**
-     * Returns the number of pieces that must be uploaded to the network to consider the upload
-     * successful.
+     * Returns the desired total number of erasure shares for a segment.
      *
-     * @return the success threshold in number of pieces
+     * @return the desired number of erasure shares
      */
     public short getSuccessShares() {
         return success;
     }
 
     /**
-     * Returns the total number of erasure shares generated by the erasure encoding algorithm.
+     * Returns the total number of erasure shares generated by the erasure encoding.
      *
      * @return the total number of erasure shares
      */
@@ -74,15 +73,15 @@ public short getTotalShares() {
     /**
      * Returns the size of the erasure shares.
      *
-     * @return the erasure share size
+     * @return the erasure share size in bytes
      */
     public int getShareSize() {
         return shareSize;
     }
 
     /**
-     * Two {@link RedundancyScheme} objects are equal if their erasure encoding algorithm, required
-     * shares, repair threshold, success threshold, total shares, and erasure share size are equal.
+     * Two {@link RedundancyScheme} objects are equal if their erasure encoding algorithm, number of
+     * required, repair, success, and total erasure shares, and erasure share size are all equal.
      *
      * @return <code>true</code> if this object is the same as the specified object;
      *          <code>false</code> otherwise.
@@ -102,7 +101,7 @@ public boolean equals(Object o) {
 
     /**
      * The hash code value of {@link RedundancyScheme} is the hash code value of its erasure
-     * encoding algorithm, required shares, repair threshold, success threshold, total shares, and
+     * encoding algorithm, number of required, repair, success, and total erasure shares, and
      * erasure share size.
      *
      * @return a hash code value for this object
@@ -169,9 +168,10 @@ public Builder setRequiredShares(short count) {
         }
 
         /**
-         * Determines the repair threshold in number of pieces.
+         * Determines the minimum number of safe erasure shares that can remain before a repair is
+         * triggered.
          *
-         * @param count the number of pieces
+         * @param count the minimum number of safe erasure shares
          * @return a reference to this object
          */
         public Builder setRepairShares(short count) {
@@ -180,9 +180,9 @@ public Builder setRepairShares(short count) {
         }
 
         /**
-         * Determines the success threshold in number of pieces.
+         * Determines the desired total number of erasure shares for a segment.
          *
-         * @param count the number of pieces
+         * @param count the desired total number of erasure shares
          * @return a reference to this object
          */
         public Builder setSuccessShares(short count) {
@@ -191,8 +191,7 @@ public Builder setSuccessShares(short count) {
         }
 
         /**
-         * Determines the total number of erasure shares to generate by the erasure encoding
-         * algorithm.
+         * Determines the total number of erasure shares to generate by the erasure encoding.
          *
          * @param count the total number of erasure shares
          * @return a reference to this object

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public RedundancyAlgorithm getAlgorithm() {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * Returns the required number of erasure share for reconstructing the original data.`
	`37`	`+ * Returns the required number of erasure share to recover the original data.`
`38`	`38`	`*`
`39`	`39`	`* @return the required number of erasure shares`
`40`	`40`	`*/`
`@@ -43,27 +43,26 @@ public short getRequiredShares() {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`/**`
`46`		`- * Returns the number of pieces that form the repair threshold. If the number of available`
`47`		`- * pieces on the network fall below this threshold, the repair of the data will trigger.`
	`46`	`+ * Returns the minimum number of safe erasure shares that can remain before a repair is`
	`47`	`+ * triggered.`
`48`	`48`	`*`
`49`		`- * @return the repair threshold in number of pieces`
	`49`	`+ * @return the minimum number of safe erasure shares`
`50`	`50`	`*/`
`51`		`- public short getRepairShares() {`
	`51`	`+ public short getRepairThreshold() {`
`52`	`52`	`return repair;`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`/**`
`56`		`- * Returns the number of pieces that must be uploaded to the network to consider the upload`
`57`		`- * successful.`
	`56`	`+ * Returns the desired total number of erasure shares for a segment.`
`58`	`57`	`*`
`59`		`- * @return the success threshold in number of pieces`
	`58`	`+ * @return the desired number of erasure shares`
`60`	`59`	`*/`
`61`	`60`	`public short getSuccessShares() {`
`62`	`61`	`return success;`
`63`	`62`	`}`
`64`	`63`
`65`	`64`	`/**`
`66`		`- * Returns the total number of erasure shares generated by the erasure encoding algorithm.`
	`65`	`+ * Returns the total number of erasure shares generated by the erasure encoding.`
`67`	`66`	`*`
`68`	`67`	`* @return the total number of erasure shares`
`69`	`68`	`*/`
`@@ -74,15 +73,15 @@ public short getTotalShares() {`
`74`	`73`	`/**`
`75`	`74`	`* Returns the size of the erasure shares.`
`76`	`75`	`*`
`77`		`- * @return the erasure share size`
	`76`	`+ * @return the erasure share size in bytes`
`78`	`77`	`*/`
`79`	`78`	`public int getShareSize() {`
`80`	`79`	`return shareSize;`
`81`	`80`	`}`
`82`	`81`
`83`	`82`	`/**`
`84`		`- * Two {@link RedundancyScheme} objects are equal if their erasure encoding algorithm, required`
`85`		`- * shares, repair threshold, success threshold, total shares, and erasure share size are equal.`
	`83`	`+ * Two {@link RedundancyScheme} objects are equal if their erasure encoding algorithm, number of`
	`84`	`+ * required, repair, success, and total erasure shares, and erasure share size are all equal.`
`86`	`85`	`*`
`87`	`86`	`* @return <code>true</code> if this object is the same as the specified object;`
`88`	`87`	`* <code>false</code> otherwise.`
`@@ -102,7 +101,7 @@ public boolean equals(Object o) {`
`102`	`101`
`103`	`102`	`/**`
`104`	`103`	`* The hash code value of {@link RedundancyScheme} is the hash code value of its erasure`
`105`		`- * encoding algorithm, required shares, repair threshold, success threshold, total shares, and`
	`104`	`+ * encoding algorithm, number of required, repair, success, and total erasure shares, and`
`106`	`105`	`* erasure share size.`
`107`	`106`	`*`
`108`	`107`	`* @return a hash code value for this object`
`@@ -169,9 +168,10 @@ public Builder setRequiredShares(short count) {`
`169`	`168`	`}`
`170`	`169`
`171`	`170`	`/**`
`172`		`- * Determines the repair threshold in number of pieces.`
	`171`	`+ * Determines the minimum number of safe erasure shares that can remain before a repair is`
	`172`	`+ * triggered.`
`173`	`173`	`*`
`174`		`- * @param count the number of pieces`
	`174`	`+ * @param count the minimum number of safe erasure shares`
`175`	`175`	`* @return a reference to this object`
`176`	`176`	`*/`
`177`	`177`	`public Builder setRepairShares(short count) {`
`@@ -180,9 +180,9 @@ public Builder setRepairShares(short count) {`
`180`	`180`	`}`
`181`	`181`
`182`	`182`	`/**`
`183`		`- * Determines the success threshold in number of pieces.`
	`183`	`+ * Determines the desired total number of erasure shares for a segment.`
`184`	`184`	`*`
`185`		`- * @param count the number of pieces`
	`185`	`+ * @param count the desired total number of erasure shares`
`186`	`186`	`* @return a reference to this object`
`187`	`187`	`*/`
`188`	`188`	`public Builder setSuccessShares(short count) {`
`@@ -191,8 +191,7 @@ public Builder setSuccessShares(short count) {`
`191`	`191`	`}`
`192`	`192`
`193`	`193`	`/**`
`194`		`- * Determines the total number of erasure shares to generate by the erasure encoding`
`195`		`- * algorithm.`
	`194`	`+ * Determines the total number of erasure shares to generate by the erasure encoding.`
`196`	`195`	`*`
`197`	`196`	`* @param count the total number of erasure shares`
`198`	`197`	`* @return a reference to this object`