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;
028
029import gov.nist.secauto.metaschema.core.util.ObjectUtils;
030
031import java.util.Objects;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035/**
036 * A common base implementation of a custom Java object providing an underlying
037 * implementation of a data type.
038 *
039 * @param <TYPE>
040 *          the bound object type supported by this data type
041 * @param <VALUE>
042 *          the inner value of the data type object
043 */
044public abstract class AbstractCustomJavaDataType<TYPE extends ICustomJavaDataType<TYPE>, VALUE>
045    implements ICustomJavaDataType<TYPE> {
046  @NonNull
047  private final VALUE value;
048
049  /**
050   * Construct a new instance of a custom Java object-based data value.
051   *
052   * @param value
053   *          the bound object that the data type is based on
054   */
055  protected AbstractCustomJavaDataType(@NonNull VALUE value) {
056    this.value = ObjectUtils.requireNonNull(value, "value");
057  }
058
059  /**
060   * Get the bound Java object value.
061   *
062   * @return the bound object
063   */
064  @NonNull
065  public VALUE getValue() {
066    return value;
067  }
068  //
069  // public void setValue(T value) {
070  // this.value = value;
071  // }
072
073  @Override
074  public int hashCode() {
075    return value.hashCode();
076  }
077
078  @Override
079  public boolean equals(Object obj) {
080    return Objects.equals(value, obj);
081  }
082
083  @Override
084  public String toString() {
085    return value.toString();
086  }
087}