001    /* JobImpressionsCompleted.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>JobImpressionsCompleted</code> printing attribute reports
046     * the number of impressions already processed.
047     * <p>
048     * An impression is specified by the IPP specification as the image imposed 
049     * onto a single media sheet. This attribute will not include a multiplication 
050     * factor from the number 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> JobImpressionsCompleted is an IPP 1.1 attribute.
058     * </p>
059     * @see javax.print.attribute.standard.JobMediaSheetsCompleted
060     * @see javax.print.attribute.standard.JobKOctetsProcessed
061     * 
062     * @author Michael Koch (konqueror@gmx.de)
063     */
064    public final class JobImpressionsCompleted extends IntegerSyntax
065      implements PrintJobAttribute
066    {
067      private static final long serialVersionUID = 6722648442432393294L;
068      
069      /**
070       * Creates a <code>JobImpressionsCompleted</code> object.
071       *
072       * @param value the number of completed impressions
073       *
074       * @exception IllegalArgumentException if value &lt; 0
075       */
076      public JobImpressionsCompleted(int value)
077      {
078        super(value);
079    
080        if (value < 0)
081          throw new IllegalArgumentException("value may not be less than 0");
082      }
083      
084      /**
085       * Tests if the given object is equal to this object.
086       *
087       * @param obj the object to test
088       *
089       * @return <code>true</code> if both objects are equal, 
090       * <code>false</code> otherwise.
091       */
092      public boolean equals(Object obj)
093      {
094        if(! (obj instanceof JobImpressionsCompleted))
095          return false;
096    
097        return super.equals(obj);
098      }
099    
100      /**
101       * Returns category of this class.
102       *
103       * @return The class <code>JobImpressionsCompleted</code> itself.
104       */
105      public Class< ? extends Attribute> getCategory()
106      {
107        return JobImpressionsCompleted.class;
108      }
109    
110      /**
111       * Returns the name of this attribute.
112       *
113       * @return The name "job-impressions-completed".
114       */
115      public String getName()
116      {
117        return "job-impressions-completed";
118      }
119    }