/*
 * 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.sling.clam.jcr;

import java.util.Set;
import java.util.regex.Pattern;

import javax.jcr.Node;

import org.jetbrains.annotations.NotNull;
import org.osgi.annotation.versioning.ProviderType;

/**
 * Service to dig JCR for matching properties.
 */
@ProviderType
public interface NodeDescendingJcrPropertyDigger {

    /**
     * Digs JCR for matching properties.
     *
     * @param node          The entry node for digging
     * @param pattern       The pattern a property path has to match
     * @param propertyTypes The property types to take into account
     * @param maxLength     The maximum length of a property value
     * @param maxDepth      The maximum depth from entry node for digging
     * @throws Exception if digging in JCR fails
     */
    @SuppressWarnings("java:S112")
    public abstract void dig(@NotNull final Node node, @NotNull final Pattern pattern, @NotNull final Set<Integer> propertyTypes, final long maxLength, final int maxDepth) throws Exception;

}