Author: elecharny
Date: Tue Dec 13 12:07:09 2011
New Revision: 1213656
URL: http://svn.apache.org/viewvc?rev=1213656&view=rev
Log:
o Added the missing Javadoc
o Added a toString() method
Modified:
mina/trunk/core/src/main/java/org/apache/mina/session/DefaultWriteRequest.java
mina/trunk/core/src/main/java/org/apache/mina/session/WriteRequest.java
Modified:
mina/trunk/core/src/main/java/org/apache/mina/session/DefaultWriteRequest.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/session/DefaultWriteRequest.java?rev=1213656&r1=1213655&r2=1213656&view=diff
==============================================================================
---
mina/trunk/core/src/main/java/org/apache/mina/session/DefaultWriteRequest.java
(original)
+++
mina/trunk/core/src/main/java/org/apache/mina/session/DefaultWriteRequest.java
Tue Dec 13 12:07:09 2011
@@ -19,21 +19,27 @@
*/
package org.apache.mina.session;
+import java.nio.ByteBuffer;
+
import org.apache.mina.api.IoFuture;
+import org.apache.mina.util.ByteBufferDumper;
/**
* Default implementation for write requests.
*
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
- *
*/
public class DefaultWriteRequest implements WriteRequest {
-
+ /** The stored message */
private Object message;
- // the future to complete when this message is written
+ /** the future to complete when this message is written */
private IoFuture<Void> future;
+ /**
+ * Creates a new instance of a WriteRequest
+ * @param message The stored message
+ */
public DefaultWriteRequest(Object message) {
this.message = message;
}
@@ -46,12 +52,40 @@ public class DefaultWriteRequest impleme
return message;
}
+ /**
+ * {@inheritDoc}
+ */
public IoFuture<Void> getFuture() {
return future;
}
+ /**
+ * Associates a Future to this WriteRequest instance
+ * @param future The associated Future
+ */
public void setFuture(IoFuture<Void> future) {
this.future = future;
}
-
+
+ /**
+ * @see Object#toString()
+ */
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+
+ sb.append("WriteRequest[");
+
+ if (future != null) {
+ sb.append("Future,");
+ }
+
+ if (message != null) {
+ // Just dump the first 16 bytes
+ sb.append(ByteBufferDumper.dump((ByteBuffer)message, 16, false));
+ }
+
+ sb.append("]");
+
+ return sb.toString();
+ }
}
\ No newline at end of file
Modified:
mina/trunk/core/src/main/java/org/apache/mina/session/WriteRequest.java
URL:
http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/session/WriteRequest.java?rev=1213656&r1=1213655&r2=1213656&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/session/WriteRequest.java
(original)
+++ mina/trunk/core/src/main/java/org/apache/mina/session/WriteRequest.java Tue
Dec 13 12:07:09 2011
@@ -28,18 +28,16 @@ import org.apache.mina.api.IoFuture;
* @author <a href="http://mina.apache.org";>Apache MINA Project</a>
*/
public interface WriteRequest {
-
/**
- * Get the message of this request.
+ * Get the message stored for this request.
*
* @return the contained message
*/
Object getMessage();
/**
- * The future to be completed on this write success
+ * The future to be completed on a write success
* @return the future
*/
IoFuture<Void> getFuture();
-
}
\ No newline at end of file
