Skip to content

Commit eaca5e3

Browse files
committed
fix some comments
1. use symlink instead of symbolic 2. remove a redundent chinese comment.
1 parent 522d595 commit eaca5e3

File tree

7 files changed

+27
-28
lines changed

7 files changed

+27
-28
lines changed

src/main/java/com/aliyun/oss/OSS.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1761,9 +1761,9 @@ public String generateRtmpUri(GenerateRtmpUriRequest generatePushflowUrlRequest)
17611761
throws OSSException, ClientException;
17621762

17631763
/**
1764-
* Creates a symbolic link to a target file under the bucket---this is not supported for archive class bucket.
1764+
* Creates a symlink link to a target file under the bucket---this is not supported for archive class bucket.
17651765
* @param bucketName Bucket name.
1766-
* @param symlink symbolic name.
1766+
* @param symlink symlink name.
17671767
* @param target target file key.
17681768
* @throws OSSException OSS Server side exception.
17691769
* @throws ClientException OSS Client side exception.
@@ -1772,28 +1772,28 @@ public void createSymlink(String bucketName, String symlink, String target)
17721772
throws OSSException, ClientException;
17731773
/**
17741774
* Creates a symbol link to a target file under the bucket---this is not supported for archive class bucket.
1775-
* @param createSymlinkRequest A {@link CreateSymlinkRequest} instance that specifies the bucket name, symbolic name.
1775+
* @param createSymlinkRequest A {@link CreateSymlinkRequest} instance that specifies the bucket name, symlink name.
17761776
* @throws OSSException OSS Server side exception.
17771777
* @throws ClientException OSS Client side exception.
17781778
*/
17791779
public void createSymlink(CreateSymlinkRequest createSymlinkRequest)
17801780
throws OSSException, ClientException;
17811781

17821782
/**
1783-
* Gets the symbolic information for the given symbolic name.
1783+
* Gets the symlink information for the given symlink name.
17841784
* @param bucketName Bucket name.
1785-
* @param symlink The symbolic name.
1786-
* @return The symbolic information, including the target file name and its metadata.
1785+
* @param symlink The symlink name.
1786+
* @return The symlink information, including the target file name and its metadata.
17871787
* @throws OSSException OSS Server side exception.
17881788
* @throws ClientException OSS Client side exception.
17891789
*/
17901790
public OSSSymlink getSymlink(String bucketName, String symlink)
17911791
throws OSSException, ClientException;
17921792

17931793
/**
1794-
* Gets the symbolic information for the given symbolic name.
1795-
* @param genericRequest A {@link GenericRequest} instance which specifies the bucket name and symbolic name.
1796-
* @return The symbolic information, including the target file name and its metadata.
1794+
* Gets the symlink information for the given symlink name.
1795+
* @param genericRequest A {@link GenericRequest} instance which specifies the bucket name and symlink name.
1796+
* @return The symlink information, including the target file name and its metadata.
17971797
* @throws OSSException OSS Server side exception.
17981798
* @throws ClientException OSS Client side exception.
17991799
*/

src/main/java/com/aliyun/oss/OSSErrorCode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ public interface OSSErrorCode {
240240
static final String NO_SUCH_LIVE_CHANNEL = "NoSuchLiveChannel";
241241

242242
/**
243-
* Symbolic target file does not exist.
243+
* symlink target file does not exist.
244244
*/
245245
static final String NO_SUCH_SYM_LINK_TARGET = "SymlinkTargetNotExist";
246246

src/main/java/com/aliyun/oss/internal/ResponseParsers.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1306,7 +1306,7 @@ public static SimplifiedObjectMeta parseSimplifiedObjectMeta(Map<String, String>
13061306
}
13071307

13081308
/**
1309-
* Unmarshall symbolic link from response headers.
1309+
* Unmarshall symlink link from response headers.
13101310
*/
13111311
public static OSSSymlink parseSymbolicLink(ResponseMessage response)
13121312
throws ResponseParseException {

src/main/java/com/aliyun/oss/model/CreateSymlinkRequest.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
package com.aliyun.oss.model;
2121

2222
/**
23-
* The request class that is used to create symbolic on an object.
23+
* The request class that is used to create symlink on an object.
2424
*
2525
*/
2626
public class CreateSymlinkRequest extends GenericRequest {
@@ -40,32 +40,32 @@ public void setSymlink(String symlink) {
4040
}
4141

4242
/**
43-
* Sets the target file of the symbolic.
43+
* Sets the target file of the symlink.
4444
* @return Target file.
4545
*/
4646
public String getTarget() {
4747
return this.target;
4848
}
4949

5050
/**
51-
* Gets the target file of the symbolic.
51+
* Gets the target file of the symlink.
5252
* @param target Target file.
5353
*/
5454
public void setTarget(String target) {
5555
this.target = target;
5656
}
5757

5858
/**
59-
* Gets the symbolic file's metadata.
60-
* @return Symbolic file's metadata.
59+
* Gets the symlink file's metadata.
60+
* @return symlink file's metadata.
6161
*/
6262
public ObjectMetadata getMetadata() {
6363
return metadata;
6464
}
6565

6666
/**
67-
* Sets the symbolic file's metadata.
68-
* @param metadata Symbolic file's metadata.
67+
* Sets the symlink file's metadata.
68+
* @param metadata symlink file's metadata.
6969
*/
7070
public void setMetadata(ObjectMetadata metadata) {
7171
this.metadata = metadata;
@@ -74,6 +74,6 @@ public void setMetadata(ObjectMetadata metadata) {
7474
// Target file.
7575
private String target;
7676

77-
// Symbolic file's metadata.
77+
// symlink file's metadata.
7878
private ObjectMetadata metadata;
7979
}

src/main/java/com/aliyun/oss/model/GeneratePresignedUrlRequest.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,6 @@ public ResponseHeaderOverrides getResponseHeaders() {
216216

217217
/**
218218
* <p>
219-
* 获取用户自定义的元数据。
220219
* Gets user's customized metadata.
221220
* </p>
222221
* <p>

src/main/java/com/aliyun/oss/model/OSSSymlink.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
package com.aliyun.oss.model;
2121

2222
/**
23-
* The entity class representing a OSS symbolic file.
23+
* The entity class representing a OSS symlink file.
2424
*
2525
*/
2626
public class OSSSymlink {
@@ -47,16 +47,16 @@ public void setTarget(String target) {
4747
}
4848

4949
/**
50-
* Gets the metadata of the symbolic file
51-
* @return The metadata of the symbolic file.
50+
* Gets the metadata of the symlink file
51+
* @return The metadata of the symlink file.
5252
*/
5353
public ObjectMetadata getMetadata() {
5454
return metadata;
5555
}
5656

5757
/**
58-
* Sets the metadata of the symbolic file.
59-
* @param metadata The metadata of the symbolic file.
58+
* Sets the metadata of the symlink file.
59+
* @param metadata The metadata of the symlink file.
6060
*/
6161
public void setMetadata(ObjectMetadata metadata) {
6262
this.metadata = metadata;
@@ -68,13 +68,13 @@ public String toString() {
6868
+ ", target=" + getTarget() + "]";
6969
}
7070

71-
// Symbolic file key
71+
// symlink file key
7272
private String symlink;
7373

7474
// The original file's key
7575
private String target;
7676

77-
// The symbolic file's metadata.
77+
// The symlink file's metadata.
7878
private ObjectMetadata metadata;
7979

8080
}

src/test/java/com/aliyun/oss/integrationtests/SymlinkTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
import com.aliyun.oss.model.ObjectMetadata;
3737

3838
/**
39-
* Test Symbolic Link
39+
* Test symlink Link
4040
*/
4141
public class SymlinkTest extends TestBase {
4242

0 commit comments

Comments
 (0)