Transport: Clarifying the role of AbstractBootstrap#bind()

This small changeset clarifies the role of AbstractBootstrap#bind(),
especially when not used in a ServerBoostrap context.
This commit is contained in:
Michael Nitschinger 2013-03-18 08:28:02 +01:00 committed by Trustin Lee
parent f4c18c6e74
commit 5a88227856
2 changed files with 5 additions and 0 deletions

View File

@ -33,6 +33,9 @@ import java.util.Map;
/**
* {@link AbstractBootstrap} is a helper class that makes it easy to bootstrap a {@link Channel}. It support
* method-chaining to provide an easy way to configure the {@link AbstractBootstrap}.
*
* <p>When not used in a {@link ServerBootstrap} context, the {@link #bind()} methods are useful for connectionless
* transports such as datagram (UDP).</p>
*/
abstract class AbstractBootstrap<B extends AbstractBootstrap<B, C>, C extends Channel> implements Cloneable {

View File

@ -34,6 +34,8 @@ import java.util.Map.Entry;
* A {@link Bootstrap} that makes it easy to bootstrap a {@link Channel} to use
* for clients.
*
* <p>The {@link #bind()} methods are useful in combination with connectionless transports such as datagram (UDP).
* For regular TCP connections, please use the provided {@link #connect()} methods.</p>
*/
public final class Bootstrap extends AbstractBootstrap<Bootstrap, Channel> {