KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > iapi > types > Resetable


1 /*
2
3    Derby - Class org.apache.derby.iapi.types.Resetable
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.types;
23
24 import org.apache.derby.iapi.error.StandardException;
25 import java.io.IOException JavaDoc;
26
27 /**
28  * This is a simple interface that is used by
29  * streams that can initialize and reset themselves.
30  * The purpose is for the implementation of BLOB/CLOB.
31  * It defines a methods that can be used to initialize and reset a stream.
32  */
33 public interface Resetable
34 {
35     /**
36      * Reset the stream to the beginning.
37      */
38     public void resetStream() throws IOException JavaDoc, StandardException;
39
40     /**
41      * Initialize. Needs to be called first, before a resetable stream can
42      * be used.
43      *
44      */
45     public void initStream() throws StandardException;
46
47     /**
48      * Close. Free resources (such as open containers and locks) associated
49      * with the stream.
50      */
51     public void closeStream();
52
53 }
54
Popular Tags