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 edu.umd.cs.findbugs.annotations.NonNull;
030
031/**
032 * Provides a set of callbacks used when iterating over node items in a directed
033 * graph.
034 * <p>
035 * The {@link AbstractNodeItemVisitor} provides an abstract implementation of
036 * this visitor pattern.
037 *
038 * @param <RESULT>
039 *          the type of result produced by visitation
040 * @param <CONTEXT>
041 *          the type of data to pass to each visited node
042 * @see AbstractNodeItemVisitor
043 */
044public interface INodeItemVisitor<RESULT, CONTEXT> {
045  /**
046   * This callback is called when the {@link IDocumentNodeItem} is visited.
047   *
048   * @param item
049   *          the visited item
050   * @param context
051   *          provides contextual information for use by the visitor
052   * @return the visitation result
053   */
054  RESULT visitDocument(@NonNull IDocumentNodeItem item, CONTEXT context);
055
056  /**
057   * This callback is called when an {@link IFlagNodeItem} is visited.
058   *
059   * @param item
060   *          the visited item
061   * @param context
062   *          provides contextual information for use by the visitor
063   * @return the visitation result
064   */
065  RESULT visitFlag(@NonNull IFlagNodeItem item, CONTEXT context);
066
067  /**
068   * This callback is called when an {@link IFieldNodeItem} is visited.
069   *
070   * @param item
071   *          the visited item
072   * @param context
073   *          provides contextual information for use by the visitor
074   * @return the visitation result
075   */
076  RESULT visitField(@NonNull IFieldNodeItem item, CONTEXT context);
077
078  /**
079   * This callback is called when an {@link IAssemblyNodeItem} is visited.
080   *
081   * @param item
082   *          the visited item
083   * @param context
084   *          provides contextual information for use by the visitor
085   * @return the visitation result
086   */
087  RESULT visitAssembly(@NonNull IAssemblyNodeItem item, CONTEXT context);
088
089  /**
090   * This callback is called when an {@link IModuleNodeItem} is visited.
091   *
092   * @param item
093   *          the visited item
094   * @param context
095   *          provides contextual information for use by the visitor
096   * @return the visitation result
097   */
098  RESULT visitMetaschema(@NonNull IModuleNodeItem item, CONTEXT context);
099}