001 /* JobKOctetsProcessed.java -- 002 Copyright (C) 2003, 2004, 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 044 /** 045 * The <code>JobKOctetsProcessed</code> printing attribute reports 046 * the total number of octets already processed in K octets units. 047 * <p> 048 * The supplied value will be rounded up to the next highest K octets. 049 * This attribute will not include a multiplication factor from the number 050 * of copies. 051 * </p> 052 * <p> 053 * This attribute belongs to a group of job progress attributes which are 054 * reporting on the progress of a print job. 055 * </p> 056 * <p> 057 * <b>IPP Compatibility:</b> JobKOctetsProcessed is an IPP 1.1 attribute. 058 * </p> 059 * @see javax.print.attribute.standard.JobMediaSheetsCompleted 060 * @see javax.print.attribute.standard.JobImpressionsCompleted 061 * 062 * @author Michael Koch 063 */ 064 public final class JobKOctetsProcessed extends IntegerSyntax 065 implements PrintJobAttribute 066 { 067 private static final long serialVersionUID = -6265238509657881806L; 068 069 /** 070 * Creates a <code>JobKOctetsProcessed</code> object. 071 * The value is in units of K (1024) octets rounded up to the next highest K. 072 * 073 * @param value the number of processed K octets 074 * 075 * @exception IllegalArgumentException if value < 0 076 */ 077 public JobKOctetsProcessed(int value) 078 { 079 super(value); 080 081 if (value < 0) 082 throw new IllegalArgumentException("value may not be less than 0"); 083 } 084 085 /** 086 * Tests if the given object is equal to this object. 087 * 088 * @param obj the object to test 089 * 090 * @return <code>true</code> if both objects are equal, 091 * <code>false</code> otherwise. 092 */ 093 public boolean equals(Object obj) 094 { 095 if(! (obj instanceof JobKOctetsProcessed)) 096 return false; 097 098 return super.equals(obj); 099 } 100 101 /** 102 * Returns category of this class. 103 * 104 * @return The class <code>JobKOctetsProcessed</code> itself. 105 */ 106 public Class< ? extends Attribute> getCategory() 107 { 108 return JobKOctetsProcessed.class; 109 } 110 111 /** 112 * Returns the name of this attribute. 113 * 114 * @return The name "job-k-octets-processed". 115 */ 116 public String getName() 117 { 118 return "job-k-octets-processed"; 119 } 120 }