01: /*
02: * $RCSfile: PNMImageWriteParam.java,v $
03: *
04: *
05: * Copyright (c) 2005 Sun Microsystems, Inc. All Rights Reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions
09: * are met:
10: *
11: * - Redistribution of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: *
14: * - Redistribution in binary form must reproduce the above copyright
15: * notice, this list of conditions and the following disclaimer in
16: * the documentation and/or other materials provided with the
17: * distribution.
18: *
19: * Neither the name of Sun Microsystems, Inc. or the names of
20: * contributors may be used to endorse or promote products derived
21: * from this software without specific prior written permission.
22: *
23: * This software is provided "AS IS," without a warranty of any
24: * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
25: * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
26: * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
27: * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
28: * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
29: * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
30: * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
31: * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
32: * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
33: * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
34: * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
35: * POSSIBILITY OF SUCH DAMAGES.
36: *
37: * You acknowledge that this software is not designed or intended for
38: * use in the design, construction, operation or maintenance of any
39: * nuclear facility.
40: *
41: * $Revision: 1.1 $
42: * $Date: 2005/02/11 05:01:16 $
43: * $State: Exp $
44: */
45: package com.sun.media.imageio.plugins.pnm;
46:
47: import javax.imageio.ImageWriteParam;
48:
49: /**
50: * A subclass of <code>ImageWriteParam</code> for writing images in
51: * the PNM format.
52: *
53: * <p> This class allows for the specification of whether to write
54: * in the ASCII or raw variants of the PBM, PGM, and PPM formats;
55: * by default, the raw variant is used.
56: */
57: public class PNMImageWriteParam extends ImageWriteParam {
58:
59: private boolean raw = true;
60:
61: /**
62: * Constructs a <code>PNMImageWriteParam</code> object with default values
63: * for parameters.
64: */
65: public PNMImageWriteParam() {
66: }
67:
68: /**
69: * Sets the representation to be used. If the <code>raw</code>
70: * parameter is <code>true</code>, the raw representation will be used;
71: * otherwise the ASCII representation will be used.
72: *
73: * @param raw <code>true</code> if raw format is to be used.
74: * @see #getRaw()
75: */
76: public void setRaw(boolean raw) {
77: this .raw = raw;
78: }
79:
80: /**
81: * Returns the value of the <code>raw</code> parameter. The default
82: * value is <code>true</code>.
83: *
84: * @return whether the data are written in raw representation.
85: * @see #setRaw(boolean)
86: */
87: public boolean getRaw() {
88: return raw;
89: }
90: }
|