001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.datatype.object;
028
029import gov.nist.secauto.metaschema.core.datatype.AbstractCustomJavaDataType;
030
031import java.time.ZonedDateTime;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035/**
036 * Metaschema has a need to represent dates and times that allow for an
037 * ambiguous time zone. This is due to some models not requiring a time zone as
038 * part of a date/time. An ambiguous dateTime allows a time zone to be inferred,
039 * without change information in the source content.
040 * <p>
041 * This class wraps a ZonedDateTime object and tracks if a time zone was found
042 * when parsing, which can be used to ensure that the assumed time zone is not
043 * written back out in such cases.
044 *
045 * @param <TYPE>
046 *          the bound object type
047 */
048public abstract class AbstractAmbiguousTemporal<TYPE extends AbstractAmbiguousTemporal<TYPE>>
049    extends AbstractCustomJavaDataType<TYPE, ZonedDateTime> {
050  private final boolean timeZone;
051
052  /**
053   * Construct a new object. This type supports ambiguous dates/times that were
054   * provided without a time zone.
055   *
056   * @param value
057   *          the date value
058   * @param hasTimeZone
059   *          {@code true} if the date is intended to have an associated time zone
060   *          or {@code false} otherwise
061   */
062  public AbstractAmbiguousTemporal(@NonNull ZonedDateTime value, boolean hasTimeZone) {
063    super(value);
064    this.timeZone = hasTimeZone;
065  }
066
067  /**
068   * Indicate if a time zone is configured.
069   *
070   * @return {@code true} if the date is intended to have an associated time zone
071   *         or {@code false} otherwise
072   */
073  public boolean hasTimeZone() {
074    return timeZone;
075  }
076}