ch.sourcepond.io.fileobserver.api.SimpleDispatchRestriction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fileobserver-api Show documentation

Service API to watch changes on files/directories.

The newest version!

/*Copyright (C) 2017 Roland Hauser, 

Licensed 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 ch.sourcepond.io.fileobserver.api;

import java.nio.file.PathMatcher;

/**
 * An object which can be used to restrict which {@link DispatchKey} can be handled by a specific {@link PathChangeListener}.
 */
public interface SimpleDispatchRestriction {

    /**
     * Adds a new {@link PathMatcher}, which matches the pattern specified to this restriction.
     * For instance, pattern "glob:∗∗/∗.jpg" would match any path ending with
     * "jpg", see {@link java.nio.file.FileSystem#getPathMatcher(String)} for further information.
     *
     * @param pSyntaxAndPattern The syntax and the pattern, must not be {@code null}
     * @return The newly created {@link PathMatcher}, never {@code null}
     */
    PathMatcher addPathMatcher(String pSyntaxAndPattern);

    /**
     * Adds the custom {@link PathMatcher} specified to this restriction.
     *
     * @param pCustomMatcher A custom matcher, must not be {@code null}
     * @return The matcher passed as argument, never {@code null}
     */
    PathMatcher addPathMatcher(PathMatcher pCustomMatcher);
}