1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.core.metapath.item.atomic;
28
29 import gov.nist.secauto.metaschema.core.datatype.IDataTypeAdapter;
30 import gov.nist.secauto.metaschema.core.metapath.item.IAtomicValuedItem;
31 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34
35 public interface IAnyAtomicItem extends IAtomicValuedItem {
36
37 @Override
38 @NonNull
39 default IAnyAtomicItem toAtomicItem() {
40 return this;
41 }
42
43 @Override
44 @NonNull
45 Object getValue();
46
47 /**
48 * Get the item's string value.
49 *
50 * @return the string value value of the item
51 */
52 @NonNull
53 default String asString() {
54 return ObjectUtils.notNull(getValue().toString());
55 }
56
57 /**
58 * Get a new {@link IStringItem} based on the the textual value of the item's
59 * "wrapped" value.
60 *
61 * @return a new string item
62 */
63 // TODO: rename to asStringItem
64 @NonNull
65 default IStringItem newStringItem() {
66 return IStringItem.valueOf(asString());
67 }
68
69 /**
70 * Get the item's type adapter.
71 *
72 * @return the type adapter for the item
73 */
74 @NonNull
75 IDataTypeAdapter<?> getJavaTypeAdapter();
76 //
77 // <T extends IValuedItem> T cast(IValuedItem item);
78 }