freemarker-core/src/main/java/freemarker/template/TemplateNodeModelEx.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package freemarker.template;

/**
 * A {@link TemplateNodeModel} that supports navigating to the previous and next sibling nodes.
 * 
 * @since 2.3.26
 */
public interface TemplateNodeModelEx extends TemplateNodeModel {

    /**
     * @return The immediate previous sibling of this node, or {@code null} if there's no such node.
     */
    TemplateNodeModelEx getPreviousSibling() throws TemplateModelException;

    /**
     * @return The immediate next sibling of this node, or {@code null} if there's no such node.
     */
    TemplateNodeModelEx getNextSibling() throws TemplateModelException;
}