01: /*
02: $Id: Range.java 641 2004-01-20 09:53:23Z jstrachan $
03:
04: Copyright 2003 (C) James Strachan and Bob Mcwhirter. All Rights Reserved.
05:
06: Redistribution and use of this software and associated documentation
07: ("Software"), with or without modification, are permitted provided
08: that the following conditions are met:
09:
10: 1. Redistributions of source code must retain copyright
11: statements and notices. Redistributions must also contain a
12: copy of this document.
13:
14: 2. Redistributions in binary form must reproduce the
15: above copyright notice, this list of conditions and the
16: following disclaimer in the documentation and/or other
17: materials provided with the distribution.
18:
19: 3. The name "groovy" must not be used to endorse or promote
20: products derived from this Software without prior written
21: permission of The Codehaus. For written permission,
22: please contact info@codehaus.org.
23:
24: 4. Products derived from this Software may not be called "groovy"
25: nor may "groovy" appear in their names without prior written
26: permission of The Codehaus. "groovy" is a registered
27: trademark of The Codehaus.
28:
29: 5. Due credit should be given to The Codehaus -
30: http://groovy.codehaus.org/
31:
32: THIS SOFTWARE IS PROVIDED BY THE CODEHAUS AND CONTRIBUTORS
33: ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
34: NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
35: FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
36: THE CODEHAUS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
37: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
38: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
39: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
42: ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
43: OF THE POSSIBILITY OF SUCH DAMAGE.
44:
45: */
46: package groovy.lang;
47:
48: import java.util.List;
49:
50: /**
51: * Represents the interface of a Range implementation which includes the
52: * from and to values
53: *
54: * @author <a href="mailto:james@coredevelopers.net">James Strachan</a>
55: * @version $Revision: 641 $
56: */
57: public interface Range extends List {
58:
59: /**
60: * @return the lower value in the range
61: */
62: public Comparable getFrom();
63:
64: /**
65: * @return the upper value in the range
66: */
67: public Comparable getTo();
68:
69: /**
70: * @return true if this is a reverse range, iterating backwards
71: * starting from the to value and ending on the from value
72: */
73: public boolean isReverse();
74:
75: /**
76: * @return the verbose String representation of this Range as would be typed into a console
77: * to create the Range instance
78: */
79: public String inspect();
80: }
|