org.apache.maven.author
Class FilesByAuthorProvider

java.lang.Object
  |
  +--org.apache.maven.author.FilesByAuthorProvider

public final class FilesByAuthorProvider

extends java.lang.Object

This class is the main entry point to resolve the authors of each file to process. The same file can have multiples authors (multiple author javadoc tag for example).

Author:

Eric Ballet Baz

Method Summary

static java.util.SortedMap

resolveAuthors(org.apache.commons.jelly.tags.ant.FileScanner filesToProcess, java.util.List authorResolverClassNames) This method is the main entry point to resolve the authors of each file to process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

resolveAuthors

public static java.util.SortedMap resolveAuthors(org.apache.commons.jelly.tags.ant.FileScanner filesToProcess,
                                                 java.util.List authorResolverClassNames)
                                          throws java.lang.ClassNotFoundException,
                                                 java.lang.InstantiationException,
                                                 java.lang.IllegalAccessException

This method is the main entry point to resolve the authors of each file to process. The same file can have multiples authors (multiple author javadoc tags for example).

Parameters:

filesToProcess - List of files to process.

authorResolverClassNames - List of AuthorResolver's class names.

Returns:

Sorted map where key is the author and value is a list of filenames. The Map is sorted on author.

Throws:

java.lang.ClassNotFoundException - If a class of a resolver is not found.

java.lang.InstantiationException - If a class of a resolver cannot be instanciate.

java.lang.IllegalAccessException - If a constructor of a resolver is not accessible.