archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-26 22:34:27 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8294377: Prepare to stop auto-inheriting documentation for subclasses of exceptions whose documentation is inherited

Browse source 
Reviewed-by: jjg
This commit is contained in:
Pavel Rappo 2022-10-10 16:54:57 +00:00
parent 4df4a1f8e2
commit eb90c4fc04
14 changed files with 320 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

26
src/java.base/share/classes/java/nio/channels/DatagramChannel.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -528,6 +528,10 @@ public abstract class DatagramChannel
*
* @throws NotYetConnectedException
* If this channel's socket is not connected
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract int read(ByteBuffer dst) throws IOException;
@ -543,6 +547,10 @@ public abstract class DatagramChannel
*
* @throws NotYetConnectedException
* If this channel's socket is not connected
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract long read(ByteBuffer[] dsts, int offset, int length)
throws IOException;
@ -559,6 +567,10 @@ public abstract class DatagramChannel
*
* @throws NotYetConnectedException
* If this channel's socket is not connected
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public final long read(ByteBuffer[] dsts) throws IOException {
return read(dsts, 0, dsts.length);
@ -574,6 +586,10 @@ public abstract class DatagramChannel
*
* @throws NotYetConnectedException
* If this channel's socket is not connected
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract int write(ByteBuffer src) throws IOException;
@ -593,6 +609,10 @@ public abstract class DatagramChannel
*
* @throws NotYetConnectedException
* If this channel's socket is not connected
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract long write(ByteBuffer[] srcs, int offset, int length)
throws IOException;
@ -613,6 +633,10 @@ public abstract class DatagramChannel
*
* @throws NotYetConnectedException
* If this channel's socket is not connected
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public final long write(ByteBuffer[] srcs) throws IOException {
return write(srcs, 0, srcs.length);

24
src/java.base/share/classes/java/nio/channels/FileChannel.java
View file

@ -372,6 +372,10 @@ public abstract class FileChannel
* then the file position is updated with the number of bytes actually
* read. Otherwise this method behaves exactly as specified in the {@link
* ReadableByteChannel} interface. </p>
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract int read(ByteBuffer dst) throws IOException;
@ -383,6 +387,10 @@ public abstract class FileChannel
* then the file position is updated with the number of bytes actually
* read. Otherwise this method behaves exactly as specified in the {@link
* ScatteringByteChannel} interface. </p>
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract long read(ByteBuffer[] dsts, int offset, int length)
throws IOException;
@ -394,6 +402,10 @@ public abstract class FileChannel
* then the file position is updated with the number of bytes actually
* read. Otherwise this method behaves exactly as specified in the {@link
* ScatteringByteChannel} interface. </p>
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public final long read(ByteBuffer[] dsts) throws IOException {
return read(dsts, 0, dsts.length);
@ -412,6 +424,10 @@ public abstract class FileChannel
*
* @throws NonWritableChannelException
* If this channel was not opened for writing
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract int write(ByteBuffer src) throws IOException;
@ -429,6 +445,10 @@ public abstract class FileChannel
*
* @throws NonWritableChannelException
* If this channel was not opened for writing
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract long write(ByteBuffer[] srcs, int offset, int length)
throws IOException;
@ -446,6 +466,10 @@ public abstract class FileChannel
*
* @throws NonWritableChannelException
* If this channel was not opened for writing
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public final long write(ByteBuffer[] srcs) throws IOException {
return write(srcs, 0, srcs.length);

10
src/java.base/share/classes/java/nio/channels/SeekableByteChannel.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2007, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -60,6 +60,10 @@ public interface SeekableByteChannel
* then the position is updated with the number of bytes actually read.
* Otherwise this method behaves exactly as specified in the {@link
* ReadableByteChannel} interface.
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
@Override
int read(ByteBuffer dst) throws IOException;
@ -75,6 +79,10 @@ public interface SeekableByteChannel
* written bytes, and then the position is updated with the number of bytes
* actually written. Otherwise this method behaves exactly as specified by
* the {@link WritableByteChannel} interface.
*
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
@Override
int write(ByteBuffer src) throws IOException;

20
src/java.base/share/classes/java/nio/channels/SocketChannel.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2000, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -603,12 +603,18 @@ public abstract class SocketChannel
/**
* @throws NotYetConnectedException
* If this channel is not yet connected
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract int read(ByteBuffer dst) throws IOException;
/**
* @throws NotYetConnectedException
* If this channel is not yet connected
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract long read(ByteBuffer[] dsts, int offset, int length)
throws IOException;
@ -616,6 +622,9 @@ public abstract class SocketChannel
/**
* @throws NotYetConnectedException
* If this channel is not yet connected
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public final long read(ByteBuffer[] dsts) throws IOException {
return read(dsts, 0, dsts.length);
@ -624,12 +633,18 @@ public abstract class SocketChannel
/**
* @throws NotYetConnectedException
* If this channel is not yet connected
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract int write(ByteBuffer src) throws IOException;
/**
* @throws NotYetConnectedException
* If this channel is not yet connected
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public abstract long write(ByteBuffer[] srcs, int offset, int length)
throws IOException;
@ -637,6 +652,9 @@ public abstract class SocketChannel
/**
* @throws NotYetConnectedException
* If this channel is not yet connected
* @throws ClosedChannelException {@inheritDoc}
* @throws AsynchronousCloseException {@inheritDoc}
* @throws ClosedByInterruptException {@inheritDoc}
*/
public final long write(ByteBuffer[] srcs) throws IOException {
return write(srcs, 0, srcs.length);

2
src/java.base/share/classes/java/nio/channels/spi/AbstractSelectableChannel.java
View file

@ -310,6 +310,8 @@ public abstract class AbstractSelectableChannel
* mode then this method invokes the {@link #implConfigureBlocking
* implConfigureBlocking} method, while holding the appropriate locks, in
* order to change the mode. </p>
*
* @throws ClosedChannelException {@inheritDoc}
*/
public final SelectableChannel configureBlocking(boolean block)
throws IOException