Skip to content

Commit 3686e7f

Browse files
committed
use jdk 1.6 @OVERRIDES instead of /** {@inheritdoc} */ doc tags
1 parent b3d749f commit 3686e7f

18 files changed

+64
-65
lines changed

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/AbstractFastqReader.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,23 +55,23 @@ abstract class AbstractFastqReader
5555
*/
5656
protected abstract FastqVariant getVariant();
5757

58-
/** {@inheritDoc} */
58+
@Override
5959
public final <R extends Readable & Closeable> void parse(final InputSupplier<R> supplier,
6060
final ParseListener listener)
6161
throws IOException
6262
{
6363
FastqParser.parse(supplier, listener);
6464
}
6565

66-
/** {@inheritDoc} */
66+
@Override
6767
public final <R extends Readable & Closeable> void stream(final InputSupplier<R> supplier,
6868
final StreamListener listener)
6969
throws IOException
7070
{
7171
StreamingFastqParser.stream(supplier, getVariant(), listener);
7272
}
7373

74-
/** {@inheritDoc} */
74+
@Override
7575
public final Iterable<Fastq> read(final File file) throws IOException
7676
{
7777
if (file == null)
@@ -83,7 +83,7 @@ public final Iterable<Fastq> read(final File file) throws IOException
8383
return collect.getResult();
8484
}
8585

86-
/** {@inheritDoc} */
86+
@Override
8787
public final Iterable<Fastq> read(final URL url) throws IOException
8888
{
8989
if (url == null)
@@ -95,7 +95,7 @@ public final Iterable<Fastq> read(final URL url) throws IOException
9595
return collect.getResult();
9696
}
9797

98-
/** {@inheritDoc} */
98+
@Override
9999
public final Iterable<Fastq> read(final InputStream inputStream) throws IOException
100100
{
101101
if (inputStream == null)
@@ -105,7 +105,7 @@ public final Iterable<Fastq> read(final InputStream inputStream) throws IOExcept
105105
Collect collect = new Collect();
106106
stream(new InputSupplier<InputStreamReader>()
107107
{
108-
/** {@inheritDoc} */
108+
@Override
109109
public InputStreamReader getInput() throws IOException
110110
{
111111
return new InputStreamReader(inputStream);
@@ -122,7 +122,7 @@ private static final class Collect implements StreamListener
122122
/** List of FASTQ formatted sequences. */
123123
private final List<Fastq> result = Lists.newLinkedList();
124124

125-
/** {@inheritDoc} */
125+
@Override
126126
public void fastq(final Fastq fastq)
127127
{
128128
result.add(fastq);

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/AbstractFastqWriter.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ abstract class AbstractFastqWriter
4747
*/
4848
protected abstract void validate(final Fastq fastq) throws IOException;
4949

50-
/** {@inheritDoc} */
50+
@Override
5151
public final <T extends Appendable> T append(final T appendable, final Fastq... fastq) throws IOException
5252
{
5353
return append(appendable, Arrays.asList(fastq));
5454
}
5555

56-
/** {@inheritDoc} */
56+
@Override
5757
public final <T extends Appendable> T append(final T appendable, final Iterable<Fastq> fastq) throws IOException
5858
{
5959
if (appendable == null)
@@ -82,13 +82,13 @@ public final <T extends Appendable> T append(final T appendable, final Iterable<
8282
return appendable;
8383
}
8484

85-
/** {@inheritDoc} */
85+
@Override
8686
public final void write(final File file, final Fastq... fastq) throws IOException
8787
{
8888
write(file, Arrays.asList(fastq));
8989
}
9090

91-
/** {@inheritDoc} */
91+
@Override
9292
public final void write(final File file, final Iterable<Fastq> fastq) throws IOException
9393
{
9494
if (file == null)
@@ -121,13 +121,13 @@ public final void write(final File file, final Iterable<Fastq> fastq) throws IOE
121121
}
122122
}
123123

124-
/** {@inheritDoc} */
124+
@Override
125125
public final void write(final OutputStream outputStream, final Fastq... fastq) throws IOException
126126
{
127127
write(outputStream, Arrays.asList(fastq));
128128
}
129129

130-
/** {@inheritDoc} */
130+
@Override
131131
public final void write(final OutputStream outputStream, final Iterable<Fastq> fastq) throws IOException
132132
{
133133
if (outputStream == null)

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/FastqParser.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ private void setState(final State state)
115115
this.state = state;
116116
}
117117

118-
/** {@inheritDoc} */
118+
@Override
119119
public Object getResult()
120120
{
121121
return null;
122122
}
123123

124-
/** {@inheritDoc} */
124+
@Override
125125
public boolean processLine(final String line) throws IOException
126126
{
127127
String sequence = null;

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/IlluminaFastqReader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public final class IlluminaFastqReader
2929
extends AbstractFastqReader
3030
{
3131

32-
/** {@inheritDoc} */
32+
@Override
3333
protected FastqVariant getVariant()
3434
{
3535
return FastqVariant.FASTQ_ILLUMINA;

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/IlluminaFastqWriter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public final class IlluminaFastqWriter
3131
extends AbstractFastqWriter
3232
{
3333

34-
/** {@inheritDoc} */
34+
@Override
3535
protected void validate(final Fastq fastq) throws IOException
3636
{
3737
if (fastq == null)

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/SangerFastqReader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public final class SangerFastqReader
2929
extends AbstractFastqReader
3030
{
3131

32-
/** {@inheritDoc} */
32+
@Override
3333
protected FastqVariant getVariant()
3434
{
3535
return FastqVariant.FASTQ_SANGER;

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/SangerFastqWriter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public final class SangerFastqWriter
3131
extends AbstractFastqWriter
3232
{
3333

34-
/** {@inheritDoc} */
34+
@Override
3535
protected void validate(final Fastq fastq) throws IOException
3636
{
3737
if (fastq == null)

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/SolexaFastqReader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public final class SolexaFastqReader
2929
extends AbstractFastqReader
3030
{
3131

32-
/** {@inheritDoc} */
32+
@Override
3333
protected FastqVariant getVariant()
3434
{
3535
return FastqVariant.FASTQ_SOLEXA;

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/SolexaFastqWriter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public final class SolexaFastqWriter
3131
extends AbstractFastqWriter
3232
{
3333

34-
/** {@inheritDoc} */
34+
@Override
3535
protected void validate(final Fastq fastq) throws IOException
3636
{
3737
if (fastq == null)

biojava3-sequencing/src/main/java/org/biojava3/sequencing/io/fastq/StreamingFastqParser.java

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,25 +62,25 @@ static <R extends Readable & Closeable> void stream(final InputSupplier<R> suppl
6262
final FastqBuilder builder = new FastqBuilder().withVariant(variant);
6363
FastqParser.parse(supplier, new ParseListener()
6464
{
65-
/** {@inheritDoc} */
65+
@Override
6666
public void description(final String description) throws IOException
6767
{
6868
builder.withDescription(description);
6969
}
7070

71-
/** {@inheritDoc} */
71+
@Override
7272
public void sequence(final String sequence) throws IOException
7373
{
7474
builder.withSequence(sequence);
7575
}
7676

77-
/** {@inheritDoc} */
77+
@Override
7878
public void appendSequence(final String sequence) throws IOException
7979
{
8080
builder.appendSequence(sequence);
8181
}
8282

83-
/** {@inheritDoc} */
83+
@Override
8484
public void repeatDescription(final String repeatDescription) throws IOException
8585
{
8686
String description = builder.getDescription();
@@ -114,21 +114,21 @@ private void validateQuality(final String quality) throws IOException
114114
}
115115
}
116116

117-
/** {@inheritDoc} */
117+
@Override
118118
public void quality(final String quality) throws IOException
119119
{
120120
validateQuality(quality);
121121
builder.withQuality(quality);
122122
}
123123

124-
/** {@inheritDoc} */
124+
@Override
125125
public void appendQuality(final String quality) throws IOException
126126
{
127127
validateQuality(quality);
128128
builder.appendQuality(quality);
129129
}
130130

131-
/** {@inheritDoc} */
131+
@Override
132132
public void complete() throws IOException
133133
{
134134
try
@@ -137,8 +137,7 @@ public void complete() throws IOException
137137
}
138138
catch (IllegalStateException e)
139139
{
140-
throw new IOException("caught an IllegalStateException " + e.getMessage());
141-
//throw new IOException("caught an IllegalStateException", e); jdk 1.6+
140+
throw new IOException("caught an IllegalStateException", e);
142141
}
143142
}
144143
});

0 commit comments

Comments
 (0)