/*
 * Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.print.attribute;

import java.io.Serial;
import java.io.Serializable;
import java.util.Date;

Class DateTimeSyntax is an abstract base class providing the common implementation of all attributes whose value is a date and time.

Under the hood, a date-time attribute is stored as a value of class java.util.Date. You can get a date-time attribute's Date value by calling getValue(). A date-time attribute's Date value is established when it is constructed (see DateTimeSyntax(Date)). Once constructed, a date-time attribute's value is immutable.

To construct a date-time attribute from separate values of the year, month, day, hour, minute, and so on, use a java.util.Calendar object to construct a java.util.Date object, then use the java.util.Date object to construct the date-time attribute. To convert a date-time attribute to separate values of the year, month, day, hour, minute, and so on, create a java.util.Calendar object and set it to the java.util.Date from the date-time attribute. Class DateTimeSyntax stores its value in the form of a java.util.Date rather than a java.util.Calendar because it typically takes less memory to store and less time to compare a java.util.Date than a java.util.Calendar.

Author:Alan Kaminsky
/** * Class {@code DateTimeSyntax} is an abstract base class providing the common * implementation of all attributes whose value is a date and time. * <p> * Under the hood, a date-time attribute is stored as a value of class * {@code java.util.Date}. You can get a date-time attribute's {@code Date} * value by calling {@link #getValue() getValue()}. A date-time attribute's * {@code Date} value is established when it is constructed (see * {@link #DateTimeSyntax(Date) DateTimeSyntax(Date)}). Once constructed, a * date-time attribute's value is immutable. * <p> * To construct a date-time attribute from separate values of the year, month, * day, hour, minute, and so on, use a {@code java.util.Calendar} object to * construct a {@code java.util.Date} object, then use the * {@code java.util.Date} object to construct the date-time attribute. To * convert a date-time attribute to separate values of the year, month, day, * hour, minute, and so on, create a {@code java.util.Calendar} object and set * it to the {@code java.util.Date} from the date-time attribute. Class * {@code DateTimeSyntax} stores its value in the form of a * {@code java.util.Date} rather than a {@code java.util.Calendar} because it * typically takes less memory to store and less time to compare a * {@code java.util.Date} than a {@code java.util.Calendar}. * * @author Alan Kaminsky */
public abstract class DateTimeSyntax implements Serializable, Cloneable {
Use serialVersionUID from JDK 1.4 for interoperability.
/** * Use serialVersionUID from JDK 1.4 for interoperability. */
@Serial private static final long serialVersionUID = -1400819079791208582L; // Hidden data members.
This date-time attribute's java.util.Date value.
@serial
/** * This date-time attribute's {@code java.util.Date} value. * * @serial */
private Date value; // Hidden constructors.
Construct a new date-time attribute with the given java.util.Date value.
Params:
  • value – java.util.Date value
Throws:
/** * Construct a new date-time attribute with the given {@code java.util.Date} * value. * * @param value {@code java.util.Date} value * @throws NullPointerException if {@code value} is {@code null} */
protected DateTimeSyntax(Date value) { if (value == null) { throw new NullPointerException("value is null"); } this.value = value; } // Exported operations.
Returns this date-time attribute's java.util.Date value.
Returns:the Date
/** * Returns this date-time attribute's {@code java.util.Date} value. * * @return the {@code Date} */
public Date getValue() { return new Date (value.getTime()); } // Exported operations inherited and overridden from class Object.
Returns whether this date-time attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:
  1. object is not null.
  2. object is an instance of class DateTimeSyntax.
  3. This date-time attribute's java.util.Date value and object's java.util.Date value are equal.
Params:
  • object – Object to compare to
Returns:true if object is equivalent to this date-time attribute, false otherwise
/** * Returns whether this date-time attribute is equivalent to the passed in * object. To be equivalent, all of the following conditions must be true: * <ol type=1> * <li>{@code object} is not {@code null}. * <li>{@code object} is an instance of class {@code DateTimeSyntax}. * <li>This date-time attribute's {@code java.util.Date} value and * {@code object}'s {@code java.util.Date} value are equal. * </ol> * * @param object {@code Object} to compare to * @return {@code true} if {@code object} is equivalent to this date-time * attribute, {@code false} otherwise */
public boolean equals(Object object) { return (object != null && object instanceof DateTimeSyntax && value.equals(((DateTimeSyntax) object).value)); }
Returns a hash code value for this date-time attribute. The hashcode is that of this attribute's java.util.Date value.
/** * Returns a hash code value for this date-time attribute. The hashcode is * that of this attribute's {@code java.util.Date} value. */
public int hashCode() { return value.hashCode(); }
Returns a string value corresponding to this date-time attribute. The string value is just this attribute's java.util.Date value converted to a string.
/** * Returns a string value corresponding to this date-time attribute. The * string value is just this attribute's {@code java.util.Date} value * converted to a string. */
public String toString() { return "" + value; } }