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.metapath.item.atomic;
028
029import gov.nist.secauto.metaschema.core.datatype.IDataTypeAdapter;
030import gov.nist.secauto.metaschema.core.metapath.item.IAtomicValuedItem;
031import gov.nist.secauto.metaschema.core.util.ObjectUtils;
032
033import edu.umd.cs.findbugs.annotations.NonNull;
034
035public interface IAnyAtomicItem extends IAtomicValuedItem {
036
037  @Override
038  @NonNull
039  default IAnyAtomicItem toAtomicItem() {
040    return this;
041  }
042
043  @Override
044  @NonNull
045  Object getValue();
046
047  /**
048   * Get the item's string value.
049   *
050   * @return the string value value of the item
051   */
052  @NonNull
053  default String asString() {
054    return ObjectUtils.notNull(getValue().toString());
055  }
056
057  /**
058   * Get a new {@link IStringItem} based on the the textual value of the item's
059   * "wrapped" value.
060   *
061   * @return a new string item
062   */
063  // TODO: rename to asStringItem
064  @NonNull
065  default IStringItem newStringItem() {
066    return IStringItem.valueOf(asString());
067  }
068
069  /**
070   * Get the item's type adapter.
071   *
072   * @return the type adapter for the item
073   */
074  @NonNull
075  IDataTypeAdapter<?> getJavaTypeAdapter();
076  //
077  // <T extends IValuedItem> T cast(IValuedItem item);
078}