Interface CodeSourceDescriptor

public interface CodeSourceDescriptor
Descriptor with details of a CodeSource.
Since:
1.0.0
Author:
Joerg Hohwiller (hohwille at users.sourceforge.net)
See Also:

  • Field Details

  • Method Details

    • getId

      String getId()
      Returns:
      the unique ID of this source. E.g. "«groupId»:«artifactId»:«version»" (GAV coordinates) for a maven project. May be the CodeSource-ID if no other information is available.

    • getGroupId

      String getGroupId()
      Returns:
      the group ID of the CodeSource or null if undefined.

    • getArtifactId

      String getArtifactId()
      Returns:
      the artifact ID of the CodeSource. Never null.

    • getVersion

      String getVersion()
      Returns:
      the version of the CodeSource if available or VERSION_UNDEFINED.

    • getScope

      String getScope()
      Returns:
      the optional scope of the CodeSource (e.g. "compile" for sub-source "src/main/java" or "test" for sub-source "src/test/java"). May be null (default for entire project).

    • getDocUrl

      String getDocUrl()
      Returns:
      the base URL of the JavaDoc for this source. May be null if unavailable.