AbstractAmbiguousTemporal.java
/*
* Portions of this software was developed by employees of the National Institute
* of Standards and Technology (NIST), an agency of the Federal Government and is
* being made available as a public service. Pursuant to title 17 United States
* Code Section 105, works of NIST employees are not subject to copyright
* protection in the United States. This software may be subject to foreign
* copyright. Permission in the United States and in foreign countries, to the
* extent that NIST may hold copyright, to use, copy, modify, create derivative
* works, and distribute this software and its documentation without fee is hereby
* granted on a non-exclusive basis, provided that this notice and disclaimer
* of warranty appears in all copies.
*
* THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
* EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
* THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
* INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
* SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
* SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
* INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
* OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
* CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
* PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
* OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
*/
package gov.nist.secauto.metaschema.core.datatype.object;
import gov.nist.secauto.metaschema.core.datatype.AbstractCustomJavaDataType;
import java.time.ZonedDateTime;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* Metaschema has a need to represent dates and times that allow for an
* ambiguous time zone. This is due to some models not requiring a time zone as
* part of a date/time. An ambiguous dateTime allows a time zone to be inferred,
* without change information in the source content.
* <p>
* This class wraps a ZonedDateTime object and tracks if a time zone was found
* when parsing, which can be used to ensure that the assumed time zone is not
* written back out in such cases.
*
* @param <TYPE>
* the bound object type
*/
public abstract class AbstractAmbiguousTemporal<TYPE extends AbstractAmbiguousTemporal<TYPE>>
extends AbstractCustomJavaDataType<TYPE, ZonedDateTime> {
private final boolean timeZone;
/**
* Construct a new object. This type supports ambiguous dates/times that were
* provided without a time zone.
*
* @param value
* the date value
* @param hasTimeZone
* {@code true} if the date is intended to have an associated time zone
* or {@code false} otherwise
*/
public AbstractAmbiguousTemporal(@NonNull ZonedDateTime value, boolean hasTimeZone) {
super(value);
this.timeZone = hasTimeZone;
}
/**
* Indicate if a time zone is configured.
*
* @return {@code true} if the date is intended to have an associated time zone
* or {@code false} otherwise
*/
public boolean hasTimeZone() {
return timeZone;
}
}