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.model.IAssemblyInstance; 031import gov.nist.secauto.metaschema.core.util.ObjectUtils; 032 033import edu.umd.cs.findbugs.annotations.NonNull; 034 035/** 036 * A marker interface used to expose root node functionality for an assembly 037 * node that has root information. 038 */ 039public interface IRootAssemblyNodeItem extends IAssemblyNodeItem { 040 041 /** 042 * Get the name of this node. 043 * <p> 044 * This overrides the default behavior using the root name for the assembly. 045 */ 046 @Override 047 default String getName() { 048 return ObjectUtils.requireNonNull(getDefinition().getRootName()); 049 } 050 051 /** 052 * Get the parent document node item for this root. 053 * 054 * @return the parent document item 055 */ 056 @NonNull 057 IDocumentNodeItem getDocumentNodeItem(); 058 059 @Override 060 @NonNull 061 default IDocumentNodeItem getParentNodeItem() { 062 return getDocumentNodeItem(); 063 } 064 065 @Override 066 default IAssemblyNodeItem getParentContentNodeItem() { 067 // there is no assembly parent 068 return null; 069 } 070 071 @Override 072 default IAssemblyInstance getInstance() { 073 // there is no instance 074 return null; 075 } 076 077 @Override 078 default IRootAssemblyNodeItem getNodeItem() { 079 return this; 080 } 081 082 @Override 083 default int getPosition() { 084 // a root is always in the first position 085 return 1; 086 } 087 088 @Override 089 default String format(@NonNull IPathFormatter formatter) { 090 return formatter.formatRootAssembly(this); 091 } 092}