com.alibaba.antx.util.scanner.ScannerHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of antx-autoconfig Show documentation

The newest version!

/*
 * Copyright (c) 2002-2012 Alibaba Group Holding Limited.
 * All rights reserved.
 *
 * 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 com.alibaba.antx.util.scanner;

/**
 * 扫描器的回调函数。
 *
 * @author Michael Zhou
 */
public interface ScannerHandler {
    /**
     * 设置scanner，此方法一定是首先被调用的。
     *
     * @param scanner 当前正在扫描的scanner
     */
    void setScanner(Scanner scanner);

    /** 开始扫描。 */
    void startScanning();

    /** 结束扫描。 */
    void endScanning();

    /** 扫描目录。 */
    void directory();

    /** 扫描文件。 */
    void file();

    /**
     * 是否跟进指定目录或文件。该方法有助于提高扫描速度。
     *
     * @return 如果是，则返回true
     */
    boolean followUp();
}