fixed various javadoc warnings; downgraded maven-javadoc-plugin to 2.5, as that's the version that gets forced when using Maven 2.1.0 anyway.

This commit is contained in:
Chris Beams
2010-06-01 17:57:29 +00:00
parent 7d6babbacf
commit f6b1d79f0f
12 changed files with 9 additions and 39 deletions

View File

@@ -431,7 +431,7 @@
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<version>2.5</version>
<configuration>
<javadoc:aggregate>true</javadoc:aggregate>
<breakiterator>true</breakiterator>

View File

@@ -16,6 +16,9 @@
package org.springframework.integration.ip;
import java.net.DatagramSocket;
import java.net.Socket;
/**
* @author Gary Russell
* @since 2.0
@@ -25,21 +28,18 @@ public interface CommonSocketOptions {
/**
* @see Socket#setSoTimeout(int)
* @see DatagramSocket#setSoTimeout(int)
* @param timeout
*/
public void setSoTimeout(int soTimeout);
/**
* @see Socket#setReceiveBufferSize(int)
* @see DatagramSocket#setReceiveBufferSize(int)
* @param size
*/
public void setSoReceiveBufferSize(int soReceiveBufferSize);
/**
* @see Socket#setSendBufferSize(int)
* @see DatagramSocket#setSendBufferSize(int)
* @param size
*/
public void setSoSendBufferSize(int soSendBufferSize);

View File

@@ -32,7 +32,7 @@ import org.apache.commons.logging.LogFactory;
* {@link java.nio.channels.SocketChannel} implementations are provided for
* the standard formats. Users requiring other formats should subclass the
* appropriate implementation, and provide an implementation for
* {@link #writeCustomFormat(byte[])} which is invoked by {@link #write(byte[])}
* {@link #writeCustomFormat(Object)} which is invoked by {@link #write(Object)}
* when the format is {@link MessageFormats#FORMAT_CUSTOM}.
*
* @author Gary Russell
@@ -46,7 +46,7 @@ public abstract class AbstractSocketWriter implements SocketWriter, MessageForma
protected final Log logger = LogFactory.getLog(this.getClass());
/*
* @see org.springframework.integration.ip.tcp.SocketWriter#write(byte[])
* @see org.springframework.integration.ip.tcp.SocketWriter#write(Object)
*/
public synchronized void write(Object object) throws IOException {
try {
@@ -100,19 +100,16 @@ public abstract class AbstractSocketWriter implements SocketWriter, MessageForma
/**
* Write the data, followed by carriage return, line feed ('\r\n').
* @param bytes
*/
protected abstract void writeCrLfFormat(byte[] bytes) throws IOException;
/**
* Write the data, followed by carriage return, line feed ('\r\n').
* @param bytes
*/
protected abstract void writeSerializedFormat(Object object) throws IOException;
/**
* Write the data using some custom protocol.
* @param bytes
*/
protected abstract void writeCustomFormat(Object object) throws IOException;

View File

@@ -159,7 +159,7 @@ public class NetSocketReader extends AbstractSocketReader {
* Throws {@link UnsupportedOperationException}; custom implementations can
* subclass this class and provide an implementation for this method.
* @throws IOException
* @see org.springframework.integration.ip.tcp.AbstractSocketReader#assembleDataCustomFormat().
* @see org.springframework.integration.ip.tcp.AbstractSocketReader#assembleDataCustomFormat
*
*/
@Override

View File

@@ -240,7 +240,7 @@ public class NioSocketReader extends AbstractSocketReader {
* Throws {@link UnsupportedOperationException}; Java serialization is currently only
* supported using the NetSocketReader.
* @throws IOException
* @see org.springframework.integration.ip.tcp.AbstractSocketReader#assembleDataCustomFormat().
* @see org.springframework.integration.ip.tcp.AbstractSocketReader#assembleDataCustomFormat
*
*/
protected int assembleDataSerializedFormat() throws IOException {
@@ -252,7 +252,7 @@ public class NioSocketReader extends AbstractSocketReader {
* Throws {@link UnsupportedOperationException}; custom implementations can
* subclass this class and provide an implementation.
* @throws IOException
* @see org.springframework.integration.ip.tcp.AbstractSocketReader#assembleDataCustomFormat().
* @see org.springframework.integration.ip.tcp.AbstractSocketReader#assembleDataCustomFormat
*
*/
@Override

View File

@@ -22,7 +22,6 @@ import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.MulticastSocket;
import java.net.NetworkInterface;
import java.net.SocketAddress;
import org.springframework.integration.message.MessageHandler;

View File

@@ -33,9 +33,6 @@ public class CustomNioSocketReader extends NioSocketReader {
super(null);
}
/**
* @param socket
*/
public CustomNioSocketReader(SocketChannel channel) {
super(channel);
}

View File

@@ -37,10 +37,6 @@ import org.springframework.integration.ip.util.SocketUtils;
*/
public class NetSocketReaderTests {
/**
* Test method for {@link org.springframework.integration.ip.tcp.NioSocketReader#readFully()},
* using &lt;length&gt;&lt;message&gt;.
*/
@Test
public void testReadLength() throws Exception {
int port = SocketUtils.findAvailableServerSocket();
@@ -67,10 +63,6 @@ public class NetSocketReaderTests {
server.close();
}
/**
* Test method for {@link org.springframework.integration.ip.tcp.NioSocketReader#readFully()},
* using STX&lt;message&gt;ETX
*/
@Test
public void testReadStxEtx() throws Exception {
int port = SocketUtils.findAvailableServerSocket();
@@ -98,10 +90,6 @@ public class NetSocketReaderTests {
server.close();
}
/**
* Test method for {@link org.springframework.integration.ip.tcp.NioSocketReader#readFully()},
* using STX&lt;message&gt;ETX
*/
@Test
public void testReadCrLf() throws Exception {
int port = SocketUtils.findAvailableServerSocket();
@@ -129,10 +117,6 @@ public class NetSocketReaderTests {
server.close();
}
/**
* Test method for {@link org.springframework.integration.ip.tcp.NioSocketReader#readFully()},
* using STX&lt;message&gt;ETX
*/
@Test
public void testReadSerialized() throws Exception {
int port = SocketUtils.findAvailableServerSocket();

View File

@@ -38,8 +38,6 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@RunWith(SpringJUnit4ClassRunner.class)
public class SimpleTcpNetInboundGatewayTests {
private static int startup = 2000;
@Autowired
@Qualifier(value="gatewayCrLf")
SimpleTcpNetInboundGateway gatewayCrLf;

View File

@@ -103,9 +103,6 @@ public class SocketUtils {
/**
* Test for reassembly of completely fragmented message; sends
* 6 bytes 500ms apart.
* @param os
* @param b
* @throws Exception
*/
public static void testSendFragmented(final int port, final boolean noDelay) {
Thread thread = new Thread(new Runnable() {

View File

@@ -37,7 +37,6 @@ interface MessageChannelInfo {
/**
* Number of Messages that have caused Exceptions on send.
* @return
*/
long getSendErrorCount();

View File

@@ -67,7 +67,6 @@ public class BanksChannelSelector {
/**
* @param message
* @return
*/
@SuppressWarnings("unchecked")
public Set<String> selectBankChannels(Message<?> message) {