001: /*
002: * @(#)DefaultScreenScraper.java
003: *
004: * Copyright (C) 2002-2003 Matt Albrecht
005: * groboclown@users.sourceforge.net
006: * http://groboutils.sourceforge.net
007: *
008: * Permission is hereby granted, free of charge, to any person obtaining a
009: * copy of this software and associated documentation files (the "Software"),
010: * to deal in the Software without restriction, including without limitation
011: * the rights to use, copy, modify, merge, publish, distribute, sublicense,
012: * and/or sell copies of the Software, and to permit persons to whom the
013: * Software is furnished to do so, subject to the following conditions:
014: *
015: * The above copyright notice and this permission notice shall be included in
016: * all copies or substantial portions of the Software.
017: *
018: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
019: * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
020: * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
021: * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
022: * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
023: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
024: * DEALINGS IN THE SOFTWARE.
025: */
026:
027: package net.sourceforge.groboutils.uicapture.v1;
028:
029: import java.awt.image.BufferedImage;
030:
031: import java.io.File;
032: import java.io.IOException;
033:
034: import java.util.Iterator;
035:
036: import javax.imageio.ImageIO;
037:
038: import org.apache.log4j.Logger;
039:
040: /**
041: * Writes images to files using the <tt>javax.imageio</tt> package.
042: *
043: * @author Matt Albrecht <a href="mailto:groboclown@users.sourceforge.net">groboclown@users.sourceforge.net</a>
044: * @version Jan 7, 2002
045: */
046: public class DefaultScreenScraper implements IScreenScraper {
047: private static final Logger LOG = Logger
048: .getLogger(DefaultScreenScraper.class);
049: private String writerFormatName = null;
050:
051: private static final boolean DEBUG = true;
052:
053: //-------------------------------------------------------------------------
054: // Constructors
055:
056: /**
057: * Find the first writer format name we come across.
058: *
059: * @exception IllegalArgumentException thrown if there are no formats
060: * supported.
061: */
062: public DefaultScreenScraper() {
063: String[] names = ImageIO.getWriterFormatNames();
064: if (names == null || names.length <= 0) {
065: throw new IllegalArgumentException(
066: "No writer format names supported.");
067: }
068:
069: this .writerFormatName = names[0];
070:
071: for (int i = 0; i < names.length; ++i) {
072: LOG.debug("Writer format found: " + names[i]);
073: }
074:
075: assertFormatName();
076: }
077:
078: /**
079: * Use the given writerFormatName to write images to disk.
080: *
081: * @exception IllegalArgumentException thrown if the given name is not
082: * supported.
083: */
084: public DefaultScreenScraper(String writerFormatName) {
085: this .writerFormatName = writerFormatName;
086:
087: assertFormatName();
088: }
089:
090: //-------------------------------------------------------------------------
091: // Public methods
092:
093: /**
094: * Write the given image to the given file.
095: *
096: * @param image The screen image to write to disk.
097: * @param file The File to save the image as.
098: * @exception IOException thrown if there was a problem saving the image to
099: * the file.
100: * @exception IllegalArgumentException if any parameter is <tt>null</tt>.
101: * @exception IllegalStateException if no appropriate writer could be found.
102: */
103: public void writeImageToFile(BufferedImage image, File file)
104: throws IOException {
105: boolean result = ImageIO.write(image, this .writerFormatName,
106: file);
107: if (!result) {
108: throw new IllegalStateException(
109: "No appropriate writer was found.");
110: }
111: }
112:
113: /**
114: * Discover the file extention for images created by this scraper.
115: * This does not include a '.'.
116: *
117: * @return the extention for files this scraper writes.
118: */
119: public String getFileExtention() {
120: return this .writerFormatName;
121: }
122:
123: //-------------------------------------------------------------------------
124: // Protected methods
125:
126: /**
127: * Discover if the current format name is supported.
128: *
129: * @exception IllegalArgumentException thrown if the current name is not
130: * supported.
131: */
132: protected void assertFormatName() {
133: Iterator iter = ImageIO
134: .getImageWritersByFormatName(this .writerFormatName);
135: if (iter == null || !iter.hasNext()) {
136: throw new IllegalArgumentException(
137: "Image Format "
138: + this .writerFormatName
139: + " is not supported in the current runtime system.");
140: }
141: }
142: }
|