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