01: /*BEGIN_COPYRIGHT_BLOCK
02: *
03: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
04: * All rights reserved.
05: *
06: * Redistribution and use in source and binary forms, with or without
07: * modification, are permitted provided that the following conditions are met:
08: * * Redistributions of source code must retain the above copyright
09: * notice, this list of conditions and the following disclaimer.
10: * * Redistributions in binary form must reproduce the above copyright
11: * notice, this list of conditions and the following disclaimer in the
12: * documentation and/or other materials provided with the distribution.
13: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
14: * names of its contributors may be used to endorse or promote products
15: * derived from this software without specific prior written permission.
16: *
17: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28: *
29: * This software is Open Source Initiative approved Open Source Software.
30: * Open Source Initative Approved is a trademark of the Open Source Initiative.
31: *
32: * This file is part of DrJava. Download the current version of this project
33: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
34: *
35: * END_COPYRIGHT_BLOCK*/
36:
37: package edu.rice.cs.drjava.model;
38:
39: import edu.rice.cs.util.text.AbstractDocumentInterface;
40:
41: /**
42: * Returned to FindMachineDialog with the location of the found string
43: * (or -1 if the string was not found) as well as a flag indicating
44: * whether the machine wrapped around the end of the document.
45: *
46: * @version $Id: FindResult.java 4255 2007-08-28 19:17:37Z mgricken $
47: */
48: public class FindResult {
49: private OpenDefinitionsDocument _document;
50: private int _foundoffset;
51: private boolean _wrapped;
52: private boolean _allWrapped;
53:
54: /**
55: * Constructor for a FindResult.
56: * @param document the document where the found instance is located
57: * @param foundoffset the offset of the instance found
58: * @param wrapped {@code true} if the search wrapped to the beginning (or end) of the document
59: * @param allWrapped {@code true} if the search wrapped to the start document
60: */
61: public FindResult(OpenDefinitionsDocument document,
62: int foundoffset, boolean wrapped, boolean allWrapped) {
63: _document = document;
64: _foundoffset = foundoffset;
65: _wrapped = wrapped;
66: _allWrapped = allWrapped;
67: }
68:
69: /** Intelligible toString method */
70: public String toString() {
71: return "FindResult(" + _document + ", " + _foundoffset + ", "
72: + _wrapped + ", " + _allWrapped + ")";
73: }
74:
75: /** Returns the document where the found instance is located */
76: public OpenDefinitionsDocument getDocument() {
77: return _document;
78: }
79:
80: /** Returns the offset of the instance found */
81: public int getFoundOffset() {
82: return _foundoffset;
83: }
84:
85: /** Returns true if the search wrapped to the beginning (or end) of the document */
86: public boolean getWrapped() {
87: return _wrapped;
88: }
89:
90: /** Returns true if the search wrapped to the start document. TODO: change method name to getAllWrapped. */
91: public boolean getAllDocsWrapped() {
92: return _allWrapped;
93: }
94: }
|