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.format;
28
29 import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
30
31 import java.util.List;
32 import java.util.stream.Collectors;
33 import java.util.stream.Stream;
34
35 import edu.umd.cs.findbugs.annotations.NonNull;
36
37 /**
38 * A named segment of a path that can be formatted.
39 */
40 public interface IPathSegment {
41 /**
42 * Get the path for this node item using the provided formatter.
43 *
44 * @param formatter
45 * the path formatter to use to produce the path
46 *
47 * @return the formatted path
48 */
49 @NonNull
50 default String toPath(@NonNull IPathFormatter formatter) {
51 return formatter.format(this);
52 }
53
54 /**
55 * Apply formatting for the path segment. This is a visitor pattern that will be
56 * called to format each segment in a larger path.
57 *
58 * @param formatter
59 * the path formatter
60 * @return a textual representation of the path segment
61 */
62 @NonNull
63 String format(@NonNull IPathFormatter formatter);
64
65 /**
66 * Get a list of path segments, starting at the root and descending.
67 *
68 * @return a list of path segments in descending order
69 */
70 @SuppressWarnings("null")
71 @NonNull
72 default List<IPathSegment> getPath() {
73 return getPathStream().collect(Collectors.toUnmodifiableList());
74 }
75
76 /**
77 * Get a stream of path segments, starting at the root and descending.
78 *
79 * @return a stream of path segments in descending order
80 */
81 @NonNull
82 Stream<? extends IPathSegment> getPathStream();
83
84 /**
85 * Get the value associated with the path segment.
86 *
87 * @return the value or {@code} if no value is associated with this path segment
88 */
89 INodeItem getNodeItem();
90 }