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