View Javadoc
1   package org.codehaus.plexus.components.io.fileselectors;
2   
3   /*
4    * Copyright 2007 The Codehaus Foundation.
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *      http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  
19  import javax.annotation.Nonnull;
20  import java.io.IOException;
21  
22  /**
23   * Interface of a component, which selects/deselects files.
24   */
25  public interface FileSelector
26  {
27      /**
28       * Role used to register component implementations with the container.
29       */
30      public static final String ROLE = FileSelector.class.getName();
31  
32      /**
33       * The default role-hint: "default".
34       */
35      public static final String DEFAULT_ROLE_HINT = "default";
36  
37      /**
38       * Returns, whether the given file is selected.
39       * @param fileInfo An instance of FileInfo with the files meta data.
40       *   It is recommended, that the caller creates an instance
41       *   of {@link org.codehaus.plexus.components.io.resources.PlexusIoResource}.
42       */
43      boolean isSelected( @Nonnull FileInfo fileInfo ) throws IOException;
44  }