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.node; 028 029import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter; 030import gov.nist.secauto.metaschema.core.metapath.item.IAtomicValuedItem; 031import gov.nist.secauto.metaschema.core.model.IFlagDefinition; 032import gov.nist.secauto.metaschema.core.model.IFlagInstance; 033 034import java.net.URI; 035import java.util.Collection; 036import java.util.Collections; 037import java.util.List; 038import java.util.stream.Stream; 039 040import edu.umd.cs.findbugs.annotations.NonNull; 041import edu.umd.cs.findbugs.annotations.Nullable; 042 043public interface IFlagNodeItem 044 extends IDefinitionNodeItem<IFlagDefinition, IFlagInstance>, IAtomicValuedItem { 045 @Override 046 default NodeItemType getNodeItemType() { 047 return NodeItemType.FLAG; 048 } 049 050 @Override 051 default IFlagNodeItem getNodeItem() { 052 return this; 053 } 054 055 @Override 056 IFlagDefinition getDefinition(); 057 058 @Override 059 IFlagInstance getInstance(); 060 061 @Override 062 @Nullable 063 default URI getBaseUri() { 064 INodeItem parent = getParentNodeItem(); 065 return parent == null ? null : parent.getBaseUri(); 066 } 067 068 /** 069 * FlagContainer do not have flag items. This call should return an empty 070 * collection. 071 */ 072 @SuppressWarnings("null") 073 @Override 074 default Collection<? extends IFlagNodeItem> getFlags() { 075 // a flag does not have flags 076 return Collections.emptyList(); 077 } 078 079 /** 080 * FlagContainer do not have flag items. This call should return {@code null}. 081 */ 082 @Override 083 default IFlagNodeItem getFlagByName(@NonNull String name) { 084 // a flag does not have flags 085 return null; 086 } 087 088 /** 089 * FlagContainer do not have flag items. This call should return an empty 090 * stream. 091 */ 092 @SuppressWarnings("null") 093 @Override 094 default @NonNull Stream<? extends IFlagNodeItem> flags() { 095 // a flag does not have flags 096 return Stream.empty(); 097 } 098 099 /** 100 * FlagContainer do not have model items. This call should return an empty 101 * collection. 102 */ 103 @SuppressWarnings("null") 104 @Override 105 default @NonNull Collection<? extends List<? extends IModelNodeItem<?, ?>>> getModelItems() { 106 // a flag does not have model items 107 return Collections.emptyList(); 108 } 109 110 /** 111 * FlagContainer do not have model items. This call should return an empty list. 112 */ 113 @SuppressWarnings("null") 114 @Override 115 default List<? extends IModelNodeItem<?, ?>> getModelItemsByName(String name) { 116 // a flag does not have model items 117 return Collections.emptyList(); 118 } 119 120 /** 121 * FlagContainer do not have model items. This call should return an empty 122 * stream. 123 */ 124 @SuppressWarnings("null") 125 @NonNull 126 @Override 127 default Stream<? extends IModelNodeItem<?, ?>> modelItems() { 128 // a flag does not have model items 129 return Stream.empty(); 130 } 131 132 @Override 133 default @NonNull String format(@NonNull IPathFormatter formatter) { 134 return formatter.formatFlag(this); 135 } 136 137 @Override 138 default <RESULT, CONTEXT> RESULT accept(@NonNull INodeItemVisitor<RESULT, CONTEXT> visitor, CONTEXT context) { 139 return visitor.visitFlag(this, context); 140 } 141}