libjava/classpath/javax/print/attribute/standard/JobHoldUntil.java

   1 /* JobHoldUntil.java --
   2    Copyright (C) 2004, 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.print.attribute.standard;
  40
  41 import java.util.Date;
  42
  43 import javax.print.attribute.DateTimeSyntax;
  44 import javax.print.attribute.PrintJobAttribute;
  45 import javax.print.attribute.PrintRequestAttribute;
  46
  47 /**
  48  * The <code>JobHoldUntil</code> attribute specifies the date
  49  * and the time at which a print job must become a candidate
  50  * for printing.
  51  * <p>
  52  * <b>IPP Compatibility:</b> JobHoldUntil is an IPP 1.1 attribute.
  53  * However the attribute in IPP is based on keywords of named
  54  * time periods like day-time or evening. It will depend on the
  55  * concrete implementation of a print service how a mapping of the
  56  * detailed provided date and time of this attribute to the named
  57  * keyword or an alternate extension attribute will be done. E.g.
  58  * CUPS supports also a HH:MM format as extension to the keywords.
  59  * </p>
  60  *
  61  * @author Michael Koch (konqueror@gmx.de)
  62  */
  63 public final class JobHoldUntil extends DateTimeSyntax
  64   implements PrintJobAttribute, PrintRequestAttribute
  65 {
  66   private static final long serialVersionUID = -1664471048860415024L;
  67
  68   /**
  69    * Creates a <code>JobHoldUntil</code> object.
  70    *
  71    * @param value the date to hold the job until
  72    *
  73    * @exception NullPointerException if value is null
  74    */
  75   public JobHoldUntil(Date value)
  76   {
  77     super(value);
  78   }
  79
  80   /**
  81    * Tests if the given object is equal to this object.
  82    *
  83    * @param obj the object to test
  84    *
  85    * @return <code>true</code> if both objects are equal,
  86    * <code>false</code> otherwise.
  87    */
  88   public boolean equals(Object obj)
  89   {
  90     if(! (obj instanceof JobHoldUntil))
  91       return false;
  92
  93     return super.equals(obj);
  94   }
  95
  96   /**
  97    * Returns category of this class.
  98    *
  99    * @return The class <code>JobHoldUntil</code> itself.
 100    */
 101   public Class getCategory()
 102   {
 103     return JobHoldUntil.class;
 104   }
 105
 106   /**
 107    * Returns the name of this attribute.
 108    *
 109    * @return The name "job-hold-until".
 110    */
 111   public String getName()
 112   {
 113     return "job-hold-until";
 114   }
 115 }