KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > iapi > services > io > Limit


1 /*
2
3    Derby - Class org.apache.derby.iapi.services.io.Limit
4
5    Licensed to the Apache Software Foundation (ASF) under one or more
6    contributor license agreements. See the NOTICE file distributed with
7    this work for additional information regarding copyright ownership.
8    The ASF licenses this file to you under the Apache License, Version 2.0
9    (the "License"); you may not use this file except in compliance with
10    the License. You may obtain a copy of the License at
11
12       http://www.apache.org/licenses/LICENSE-2.0
13
14    Unless required by applicable law or agreed to in writing, software
15    distributed under the License is distributed on an "AS IS" BASIS,
16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17    See the License for the specific language governing permissions and
18    limitations under the License.
19
20  */
21
22 package org.apache.derby.iapi.services.io;
23
24 import java.io.IOException JavaDoc;
25
26 /**
27     Methods that allow limits to be placed on an input or output stream to
28     avoid clients reading or writing too much information.
29 */
30 public interface Limit {
31
32     /**
33         Set the limit of the data that can be read or written. After this
34         call up to and including length bytes can be read from or skipped in
35         the stream.
36         
37         <P> On input classes (e.g. InputStreams) any attempt to read or skip
38         beyond the limit will result in an end of file indication
39         (e.g. read() methods returning -1 or throwing EOFException).
40
41         <P> On output classes (e.g. OutputStream) any attempt to write
42         more beyond the limit will result in an EOFException
43
44         @exception IOException IOException from some underlying stream
45         @exception EOFException The set limit would exceed
46         the available data in the stream.
47     */
48     public void setLimit(int length)
49         throws IOException JavaDoc;
50
51     /**
52         Clear any limit set by setLimit. After this call no limit checking
53         will be made on any read until a setLimit()) call is made.
54
55         @return the number of bytes within the limit that have not been read or written.
56     */
57     public int clearLimit();
58 }
59
Popular Tags