Scanner.java

/*
 * Copyright (C) 2015 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.jboss.errai.reflections.scanners;

import com.google.common.base.Predicate;
import com.google.common.collect.Multimap;
import org.jboss.errai.reflections.Configuration;
import org.jboss.errai.reflections.vfs.Vfs;

/**
 * Interface for scanning the class path. It is highly recommended that any
 * custom implementations subclass {@link AbstractScanner}.
 */
public interface Scanner {

  String getName();

  boolean acceptsInput(String file);

  void scan(Vfs.File file);

  Predicate<String> getResultFilter();

  Scanner filterResultsBy(Predicate<String> filter);

  void setConfiguration(Configuration configuration);

  void setStore(Multimap<String, String> store);
}