001/*
002 * $RCSfile: PNMImageWriteParam.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:16 $
043 * $State: Exp $
044 */
045package com.github.jaiimageio.plugins.pnm;
046
047import javax.imageio.ImageWriteParam;
048
049/**
050 * A subclass of <code>ImageWriteParam</code> for writing images in
051 * the PNM format.
052 *
053 * <p> This class allows for the specification of whether to write
054 * in the ASCII or raw variants of the PBM, PGM, and PPM formats;
055 * by default, the raw variant is used.
056 */
057public class PNMImageWriteParam extends ImageWriteParam {
058
059    private boolean raw = true;
060
061    /**
062     * Constructs a <code>PNMImageWriteParam</code> object with default values
063     * for parameters.
064     */
065    public PNMImageWriteParam() {}
066
067    /**
068     * Sets the representation to be used.  If the <code>raw</code>
069     * parameter is <code>true</code>, the raw representation will be used;
070     * otherwise the ASCII representation will be used.
071     *
072     * @param raw <code>true</code> if raw format is to be used.
073     * @see #getRaw()
074     */
075    public void setRaw(boolean raw) {
076        this.raw = raw;
077    }
078
079    /**
080     * Returns the value of the <code>raw</code> parameter.  The default
081     * value is <code>true</code>.
082     *
083     * @return whether the data are written in raw representation.
084     * @see #setRaw(boolean)
085     */
086    public boolean getRaw() {
087        return raw;
088    }
089}