org.apache.derby.iapi.services.io
Interface Limit

All Known Subinterfaces:
LimitObjectInput
All Known Implementing Classes:
ArrayInputStream, ArrayOutputStream, CounterOutputStream, LimitInputStream, LimitReader, RawToBinaryFormatStream

public interface Limit

Methods that allow limits to be placed on an input or output stream to avoid clients reading or writing too much information.


Method Summary
 int clearLimit()
          Clear any limit set by setLimit.
 void setLimit(int length)
          Set the limit of the data that can be read or written.
 

Method Detail

setLimit

void setLimit(int length)
              throws java.io.IOException
Set the limit of the data that can be read or written. After this call up to and including length bytes can be read from or skipped in the stream.

On input classes (e.g. InputStreams) any attempt to read or skip beyond the limit will result in an end of file indication (e.g. read() methods returning -1 or throwing EOFException).

On output classes (e.g. OutputStream) any attempt to write more beyond the limit will result in an EOFException

Throws:
java.io.IOException - IOException from some underlying stream
EOFException - The set limit would exceed the available data in the stream.

clearLimit

int clearLimit()
Clear any limit set by setLimit. After this call no limit checking will be made on any read until a setLimit()) call is made.

Returns:
the number of bytes within the limit that have not been read or written.

Built on Thu 2011-03-10 11:54:14+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.