org.codehaus.mojo.license.model

Class LicenseMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<String,SortedSet<org.apache.maven.project.MavenProject>>

org.codehaus.mojo.license.model.LicenseMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,SortedSet<org.apache.maven.project.MavenProject>>, NavigableMap<String,SortedSet<org.apache.maven.project.MavenProject>>, SortedMap<String,SortedSet<org.apache.maven.project.MavenProject>>

public class LicenseMap
extends TreeMap<String,SortedSet<org.apache.maven.project.MavenProject>>

Map of artifacts (stub in mavenproject) group by their license.

Since:

1.0

Author:

tchemit

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNKNOWN_LICENSE_MESSAGE

Constructor Summary

Constructors

Constructor and Description
LicenseMap() Default contructor.

Method Summary

Methods

Modifier and Type	Method and Description
SortedSet<org.apache.maven.project.MavenProject>	put(String key, org.apache.maven.project.MavenProject value) Store in the license map a project to a given license.
SortedMap<org.apache.maven.project.MavenProject,String[]>	toDependencyMap() Build a dependencies map from the license map, this is a map of license for each project registered in the license map.
LicenseMap	toLicenseMapOrderByName()

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode, isEmpty

Field Detail

UNKNOWN_LICENSE_MESSAGE

public static final String UNKNOWN_LICENSE_MESSAGE

See Also:

Constant Field Values

Constructor Detail

LicenseMap

public LicenseMap()

Default contructor.

Method Detail

put

public SortedSet<org.apache.maven.project.MavenProject> put(String key,
                                                   org.apache.maven.project.MavenProject value)

Store in the license map a project to a given license.

Parameters:

key - the license on which to associate the gieven project

value - project to register in the license map

Returns:

the set of projects using the given license

toDependencyMap

public SortedMap<org.apache.maven.project.MavenProject,String[]> toDependencyMap()

Build a dependencies map from the license map, this is a map of license for each project registered in the license map.

Returns:

the generated dependencies map

toLicenseMapOrderByName

public LicenseMap toLicenseMapOrderByName()