001 /* JobKOctets.java --
002 Copyright (C) 2003, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package javax.print.attribute.standard;
039
040 import javax.print.attribute.Attribute;
041 import javax.print.attribute.IntegerSyntax;
042 import javax.print.attribute.PrintJobAttribute;
043 import javax.print.attribute.PrintRequestAttribute;
044
045 /**
046 * The <code>JobKOctets</code> printing attribute specifies
047 * the total size of all the documents of a print job in K octets.
048 * <p>
049 * The supplied value has to be rounded up, so that a range between
050 * 1 and 1024 octects is specified as 1 and a range between 1025 and
051 * 2048 octects as 2, etc. This attribute must not include a multiplication
052 * factor from the number of copies which maybe specified in a Copies
053 * attribute.
054 * </p>
055 * <p>
056 * This attribute belongs to a group of job size attributes which are
057 * describing the size of a job to be printed. The values supplied by
058 * these attributes are intended to be used for routing and scheduling
059 * of jobs on the print service. A client may specify these attributes.
060 * If a clients supplies these attributes a print service may change
061 * the values if its be able to compute a more accurate value at the
062 * time of the job submission or also later.
063 * </p>
064 * <p>
065 * <b>IPP Compatibility:</b> JobKOctets is an IPP 1.1 attribute.
066 * </p>
067 * @see javax.print.attribute.standard.JobMediaSheets
068 * @see javax.print.attribute.standard.JobImpressions
069 *
070 * @author Michael Koch
071 */
072 public final class JobKOctets extends IntegerSyntax
073 implements PrintJobAttribute, PrintRequestAttribute
074 {
075 private static final long serialVersionUID = -8959710146498202869L;
076
077 /**
078 * Creates a <code>JobKOctets</code> object.
079 * The value is in units of K (1024) octets rounded up to the next highest K.
080 *
081 * @param value the number of K octets
082 *
083 * @exception IllegalArgumentException if value < 0
084 */
085 public JobKOctets(int value)
086 {
087 super(value);
088
089 if (value < 0)
090 throw new IllegalArgumentException("value may not be less than 0");
091 }
092
093 /**
094 * Tests if the given object is equal to this object.
095 *
096 * @param obj the object to test
097 *
098 * @return <code>true</code> if both objects are equal,
099 * <code>false</code> otherwise.
100 */
101 public boolean equals(Object obj)
102 {
103 if(! (obj instanceof JobKOctets))
104 return false;
105
106 return super.equals(obj);
107 }
108
109 /**
110 * Returns category of this class.
111 *
112 * @return The class <code>JobKOctets</code> itself.
113 */
114 public Class< ? extends Attribute> getCategory()
115 {
116 return JobKOctets.class;
117 }
118
119 /**
120 * Returns the name of this attribute.
121 *
122 * @return The name "job-k-octets".
123 */
124 public String getName()
125 {
126 return "job-k-octets";
127 }
128 }