Package org.apache.maven.model

Class License

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    public class License
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, InputLocationTracker
    Describes the licenses for this project. This is used to generate the license page of the project's web site, as well as being taken into consideration in other reporting and validation. The licenses listed for the project are that of the project itself, and not of dependencies.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      License()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      License clone()
      Method clone.
      java.lang.String getComments()
      Get addendum information pertaining to this license.
      java.lang.String getDistribution()
      Get the primary method by which this project may be distributed.
      InputLocation getLocation​(java.lang.Object key)
      Gets the location of the specified field in the input source.
      java.lang.String getName()
      Get the full legal name of the license.
      private InputLocation getOtherLocation​(java.lang.Object key)  
      java.lang.String getUrl()
      Get the official url for the license text.
      void setComments​(java.lang.String comments)
      Set addendum information pertaining to this license.
      void setDistribution​(java.lang.String distribution)
      Set the primary method by which this project may be distributed.
      void setLocation​(java.lang.Object key, InputLocation location)
      Sets the location of the specified field.
      void setName​(java.lang.String name)
      Set the full legal name of the license.
      void setOtherLocation​(java.lang.Object key, InputLocation location)  
      void setUrl​(java.lang.String url)
      Set the official url for the license text.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • name

        private java.lang.String name
        The full legal name of the license.

      • url

        private java.lang.String url
        The official url for the license text.

      • distribution

        private java.lang.String distribution
        The primary method by which this project may be distributed.
        repo
        may be downloaded from the Maven repository
        manual
        user must manually download and install the dependency.

      • comments

        private java.lang.String comments
        Addendum information pertaining to this license.

      • locations

        private java.util.Map<java.lang.Object,​InputLocation> locations
        Field locations.

      • nameLocation

        private InputLocation nameLocation
        Field nameLocation.

      • urlLocation

        private InputLocation urlLocation
        Field urlLocation.

      • distributionLocation

        private InputLocation distributionLocation
        Field distributionLocation.

      • commentsLocation

        private InputLocation commentsLocation
        Field commentsLocation.

    • Constructor Detail

      • License

        public License()

    • Method Detail

      • clone

        public License clone()
        Method clone.
        Overrides:
        clone in class java.lang.Object
        Returns:
        License

      • getComments

        public java.lang.String getComments()
        Get addendum information pertaining to this license.
        Returns:
        String

      • getDistribution

        public java.lang.String getDistribution()
        Get the primary method by which this project may be distributed.
        repo
        may be downloaded from the Maven repository
        manual
        user must manually download and install the dependency.
        Returns:
        String

      • getName

        public java.lang.String getName()
        Get the full legal name of the license.
        Returns:
        String

      • setOtherLocation

        public void setOtherLocation​(java.lang.Object key,
                             InputLocation location)
        Parameters:
        key -
        location -

      • getOtherLocation

        private InputLocation getOtherLocation​(java.lang.Object key)
        Parameters:
        key -
        Returns:
        InputLocation

      • getUrl

        public java.lang.String getUrl()
        Get the official url for the license text.
        Returns:
        String

      • setComments

        public void setComments​(java.lang.String comments)
        Set addendum information pertaining to this license.
        Parameters:
        comments -

      • setDistribution

        public void setDistribution​(java.lang.String distribution)
        Set the primary method by which this project may be distributed.
        repo
        may be downloaded from the Maven repository
        manual
        user must manually download and install the dependency.
        Parameters:
        distribution -

      • setName

        public void setName​(java.lang.String name)
        Set the full legal name of the license.
        Parameters:
        name -

      • setUrl

        public void setUrl​(java.lang.String url)
        Set the official url for the license text.
        Parameters:
        url -