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