Skip to content

Commit 9b82db0

Browse files
committed
fix java doc strings
Signed-off-by: Varun Bansal <bansvaru@amazon.com>
1 parent 88eab7d commit 9b82db0

3 files changed

Lines changed: 0 additions & 12 deletions

File tree

server/src/main/java/org/opensearch/common/metadata/MetadataManager.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ public MetadataManager(MetadataParser<T> parser, int currentVersion, String code
4444
* After reading the actual content, verifies the checksum as well
4545
* @param indexInput metadata file input stream
4646
* @return metadata content parsed into {@link T}
47-
* @throws IOException
4847
*/
4948
public T readMetadata(IndexInput indexInput) throws IOException {
5049
ChecksumIndexInput checksumIndexInput = new BufferedChecksumIndexInput(indexInput);
@@ -58,7 +57,6 @@ public T readMetadata(IndexInput indexInput) throws IOException {
5857
* Writes metadata to file output stream {@code indexOutput}
5958
* @param indexOutput file output stream which will store metadata content
6059
* @param metadata metadata content.
61-
* @throws IOException
6260
*
6361
* {@code metadata} argument type would be changed to {@link T} in future to reuse {@link MetadataManager} for multiple metadata types
6462
*/
@@ -72,7 +70,6 @@ public void writeMetadata(IndexOutput indexOutput, Map<String, String> metadata)
7270
* Reads header from metadata file input stream containing {@code this.codec} and {@code this.currentVersion}.
7371
* @param indexInput metadata file input stream
7472
* @return header version found in the metadata file
75-
* @throws IOException
7673
*/
7774
private int checkHeader(IndexInput indexInput) throws IOException {
7875
return CodecUtil.checkHeader(indexInput, this.codec, this.currentVersion, this.currentVersion);
@@ -82,7 +79,6 @@ private int checkHeader(IndexInput indexInput) throws IOException {
8279
* Reads footer from metadata file input stream containing checksum.
8380
* The {@link IndexInput#getFilePointer()} should be at the footer start position.
8481
* @param indexInput metadata file input stream
85-
* @throws IOException
8682
*/
8783
private void checkFooter(ChecksumIndexInput indexInput) throws IOException {
8884
CodecUtil.checkFooter(indexInput);
@@ -91,7 +87,6 @@ private void checkFooter(ChecksumIndexInput indexInput) throws IOException {
9187
/**
9288
* Writes header with {@code this.codec} and {@code this.currentVersion} to the metadata file output stream
9389
* @param indexOutput metadata file output stream
94-
* @throws IOException
9590
*/
9691
private void writeHeader(IndexOutput indexOutput) throws IOException {
9792
CodecUtil.writeHeader(indexOutput, this.codec, this.currentVersion);
@@ -100,7 +95,6 @@ private void writeHeader(IndexOutput indexOutput) throws IOException {
10095
/**
10196
* Writes footer with checksum of contents of metadata file output stream
10297
* @param indexOutput metadata file output stream
103-
* @throws IOException
10498
*/
10599
private void writeFooter(IndexOutput indexOutput) throws IOException {
106100
CodecUtil.writeFooter(indexOutput);

server/src/main/java/org/opensearch/common/metadata/MetadataParser.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,12 @@ public interface MetadataParser<T> {
2323
* Implements logic to read metadata content from metadata file input stream {@code indexInput} and parse into {@link T}
2424
* @param indexInput metadata file input stream
2525
* @return metadata content parsed to {@link T}
26-
* @throws IOException
2726
*/
2827
T readContent(IndexInput indexInput) throws IOException;
2928

3029
/**
3130
* Implements logic to write metadata content from {@code content} to metadata file output stream {@code indexOutput}
3231
* @param indexOutput metadata file input stream
33-
* @throws IOException
3432
*/
3533
void writeContent(IndexOutput indexOutput, T content) throws IOException;
3634

@@ -40,7 +38,6 @@ public interface MetadataParser<T> {
4038
* This will removed in future releases and only {@link #writeContent(IndexOutput, Object)} )} should be used going fwd.
4139
* @param indexOutput metadata file input stream
4240
* @param content metadata content
43-
* @throws IOException
4441
*/
4542
@Deprecated
4643
void writeContent(IndexOutput indexOutput, Map<String, String> content) throws IOException;

server/src/main/java/org/opensearch/index/store/remote/metadata/RemoteSegmentMetadataParser.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ public class RemoteSegmentMetadataParser implements MetadataParser<RemoteSegment
2323
* Reads metadata content from metadata file input stream and parsed into {@link RemoteSegmentMetadata}
2424
* @param indexInput metadata file input stream with {@link IndexInput#getFilePointer()} pointing to metadata content
2525
* @return {@link RemoteSegmentMetadata}
26-
* @throws IOException
2726
*/
2827
@Override
2928
public RemoteSegmentMetadata readContent(IndexInput indexInput) throws IOException {
@@ -34,7 +33,6 @@ public RemoteSegmentMetadata readContent(IndexInput indexInput) throws IOExcepti
3433
* Writes metadata to file output stream
3534
* @param indexOutput metadata file input stream
3635
* @param content {@link RemoteSegmentMetadata} from which metadata content would be generated
37-
* @throws IOException
3836
*/
3937
@Override
4038
public void writeContent(IndexOutput indexOutput, RemoteSegmentMetadata content) throws IOException {}
@@ -43,7 +41,6 @@ public void writeContent(IndexOutput indexOutput, RemoteSegmentMetadata content)
4341
* Writes metadata to file output stream
4442
* @param indexOutput metadata file input stream
4543
* @param content metadata content
46-
* @throws IOException
4744
*
4845
* This method would be removed in future
4946
* and only {@link #writeContent(IndexOutput, RemoteSegmentMetadata)} would be leveraged in future

0 commit comments

Comments
 (0)