001/* JobKOctetsProcessed.java -- 
002   Copyright (C) 2003, 2004, 2005 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;
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 */
064public 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 &lt; 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}