IRootAssemblyNodeItem.java
/*
* Portions of this software was developed by employees of the National Institute
* of Standards and Technology (NIST), an agency of the Federal Government and is
* being made available as a public service. Pursuant to title 17 United States
* Code Section 105, works of NIST employees are not subject to copyright
* protection in the United States. This software may be subject to foreign
* copyright. Permission in the United States and in foreign countries, to the
* extent that NIST may hold copyright, to use, copy, modify, create derivative
* works, and distribute this software and its documentation without fee is hereby
* granted on a non-exclusive basis, provided that this notice and disclaimer
* of warranty appears in all copies.
*
* THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
* EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
* THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
* INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
* SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
* SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
* INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
* OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
* CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
* PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
* OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
*/
package gov.nist.secauto.metaschema.core.metapath.item.node;
import gov.nist.secauto.metaschema.core.metapath.format.IPathFormatter;
import gov.nist.secauto.metaschema.core.model.IAssemblyInstance;
import gov.nist.secauto.metaschema.core.util.ObjectUtils;
import edu.umd.cs.findbugs.annotations.NonNull;
/**
* A marker interface used to expose root node functionality for an assembly
* node that has root information.
*/
public interface IRootAssemblyNodeItem extends IAssemblyNodeItem {
/**
* Get the name of this node.
* <p>
* This overrides the default behavior using the root name for the assembly.
*/
@Override
default String getName() {
return ObjectUtils.requireNonNull(getDefinition().getRootName());
}
/**
* Get the parent document node item for this root.
*
* @return the parent document item
*/
@NonNull
IDocumentNodeItem getDocumentNodeItem();
@Override
@NonNull
default IDocumentNodeItem getParentNodeItem() {
return getDocumentNodeItem();
}
@Override
default IAssemblyNodeItem getParentContentNodeItem() {
// there is no assembly parent
return null;
}
@Override
default IAssemblyInstance getInstance() {
// there is no instance
return null;
}
@Override
default IRootAssemblyNodeItem getNodeItem() {
return this;
}
@Override
default int getPosition() {
// a root is always in the first position
return 1;
}
@Override
default String format(@NonNull IPathFormatter formatter) {
return formatter.formatRootAssembly(this);
}
}