01: /*
02: * @(#)IScreenScraper.java
03: *
04: * Copyright (C) 2002-2003 Matt Albrecht
05: * groboclown@users.sourceforge.net
06: * http://groboutils.sourceforge.net
07: *
08: * Permission is hereby granted, free of charge, to any person obtaining a
09: * copy of this software and associated documentation files (the "Software"),
10: * to deal in the Software without restriction, including without limitation
11: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12: * and/or sell copies of the Software, and to permit persons to whom the
13: * Software is furnished to do so, subject to the following conditions:
14: *
15: * The above copyright notice and this permission notice shall be included in
16: * all copies or substantial portions of the Software.
17: *
18: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24: * DEALINGS IN THE SOFTWARE.
25: */
26:
27: package net.sourceforge.groboutils.uicapture.v1;
28:
29: import java.awt.image.BufferedImage;
30: import java.io.File;
31: import java.io.IOException;
32:
33: /**
34: * This interface defines a class which can save an Image to a file. The
35: * writing may be compressed, lossy, or whatever, just as long as a proper
36: * file Diff of the same Image (but different files) will result in no
37: * differences.
38: *
39: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
40: * @version Jan 7, 2002
41: */
42: public interface IScreenScraper {
43:
44: //-------------------------------------------------------------------------
45: // Public methods
46:
47: /**
48: * Write the given image to the given file.
49: *
50: * @param image The screen image to write to disk.
51: * @param file The File to save the image as.
52: * @exception IOException thrown if there was a problem saving the image to
53: * the file.
54: */
55: public void writeImageToFile(BufferedImage image, File file)
56: throws IOException;
57:
58: /**
59: * Discover the file extention for images created by this scraper.
60: * This does not include a '.'.
61: *
62: * @return the extention for files this scraper writes.
63: */
64: public String getFileExtention();
65: }
|