[#1940] Add javadoc to explain how the FileChannel is closed when using DefaultFileRegion

This commit is contained in:
Norman Maurer 2013-11-02 15:59:33 +01:00
parent 208411f9a9
commit de2c6acecf

View File

@ -25,6 +25,9 @@ import java.nio.channels.WritableByteChannel;
/** /**
* Default {@link FileRegion} implementation which transfer data from a {@link FileChannel}. * Default {@link FileRegion} implementation which transfer data from a {@link FileChannel}.
*
* Be aware that the {@link FileChannel} will be automatically closed once {@link #refCnt()} returns
* {@code 0}.
*/ */
public class DefaultFileRegion extends AbstractReferenceCounted implements FileRegion { public class DefaultFileRegion extends AbstractReferenceCounted implements FileRegion {