JDK 9 RFR of JDK-8041395: Doclint regression in java.net.SocketOption

[Lance Andersen]

looks fine joe

best
lance
On Feb 9, 2015, at 6:27 PM, joe darcy <joe.darcy at oracle.com> wrote:

> Hello,
> 
> Please review these straightforward changes to address some doclint issues in java.net:
> 
>    JDK-8041395: Doclint regression in java.net.SocketOption
>    http://cr.openjdk.java.net/~darcy/8041395.0/
> 
> Patch below.
> 
> Thanks,
> 
> -Joe
> 
> --- old/src/java.base/share/classes/java/net/DatagramSocket.java 2015-02-09 15:19:25.407396706 -0800
> +++ new/src/java.base/share/classes/java/net/DatagramSocket.java 2015-02-09 15:19:25.223399019 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2015, 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
> @@ -1308,6 +1308,7 @@
>     /**
>      * Sets the value of a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      * @param value The value of the socket option. A value of {@code null}
>      *              may be valid for some options.
> @@ -1342,6 +1343,7 @@
>     /**
>      * Returns the value of a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @return The value of the socket option.
> --- old/src/java.base/share/classes/java/net/DatagramSocketImpl.java 2015-02-09 15:19:25.855391074 -0800
> +++ new/src/java.base/share/classes/java/net/DatagramSocketImpl.java 2015-02-09 15:19:25.695393086 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1996, 2015, 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
> @@ -267,6 +267,7 @@
>     /**
>      * Called to set a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @param value The value of the socket option. A value of {@code null}
> @@ -276,7 +277,7 @@
>      *         support the option
>      *
>      * @throws NullPointerException if name is {@code null}
> -     *
> +     * @throws IOException if an I/O problem occurs while attempting to set the option
>      * @since 1.9
>      */
>     protected <T> void setOption(SocketOption<T> name, T value) throws IOException {
> @@ -308,12 +309,15 @@
>     /**
>      * Called to get a socket option.
>      *
> +     * @return the socket option
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @throws UnsupportedOperationException if the DatagramSocketImpl does not
>      *         support the option
>      *
>      * @throws NullPointerException if name is {@code null}
> +     * @throws IOException if an I/O problem occurs while attempting to set the option
>      *
>      * @since 1.9
>      */
> --- old/src/java.base/share/classes/java/net/ServerSocket.java 2015-02-09 15:19:26.303385442 -0800
> +++ new/src/java.base/share/classes/java/net/ServerSocket.java 2015-02-09 15:19:26.131387604 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2015, 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
> @@ -924,6 +924,7 @@
>     /**
>      * Sets the value of a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      * @param value The value of the socket option. A value of {@code null}
>      *              may be valid for some options.
> @@ -957,6 +958,7 @@
>     /**
>      * Returns the value of a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @return The value of the socket option.
> --- old/src/java.base/share/classes/java/net/Socket.java 2015-02-09 15:19:26.739379961 -0800
> +++ new/src/java.base/share/classes/java/net/Socket.java 2015-02-09 15:19:26.579381972 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2015, 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
> @@ -1727,6 +1727,7 @@
>     /**
>      * Sets the value of a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      * @param value The value of the socket option. A value of {@code null}
>      *              may be valid for some options.
> @@ -1758,6 +1759,7 @@
>     /**
>      * Returns the value of a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @return The value of the socket option.
> --- old/src/java.base/share/classes/java/net/SocketImpl.java 2015-02-09 15:19:27.191374279 -0800
> +++ new/src/java.base/share/classes/java/net/SocketImpl.java 2015-02-09 15:19:27.031376290 -0800
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 1995, 2015, 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
> @@ -362,6 +362,7 @@
>     /**
>      * Called to set a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @param value The value of the socket option. A value of {@code null}
> @@ -397,6 +398,7 @@
>     /**
>      * Called to get a socket option.
>      *
> +     * @param <T> The type of the socket option value
>      * @param name The socket option
>      *
>      * @return the value of the named option
> 



Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com