View Javadoc

1   /*
2    * Copyright 2006 Eric Ballet Baz
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.maven.author.resolver;
18  
19  import java.io.File;
20  
21  /**
22   * The goal of an AuthorResolver is to resolve the author(s) of a file.
23   *
24   * @author Eric Ballet Baz
25   */
26  public interface AuthorResolver {
27  
28      /**
29       * Resolve the author(s) of the specified file.
30       * @param file File for wich we should resolve author(s) for.
31       * @return Array of authors. If no author is found an empty array (not null) should be returned.
32       */
33      String[] resolveAuthors(File file);
34  }