INT-1120 INT-1269 Javadoc polish
This commit is contained in:
@@ -31,7 +31,7 @@ public interface InputStreamingConverter<T> {
|
||||
|
||||
/**
|
||||
* Read (assemble an object of type T) from an InputStream.
|
||||
* @param is The InputStream.
|
||||
* @param inputStream The InputStream.
|
||||
* @return The object.
|
||||
* @throws IOException
|
||||
*/
|
||||
|
||||
@@ -232,7 +232,7 @@ public abstract class AbstractConnectionFactory
|
||||
* Registers a TcpSender; for server sockets, used to
|
||||
* provide connection information so a sender can be used
|
||||
* to reply to incoming messages.
|
||||
* @param tcpSendingMessageHandler
|
||||
* @param sender The sender
|
||||
*/
|
||||
public void registerSender(TcpSender sender) {
|
||||
Assert.isNull(this.sender, this.getClass().getName() +
|
||||
|
||||
@@ -79,14 +79,14 @@ public abstract class AbstractTcpConnection implements TcpConnection {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param converter the input converter to set
|
||||
* @param inputConverter the input converter to set
|
||||
*/
|
||||
public void setInputConverter(InputStreamingConverter<?> inputConverter) {
|
||||
this.inputConverter = inputConverter;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param converter the output converter to set
|
||||
* @param outputConverter the output converter to set
|
||||
*/
|
||||
public void setOutputConverter(OutputStreamingConverter<?> outputConverter) {
|
||||
this.outputConverter = outputConverter;
|
||||
@@ -96,7 +96,7 @@ public abstract class AbstractTcpConnection implements TcpConnection {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param sender the listener to set
|
||||
* @param listener the listener to set
|
||||
*/
|
||||
public void registerListener(TcpListener listener) {
|
||||
this.listener = listener;
|
||||
|
||||
@@ -55,7 +55,7 @@ public interface TcpConnection extends Runnable {
|
||||
/**
|
||||
* Uses the input converter to obtain the message payload
|
||||
* from the connection's input stream.
|
||||
* @return
|
||||
* @return The payload
|
||||
* @throws Exception
|
||||
*/
|
||||
public Object getPayload() throws Exception;
|
||||
@@ -77,7 +77,7 @@ public interface TcpConnection extends Runnable {
|
||||
|
||||
/**
|
||||
* Sets the listener that will receive incoming Messages.
|
||||
* @param listener
|
||||
* @param listener The listener
|
||||
*/
|
||||
public void registerListener(TcpListener listener);
|
||||
|
||||
@@ -96,7 +96,7 @@ public interface TcpConnection extends Runnable {
|
||||
|
||||
/**
|
||||
* When true, the socket is used once and discarded.
|
||||
* @param singleUse
|
||||
* @param singleUse the singleUse
|
||||
*/
|
||||
public void setSingleUse(boolean singleUse);
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ public interface TcpListener {
|
||||
/**
|
||||
* Return true if the connection factory is a server
|
||||
* and it is listening.
|
||||
* @return
|
||||
* @return true if listening
|
||||
*/
|
||||
public boolean isListening();
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ import java.net.Socket;
|
||||
import javax.net.SocketFactory;
|
||||
|
||||
/**
|
||||
* A client connection factory that creates {@link TcpNetConection}s.
|
||||
* A client connection factory that creates {@link TcpNetConnection}s.
|
||||
* @author Gary Russell
|
||||
* @since 2.0
|
||||
*
|
||||
|
||||
@@ -166,7 +166,7 @@ public class TcpNioClientConnectionFactory extends
|
||||
e.getMessage());
|
||||
connection.close();
|
||||
} else {
|
||||
logger.debug("Conection closed");
|
||||
logger.debug("Connection closed");
|
||||
}
|
||||
}
|
||||
if (key.channel().isOpen()) {
|
||||
|
||||
@@ -167,7 +167,7 @@ public class TcpNioServerConnectionFactory extends AbstractServerConnectionFacto
|
||||
logger.error("Exception on read " + e.getMessage());
|
||||
connection.close();
|
||||
} else {
|
||||
logger.debug("Conection closed");
|
||||
logger.debug("Connection closed");
|
||||
}
|
||||
}
|
||||
if (key.channel().isOpen()) {
|
||||
|
||||
Reference in New Issue
Block a user