summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Jones <cbj@gnu.org>2003-01-10 17:07:00 +0000
committerBrian Jones <cbj@gnu.org>2003-01-10 17:07:00 +0000
commit7a8572090e782dfaf97a0007e43632089ce35067 (patch)
treecdd3c8c9e5aa1c3b112b2d8813fa70e674c8ab7b
parent882cebf5e5c8d6ee841ced846e41089714e9901f (diff)
downloadclasspath-7a8572090e782dfaf97a0007e43632089ce35067.tar.gz
* java/net/Socket.java: add missing @since tags, most of patch
from Sasha Brawer, includes a couple of javadoc typo fixes.
-rw-r--r--ChangeLog5
-rw-r--r--java/net/Socket.java47
2 files changed, 47 insertions, 5 deletions
diff --git a/ChangeLog b/ChangeLog
index 52302cdce..7ed889b15 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
2003-01-10: C. Brian Jones <cbj@gnu.org>
+ * java/net/Socket.java: add missing @since tags, most of patch
+ from Sasha Brawer, includes a couple of javadoc typo fixes.
+
+2003-01-10: C. Brian Jones <cbj@gnu.org>
+
* mkinstalldirs: updated to automake 1.6
* missing: ditto
* install-sh: ditto
diff --git a/java/net/Socket.java b/java/net/Socket.java
index e57c1ed53..79078f477 100644
--- a/java/net/Socket.java
+++ b/java/net/Socket.java
@@ -95,6 +95,7 @@ public class Socket
* might want this behavior.
*
* @specnote This constructor is public since JDK 1.4
+ * @since 1.1
*/
public Socket ()
{
@@ -122,6 +123,8 @@ public class Socket
* <code>Socket</code>
*
* @exception SocketException If an error occurs
+ *
+ * @since 1.1
*/
protected Socket (SocketImpl impl) throws SocketException
{
@@ -180,6 +183,8 @@ public class Socket
* exists and does not allow a connection to the specified host/port or
* binding to the specified local host/port.
* @exception IOException If a connection error occurs.
+ *
+ * @since 1.1
*/
public Socket (String host, int port,
InetAddress localAddr, int localPort) throws IOException
@@ -200,6 +205,8 @@ public class Socket
* @exception IOException If an error occurs
* @exception SecurityException If a security manager exists and its
* checkConnect method doesn't allow the operation
+ *
+ * @since 1.1
*/
public Socket (InetAddress address, int port,
InetAddress localAddr, int localPort) throws IOException
@@ -396,6 +403,8 @@ public class Socket
* is not connected, then <code>null</code> is returned.
*
* @return The local address
+ *
+ * @since 1.1
*/
public InetAddress getLocalAddress ()
{
@@ -521,6 +530,8 @@ public class Socket
* @param on true to enable, false to disable
*
* @exception SocketException If an error occurs or Socket is not connected
+ *
+ * @since 1.1
*/
public void setTcpNoDelay (boolean on) throws SocketException
{
@@ -539,6 +550,8 @@ public class Socket
* @return Whether or not TCP_NODELAY is set
*
* @exception SocketException If an error occurs or Socket not connected
+ *
+ * @since 1.1
*/
public boolean getTcpNoDelay() throws SocketException
{
@@ -567,6 +580,8 @@ public class Socket
*
* @exception SocketException If an error occurs or Socket not connected
* @exception IllegalArgumentException If linger is negative
+ *
+ * @since 1.1
*/
public void setSoLinger(boolean on, int linger) throws SocketException
{
@@ -602,6 +617,8 @@ public class Socket
* if SO_LINGER not set
*
* @exception SocketException If an error occurs or Socket is not connected
+ *
+ * @since 1.1
*/
public int getSoLinger() throws SocketException
{
@@ -675,12 +692,14 @@ public class Socket
* this option implies that there is no timeout (ie, operations will
* block forever). On systems that have separate read and write timeout
* values, this method returns the read timeout. This
- * value is in thousandths of a second (****????*****)
+ * value is in thousandths of a second.
*
- * @param timeout The length of the timeout in thousandth's of a second or
- * 0 if not set
+ * @param timeout The length of the timeout in thousandths of a second, or
+ * 0 to indicate no timeout.
*
* @exception SocketException If an error occurs or Socket not connected
+ *
+ * @since 1.1
*/
public synchronized void setSoTimeout (int timeout) throws SocketException
{
@@ -707,6 +726,8 @@ public class Socket
* if not set
*
* @exception SocketException If an error occurs or Socket not connected
+ *
+ * @since 1.1
*/
public synchronized int getSoTimeout () throws SocketException
{
@@ -822,7 +843,7 @@ public class Socket
*
* @exception SocketException If an error occurs or Socket is not connected
*
- * @since Java 1.3
+ * @since 1.3
*/
public void setKeepAlive (boolean on) throws SocketException
{
@@ -840,7 +861,7 @@ public class Socket
*
* @exception SocketException If an error occurs or Socket is not connected
*
- * @since Java 1.3
+ * @since 1.3
*/
public boolean getKeepAlive () throws SocketException
{
@@ -918,6 +939,8 @@ public class Socket
* Closes the input side of the socket stream.
*
* @exception IOException If an error occurs.
+ *
+ * @since 1.3
*/
public void shutdownInput() throws IOException
{
@@ -931,6 +954,8 @@ public class Socket
* Closes the output side of the socket stream.
*
* @exception IOException If an error occurs.
+ *
+ * @since 1.3
*/
public void shutdownOutput() throws IOException
{
@@ -944,6 +969,8 @@ public class Socket
* Returns the socket channel associated with this socket.
*
* It returns null if no associated socket exists.
+ *
+ * @since 1.4
*/
public SocketChannel getChannel()
{
@@ -1032,6 +1059,8 @@ public class Socket
/**
* Checks if the socket is connected
+ *
+ * @since 1.4
*/
public boolean isConnected ()
{
@@ -1040,6 +1069,8 @@ public class Socket
/**
* Checks if the socket is already bound.
+ *
+ * @since 1.4
*/
public boolean isBound ()
{
@@ -1048,6 +1079,8 @@ public class Socket
/**
* Checks if the socket is closed.
+ *
+ * @since 1.4
*/
public boolean isClosed ()
{
@@ -1056,6 +1089,8 @@ public class Socket
/**
* Checks if the socket's input stream is shutdown
+ *
+ * @since 1.4
*/
public boolean isInputShutdown ()
{
@@ -1064,6 +1099,8 @@ public class Socket
/**
* Checks if the socket's output stream is shutdown
+ *
+ * @since 1.4
*/
public boolean isOutputShutdown ()
{