KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > hp > hpl > jena > graph > query > Pipe


1 /*
2   (c) Copyright 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
3   [See end of file]
4   $Id: Pipe.java,v 1.7 2005/02/21 11:52:25 andy_seaborne Exp $
5 */
6
7 package com.hp.hpl.jena.graph.query;
8
9 /**
10     A Pipe is anything that can be used to get and put Domain objects; it can be
11     closed, and it can be tested for whether more elements are available. A pipe
12     may be closed with an exception, in which case hasNext/get will fail with that
13     exception when they are called.
14     
15     @author kers
16 */
17 public interface Pipe
18     {
19     /**
20         Answer true iff there are more elements for <code>get()</code> to get. If
21         the pipe was closed with an exception, throw that exception.
22     */
23     public boolean hasNext();
24     
25     /**
26         Answer the next element if there is one, otherwise throw a NoSuchElementException.
27      */
28     public Domain get();
29     
30     /**
31         Put a domain element into the pipe for later extraction.
32     */
33     public void put( Domain d );
34     
35     /**
36         Close the pipe. hasNext() will deliver <code>false</code>, and
37         <code>get</code> will throw an exception.
38     */
39     public void close();
40     
41     /**
42          Close the pipe (see close()) and record <code>e</code> as its termination
43          status. Any <code>get</code> from the pipe must then fail, throwing an
44          exception.
45          
46          @param e the exception that caused the pipe to be closed
47     */
48     public void close( Exception JavaDoc e );
49     }
50
51 /*
52     (c) Copyright 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
53     All rights reserved.
54
55     Redistribution and use in source and binary forms, with or without
56     modification, are permitted provided that the following conditions
57     are met:
58
59     1. Redistributions of source code must retain the above copyright
60        notice, this list of conditions and the following disclaimer.
61
62     2. Redistributions in binary form must reproduce the above copyright
63        notice, this list of conditions and the following disclaimer in the
64        documentation and/or other materials provided with the distribution.
65
66     3. The name of the author may not be used to endorse or promote products
67        derived from this software without specific prior written permission.
68
69     THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
70     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
71     OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
72     IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
73     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
74     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
75     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
76     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
77     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
78     THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
79 */
80
Popular Tags