KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sourceforge > groboutils > uicapture > v1 > IScreenScraper


1 /*
2  * @(#)IScreenScraper.java
3  *
4  * Copyright (C) 2002-2003 Matt Albrecht
5  * groboclown@users.sourceforge.net
6  * http://groboutils.sourceforge.net
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a
9  * 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 JavaDoc;
30 import java.io.File JavaDoc;
31 import java.io.IOException JavaDoc;
32
33
34 /**
35  * This interface defines a class which can save an Image to a file. The
36  * writing may be compressed, lossy, or whatever, just as long as a proper
37  * file Diff of the same Image (but different files) will result in no
38  * differences.
39  *
40  * @author Matt Albrecht <a HREF="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
41  * @version Jan 7, 2002
42  */
43 public interface IScreenScraper
44 {
45
46     //-------------------------------------------------------------------------
47 // Public methods
48
49     /**
50      * Write the given image to the given file.
51      *
52      * @param image The screen image to write to disk.
53      * @param file The File to save the image as.
54      * @exception IOException thrown if there was a problem saving the image to
55      * the file.
56      */
57     public void writeImageToFile( BufferedImage JavaDoc image, File JavaDoc file )
58             throws IOException JavaDoc;
59     
60     
61     /**
62      * Discover the file extention for images created by this scraper.
63      * This does not include a '.'.
64      *
65      * @return the extention for files this scraper writes.
66      */
67     public String JavaDoc getFileExtention();
68 }
69
70
Popular Tags