Skip to content

Commit 9e66652

Browse files
XenoAmessXenoAmess
committed
fix docs
1 parent 3835bee commit 9e66652

File tree

16 files changed

+59
-59
lines changed

16 files changed

+59
-59
lines changed

‎.github/workflows/gradle.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
run: |
3636
echo "DEV_VERSION=$(./gradlew properties | awk '/^version:/ { print $2 }')" >> $GITHUB_ENV
3737
echo "RELEASE_VERSION=$(./gradlew properties -Prelease | awk '/^version:/ { print $2 }')" >> $GITHUB_ENV
38-
- name: Gradle build on Ununtu
38+
- name: Gradle build on Ubuntu
3939
if: matrix.os == 'ubuntu-latest'
4040
run: |
4141
./gradlew build

‎api/src/main/java/io/minio/ComposeSource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import io.minio.errors.InternalException;
2323
import java.util.Objects;
2424

25-
/** A source object defintion for {@link ComposeObjectArgs}. */
25+
/** A source object definition for {@link ComposeObjectArgs}. */
2626
public class ComposeSource extends ObjectConditionalReadArgs {
2727
private Long objectSize = null;
2828
private Multimap<String, String> headers = null;

‎api/src/main/java/io/minio/CopySource.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package io.minio;
1818

19-
/** A source object defintion for {@link CopyObjectArgs}. */
19+
/** A source object definition for {@link CopyObjectArgs}. */
2020
public class CopySource extends ObjectConditionalReadArgs {
2121
protected CopySource() {}
2222

‎api/src/main/java/io/minio/S3Base.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ protected Headers httpHeaders(Multimap<String, String> headerMap) {
477477
return builder.build();
478478
}
479479

480-
/** Create HTTP request for given paramaters. */
480+
/** Create HTTP request for given parameters. */
481481
protected Request createRequest(
482482
HttpUrl url, Method method, Headers headers, Object body, int length, Credentials creds)
483483
throws InsufficientDataException, InternalException, IOException, NoSuchAlgorithmException {

‎api/src/main/java/io/minio/credentials/Provider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
public interface Provider {
2626
/**
2727
* Returns a valid {@link Credentials} instance by retrieving from credential provider service if
28-
* neccessary.
28+
* necessary.
2929
*/
3030
Credentials fetch();
3131
}

‎api/src/main/java/io/minio/errors/ErrorResponseException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public ErrorResponseException(ErrorResponse errorResponse, Response response, St
4040
this.response = response;
4141
}
4242

43-
/** Returns ErrorResponse contains detail of what error occured. */
43+
/** Returns ErrorResponse contains detail of what error occurred. */
4444
public ErrorResponse errorResponse() {
4545
return this.errorResponse;
4646
}

‎api/src/main/java/io/minio/errors/InternalException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
package io.minio.errors;
1818

1919
/**
20-
* Thrown to indicate that unexpected internal library error occured while processing given request.
20+
* Thrown to indicate that unexpected internal library error occurred while processing given request.
2121
*/
2222
public class InternalException extends MinioException {
2323
private static final long serialVersionUID = 138336287983212416L;

‎api/src/main/java/io/minio/messages/CompleteMultipartUpload.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public class CompleteMultipartUpload {
3737
@ElementList(name = "Part", inline = true)
3838
private List<Part> partList;
3939

40-
/** Constucts a new CompleteMultipartUpload object with given parts. */
40+
/** Constructs a new CompleteMultipartUpload object with given parts. */
4141
public CompleteMultipartUpload(@Nonnull Part[] parts) throws IllegalArgumentException {
4242
if (Objects.requireNonNull(parts, "parts must not be null").length == 0) {
4343
throw new IllegalArgumentException("parts cannot be empty");

‎api/src/main/java/io/minio/messages/Initiator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import org.simpleframework.xml.Root;
2121

2222
/**
23-
* Helper class to denote Initator information of a multipart upload and used in {@link
23+
* Helper class to denote Initiator information of a multipart upload and used in {@link
2424
* ListMultipartUploadsResult} and {@link ListPartsResult}.
2525
*/
2626
@Root(name = "Initiator", strict = false)

‎api/src/main/java/io/minio/messages/ListPartsResult.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public String storageClass() {
8686
return storageClass;
8787
}
8888

89-
/** Returns initator information. */
89+
/** Returns initiator information. */
9090
public Initiator initiator() {
9191
return initiator;
9292
}

‎api/src/main/java/io/minio/messages/Upload.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public String uploadId() {
6868
return uploadId;
6969
}
7070

71-
/** Returns initator information. */
71+
/** Returns initiator information. */
7272
public Initiator initiator() {
7373
return initiator;
7474
}
@@ -83,7 +83,7 @@ public String storageClass() {
8383
return storageClass;
8484
}
8585

86-
/** Returns initated time. */
86+
/** Returns initiated time. */
8787
public ZonedDateTime initiated() {
8888
return initiated.zonedDateTime();
8989
}

‎docs/API.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ MinioClient s3Client =
196196
MinioClient s3Client =
197197
MinioClient.builder()
198198
.endpoint("s3.amazonaws.com", 443, true)
199-
.credentials("YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY").
199+
.credentials("YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY")
200200
.region("eu-west-2")
201201
.build();
202202

@@ -1259,7 +1259,7 @@ Enables legal hold on an object.
12591259

12601260
| Parameter | Type | Description |
12611261
|:---------------|:------------------------------|:-------------|
1262-
| ``args`` | _[EnableObjectLegalHoldArgs]_ | Argumments. |
1262+
| ``args`` | _[EnableObjectLegalHoldArgs]_ | Arguments. |
12631263

12641264
__Example__
12651265
```java
@@ -1378,7 +1378,7 @@ __Parameters__
13781378

13791379
| Returns |
13801380
|:-------------------------------------------|
1381-
| _[GetObjectAttributesResponse]_ - Respone. |
1381+
| _[GetObjectAttributesResponse]_ - Response. |
13821382

13831383
__Example__
13841384
```java

‎docs/zh_CN/API.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -721,20 +721,20 @@ __参数__
721721
| ``objectName`` | _String_ | 存储桶里的对象名称。 |
722722
| ``key`` | _SecretKey_ | [SecretKey](https://docs.oracle.com/javase/7/docs/api/javax/crypto/SecretKey.html)类型的数据。|
723723

724-
| 返回值类型 | 异常 |
725-
|:--- |:--- |
726-
| None | 异常列表： |
727-
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
728-
| | ``NoResponseException`` : 服务器无响应。 |
729-
| | ``IOException`` : 连接异常。 |
730-
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
731-
| | ``ErrorResponseException`` : 执行失败异常。 |
732-
| | ``InternalException`` : 内部错误。 |
733-
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
734-
| | ``BadPaddingException`` : 错误的padding |
735-
| | ``IllegalBlockSizeException`` : 不正确的block size |
736-
| | ``NoSuchPaddingException`` : 错误的pading类型 |
737-
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |
724+
| 返回值类型 | 异常 |
725+
|:--- |:--------------------------------------------------------|
726+
| None | 异常列表： |
727+
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
728+
| | ``NoResponseException`` : 服务器无响应。 |
729+
| | ``IOException`` : 连接异常。 |
730+
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
731+
| | ``ErrorResponseException`` : 执行失败异常。 |
732+
| | ``InternalException`` : 内部错误。 |
733+
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
734+
| | ``BadPaddingException`` : 错误的padding |
735+
| | ``IllegalBlockSizeException`` : 不正确的block size |
736+
| | ``NoSuchPaddingException`` : 错误的padding类型 |
737+
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |
738738

739739
__示例__
740740

@@ -787,20 +787,20 @@ __参数__
787787
| ``objectName`` | _String_ | 存储桶里的对象名称。 |
788788
| ``key`` | _KeyPair_ | RSA [KeyPair](https://docs.oracle.com/javase/7/docs/api/java/security/KeyPair.html)类型的对象。 |
789789

790-
| 返回值类型 | 异常 |
791-
|:--- |:--- |
792-
| None | 异常列表： |
793-
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
794-
| | ``NoResponseException`` : 服务器无响应。 |
795-
| | ``IOException`` : 连接异常。 |
796-
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
797-
| | ``ErrorResponseException`` : 执行失败异常。 |
798-
| | ``InternalException`` : 内部错误。 |
799-
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
800-
| | ``BadPaddingException`` : 错误的padding |
801-
| | ``IllegalBlockSizeException`` : 不正确的block size |
802-
| | ``NoSuchPaddingException`` : 错误的pading类型 |
803-
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |
790+
| 返回值类型 | 异常 |
791+
|:--- |:--------------------------------------------------------|
792+
| None | 异常列表： |
793+
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
794+
| | ``NoResponseException`` : 服务器无响应。 |
795+
| | ``IOException`` : 连接异常。 |
796+
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
797+
| | ``ErrorResponseException`` : 执行失败异常。 |
798+
| | ``InternalException`` : 内部错误。 |
799+
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
800+
| | ``BadPaddingException`` : 错误的padding |
801+
| | ``IllegalBlockSizeException`` : 不正确的block size |
802+
| | ``NoSuchPaddingException`` : 错误的padding类型 |
803+
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |
804804

805805
__示例__
806806

@@ -1045,19 +1045,19 @@ __参数__
10451045
| ``contentType`` | _String_ | Content type。 |
10461046
| ``key`` | _KeyPair_ | 一个RSA [KeyPair](https://docs.oracle.com/javase/7/docs/api/java/security/KeyPair.html)的对象。 |
10471047

1048-
| 返回值类型 | 异常 |
1049-
|:--- |:--- |
1050-
| None | 异常列表： |
1051-
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
1052-
| | ``NoResponseException`` : 服务器无响应。 |
1053-
| | ``IOException`` : 连接异常。 |
1054-
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
1055-
| | ``ErrorResponseException`` : 执行失败异常。 |
1056-
| | ``InternalException`` : 内部错误。 |
1057-
| | ``InvalidAlgorithmParameterException`` : 错误的加密算法。 |
1058-
| | ``BadPaddingException`` : 不正确的padding。 |
1059-
| | ``IllegalBlockSizeException`` : 不正确的block。 |
1060-
| | ``NoSuchPaddingException`` : 错误的pading类型。 |
1048+
| 返回值类型 | 异常 |
1049+
|:--- |:--------------------------------------------------------|
1050+
| None | 异常列表： |
1051+
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
1052+
| | ``NoResponseException`` : 服务器无响应。 |
1053+
| | ``IOException`` : 连接异常。 |
1054+
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
1055+
| | ``ErrorResponseException`` : 执行失败异常。 |
1056+
| | ``InternalException`` : 内部错误。 |
1057+
| | ``InvalidAlgorithmParameterException`` : 错误的加密算法。 |
1058+
| | ``BadPaddingException`` : 不正确的padding。 |
1059+
| | ``IllegalBlockSizeException`` : 不正确的block。 |
1060+
| | ``NoSuchPaddingException`` : 错误的padding类型。 |
10611061

10621062
__示例__
10631063

‎examples/GetObjectRetention.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public static void main(String[] args)
5050
.build());
5151

5252
System.out.println("Mode: " + retention.mode());
53-
System.out.println("Retainuntil Date: " + retention.retainUntilDate());
53+
System.out.println("Retain until Date: " + retention.retainUntilDate());
5454
} catch (MinioException e) {
5555
System.out.println("Error occurred: " + e);
5656
}

‎examples/ListBuckets.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public static void main(String[] args)
4242
// .credentials("YOUR-ACCESSKEY", "YOUR-SECRETACCESSKEY")
4343
// .build();
4444

45-
// List buckets we have atleast read access.
45+
// List buckets we have at least read access.
4646
Iterable<Result<Bucket>> results = minioClient.listBuckets(ListBucketsArgs.builder().build());
4747
for (Result<Bucket> result : results) {
4848
Bucket bucket = result.get();

‎examples/MakeBucket.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public static void main(String[] args)
4141
// .credentials("YOUR-ACCESSKEY", "YOUR-SECRETACCESSKEY")
4242
// .build();
4343

44-
// Create bucket 'my-bucketname' if it doesn`t exist.
44+
// Create bucket 'my-bucketname' if it doesn't exist.
4545
if (!minioClient.bucketExists(BucketExistsArgs.builder().bucket("my-bucketname").build())) {
4646
minioClient.makeBucket(MakeBucketArgs.builder().bucket("my-bucketname").build());
4747
System.out.println("my-bucketname is created successfully");

0 commit comments

Comments
 (0)