1 /*
   2  * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package javax.print.attribute.standard;
  26 
  27 import java.util.Date;
  28 import javax.print.attribute.Attribute;
  29 import javax.print.attribute.DateTimeSyntax;
  30 import javax.print.attribute.PrintJobAttribute;
  31 
  32 /**
  33  * Class DateTimeAtCompleted is a printing attribute class, a date-time
  34  * attribute, that indicates the date and time at which the Print Job completed
  35  * (or was canceled or aborted).
  36  * <P>
  37  * To construct a DateTimeAtCompleted attribute from separate values of the
  38  * year, month, day, hour, minute, and so on, use a {@link java.util.Calendar
  39  * Calendar} object to construct a {@link java.util.Date Date} object, then use
  40  * the {@link java.util.Date Date} object to construct the DateTimeAtCompleted
  41  * attribute. To convert a DateTimeAtCompleted attribute to separate values of
  42  * the year, month, day, hour, minute, and so on, create a {@link
  43  * java.util.Calendar Calendar} object and set it to the {@link java.util.Date
  44  * Date} from the DateTimeAtCompleted attribute.
  45  * <P>
  46  * <B>IPP Compatibility:</B> The information needed to construct an IPP
  47  * "date-time-at-completed" attribute can be obtained as described above. The
  48  * category name returned by <CODE>getName()</CODE> gives the IPP attribute
  49  * name.
  50  * <P>
  51  *
  52  * @author  Alan Kaminsky
  53  */
  54 public final class DateTimeAtCompleted extends DateTimeSyntax
  55     implements PrintJobAttribute {
  56 
  57     private static final long serialVersionUID = 6497399708058490000L;
  58 
  59     /**
  60      * Construct a new date-time at completed attribute with the given {@link
  61      * java.util.Date Date} value.
  62      *
  63      * @param  dateTime  {@link java.util.Date Date} value.
  64      *
  65      * @exception  NullPointerException
  66      *     (unchecked exception) Thrown if <CODE>dateTime</CODE> is null.
  67      */
  68     public DateTimeAtCompleted(Date dateTime) {
  69         super (dateTime);
  70     }
  71 
  72     /**
  73      * Returns whether this date-time at completed attribute is equivalent to
  74      * the passed in object. To be equivalent, all of the following conditions
  75      * must be true:
  76      * <OL TYPE=1>
  77      * <LI>
  78      * <CODE>object</CODE> is not null.
  79      * <LI>
  80      * <CODE>object</CODE> is an instance of class DateTimeAtCompleted.
  81      * <LI>
  82      * This date-time at completed attribute's {@link java.util.Date Date} value
  83      * and <CODE>object</CODE>'s {@link java.util.Date Date} value are equal.
  84      * </OL>
  85      *
  86      * @param  object  Object to compare to.
  87      *
  88      * @return  True if <CODE>object</CODE> is equivalent to this date-time
  89      *          at completed attribute, false otherwise.
  90      */
  91     public boolean equals(Object object) {
  92         return(super.equals (object) &&
  93                object instanceof DateTimeAtCompleted);
  94     }
  95 
  96 // Exported operations inherited and implemented from interface Attribute.
  97 
  98     /**
  99      * Get the printing attribute class which is to be used as the "category"
 100      * for this printing attribute value.
 101          * <P>
 102          * For class DateTimeAtCompleted, the category is class
 103          * DateTimeAtCompleted itself.
 104          *
 105          * @return  Printing attribute class (category), an instance of class
 106          *          {@link java.lang.Class java.lang.Class}.
 107          */
 108     public final Class<? extends Attribute> getCategory() {
 109         return DateTimeAtCompleted.class;
 110     }
 111 
 112     /**
 113      * Get the name of the category of which this attribute value is an
 114      * instance.
 115      * <P>
 116      * For class DateTimeAtCompleted, the category name is
 117      * <CODE>"date-time-at-completed"</CODE>.
 118      *
 119      * @return  Attribute category name.
 120      */
 121     public final String getName() {
 122         return "date-time-at-completed";
 123     }
 124 
 125 }