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.format; 028 029import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem; 030 031import java.util.List; 032import java.util.stream.Collectors; 033import java.util.stream.Stream; 034 035import edu.umd.cs.findbugs.annotations.NonNull; 036 037/** 038 * A named segment of a path that can be formatted. 039 */ 040public interface IPathSegment { 041 /** 042 * Get the path for this node item using the provided formatter. 043 * 044 * @param formatter 045 * the path formatter to use to produce the path 046 * 047 * @return the formatted path 048 */ 049 @NonNull 050 default String toPath(@NonNull IPathFormatter formatter) { 051 return formatter.format(this); 052 } 053 054 /** 055 * Apply formatting for the path segment. This is a visitor pattern that will be 056 * called to format each segment in a larger path. 057 * 058 * @param formatter 059 * the path formatter 060 * @return a textual representation of the path segment 061 */ 062 @NonNull 063 String format(@NonNull IPathFormatter formatter); 064 065 /** 066 * Get a list of path segments, starting at the root and descending. 067 * 068 * @return a list of path segments in descending order 069 */ 070 @SuppressWarnings("null") 071 @NonNull 072 default List<IPathSegment> getPath() { 073 return getPathStream().collect(Collectors.toUnmodifiableList()); 074 } 075 076 /** 077 * Get a stream of path segments, starting at the root and descending. 078 * 079 * @return a stream of path segments in descending order 080 */ 081 @NonNull 082 Stream<? extends IPathSegment> getPathStream(); 083 084 /** 085 * Get the value associated with the path segment. 086 * 087 * @return the value or {@code} if no value is associated with this path segment 088 */ 089 INodeItem getNodeItem(); 090}