com.tacitknowledge.util.discovery.ResourceListSource Maven / Gradle / Ivy

Go to download
/* Copyright 2004 Tacit Knowledge
 *  
 * 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.tacitknowledge.util.discovery;

/**
 * @author  Scott Askew ([email protected])
 */
public interface ResourceListSource
{
    /**
     * Returns a list of the names of the resources in the given directory that
     * match the specified search criteria.
     * 
     * @param  basePath the directory to search; the search is not
     *         recursive; may be null
     * @param  criteria the search criteria to filter on; may be null
     * @return a list of the names of the resources in the given directory that
     *         match the specified search criteria; if no matched are found, then
     *         an empty array is returned
     */
    public String[] getResources(String basePath, ResourceCriteria criteria);
}