001/*
002 * $RCSfile: ChannelImageOutputStreamSpi.java,v $
003 *
004 * 
005 * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
006 * 
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met: 
010 * 
011 * - Redistribution of source code must retain the above copyright 
012 *   notice, this  list of conditions and the following disclaimer.
013 * 
014 * - Redistribution in binary form must reproduce the above copyright
015 *   notice, this list of conditions and the following disclaimer in 
016 *   the documentation and/or other materials provided with the
017 *   distribution.
018 * 
019 * Neither the name of Sun Microsystems, Inc. or the names of 
020 * contributors may be used to endorse or promote products derived 
021 * from this software without specific prior written permission.
022 * 
023 * This software is provided "AS IS," without a warranty of any 
024 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
025 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
026 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
027 * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
028 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
029 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
030 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
031 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
032 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
033 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
034 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
035 * POSSIBILITY OF SUCH DAMAGES. 
036 * 
037 * You acknowledge that this software is not designed or intended for 
038 * use in the design, construction, operation or maintenance of any 
039 * nuclear facility. 
040 *
041 * $Revision: 1.1 $
042 * $Date: 2005/02/11 05:01:53 $
043 * $State: Exp $
044 */
045package com.github.jaiimageio.impl.stream;
046
047import java.io.File;
048import java.io.IOException;
049import java.io.OutputStream;
050import java.nio.channels.Channels;
051import java.nio.channels.FileChannel;
052import java.nio.channels.NonReadableChannelException;
053import java.nio.channels.WritableByteChannel;
054import java.util.Locale;
055
056import javax.imageio.spi.ImageOutputStreamSpi;
057import javax.imageio.stream.FileCacheImageOutputStream;
058import javax.imageio.stream.ImageOutputStream;
059import javax.imageio.stream.MemoryCacheImageOutputStream;
060
061import com.github.jaiimageio.impl.common.PackageUtil;
062import com.github.jaiimageio.stream.FileChannelImageOutputStream;
063
064public class ChannelImageOutputStreamSpi extends ImageOutputStreamSpi {
065    public ChannelImageOutputStreamSpi() {
066        super(PackageUtil.getVendor(),
067              PackageUtil.getVersion(),
068              WritableByteChannel.class);
069    }
070
071    public ImageOutputStream createOutputStreamInstance(Object output,
072                                                        boolean useCache,
073                                                        File cacheDir)
074        throws IOException {
075
076        if(output == null ||
077           !(output instanceof WritableByteChannel)) {
078            throw new IllegalArgumentException
079                ("Cannot create ImageOutputStream from "+
080                 output.getClass().getName());
081        }
082
083        ImageOutputStream stream = null;
084
085        if(output instanceof FileChannel) {
086            FileChannel channel = (FileChannel)output;
087            try {
088                // The Channel must be readable.
089                channel.map(FileChannel.MapMode.READ_ONLY,
090                            channel.position(),
091                            1);
092                stream = new FileChannelImageOutputStream((FileChannel)output);
093            } catch(NonReadableChannelException nrce) {
094                // Ignore it.
095            }
096        }
097
098        if(stream == null) {
099            OutputStream outStream =
100                Channels.newOutputStream((WritableByteChannel)output);
101
102            if(useCache) {
103                try {
104                    stream = new FileCacheImageOutputStream(outStream,
105                                                            cacheDir);
106                } catch(IOException e) {
107                    // Cache file could not be created.
108                }
109            }
110
111            if(stream == null) {
112                stream = new MemoryCacheImageOutputStream(outStream);
113            }
114        }
115
116        return stream;
117    }
118
119    public String getDescription(Locale locale) {
120        return "NIO Channel ImageOutputStream";
121    }
122}