org.apache.jackrabbit.vault.fs.io.DocViewAnalyzerListener Maven / Gradle / Ivy

/*
 * 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 org.apache.jackrabbit.vault.fs.io;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import org.osgi.annotation.versioning.ConsumerType;

/**
 * {@code DocViewAnalyzerListener}...
 */
@ConsumerType
public interface DocViewAnalyzerListener {

    /**
     * Is called when the analyzer passes a node element.
     *
     * @param path the path of the node
     * @param intermediate {@code true} if intermediate node
     * @param nodeType the primary type of the node or {@code null} if empty.
     */
    void onNode(@Nonnull String path, boolean intermediate, @Nullable String nodeType);
}