public final class ComponentLibraryInfo extends java.lang.Object implements java.io.Serializable
LibraryMapping
,
ComponentLibraryInfo.SourceUrlResolver
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
ComponentLibraryInfo.DefaultSourceUrlResolver
Default
ComponentLibraryInfo.SourceUrlResolver implementation. |
static interface |
ComponentLibraryInfo.SourceUrlResolver
Interface that provides the source URL for a given
ComponentLibraryInfo . |
Constructor and Description |
---|
ComponentLibraryInfo() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getArtifactId()
Returns the component library's group id for dependency management tools like Maven and Gradle.
|
java.lang.String |
getDependencyManagementInfoUrl()
Returns an URL decribing the dependency management information for this component library.
|
java.lang.String |
getDescription()
Returns a description of the component library.
|
java.lang.String |
getDocumentationUrl()
Returns the URL of the component library's documentation.
|
java.lang.String |
getGroupId()
Returns the component library's group id for dependency management tools like Maven and Gradle.
|
java.lang.String |
getHomepageUrl()
Returns the URL of the homepage of the component library.
|
java.lang.String |
getIssueTrackerUrl()
Returns the URL of the component's library issue tracker.
|
java.lang.String |
getJavadocUrl()
Returns the URL of the component library's JavaDoc URL.
|
java.lang.String |
getJavadocUrl(java.lang.String className)
Returns the JavaDoc URL for a given class or
null if the root JavaDoc URL was
not provided. |
java.lang.String |
getName()
Returns the actual name of the component library (not the identifier).
|
java.lang.String |
getSourceBrowseUrl()
Returns the URL where the component library's source can be browsed.
|
java.lang.String |
getSourceRootUrl()
Returns the URL where the root folder of component library's source can be found.
|
java.lang.String |
getSourceUrl(java.lang.String className)
Returns the URL where the source of this class can be found or
null if
not available. |
java.util.List<java.lang.String> |
getTags()
Returns the tags associated which describe this component library.
|
java.lang.String |
getTapestryVersion()
Returns the Tapestry version used by this component library.
|
java.lang.String |
getVersion()
Returns the component library version.
|
boolean |
isDependencyManagementInfoPresent()
Tells whether full dependency management info (group id, artifact id and version) are present.
|
boolean |
isPart(java.lang.String logicalName)
Given a logical name, tells whether a given component, page or mixin is part of this
component library.
|
void |
setArtifactId(java.lang.String artifactId) |
void |
setDescription(java.lang.String description) |
void |
setDocumentationUrl(java.lang.String documentationUrl) |
void |
setGroupId(java.lang.String groupId) |
void |
setHomepageUrl(java.lang.String homepageUrl) |
void |
setIssueTrackerUrl(java.lang.String issueTrackingUrl) |
void |
setJavadocUrl(java.lang.String javadocUrl) |
void |
setLibraryMapping(LibraryMapping libraryMapping) |
void |
setName(java.lang.String name) |
void |
setSourceBrowseUrl(java.lang.String sourceBrowseUrl) |
void |
setSourceRootUrl(java.lang.String sourceRootUrl) |
void |
setSourceUrlResolver(ComponentLibraryInfo.SourceUrlResolver sourceUrlResolver) |
void |
setTags(java.util.List<java.lang.String> tags) |
void |
setTapestryVersion(java.lang.String tapestryVersion) |
void |
setVersion(java.lang.String version) |
java.lang.String |
toString() |
public ComponentLibraryInfo()
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.String getHomepageUrl()
public java.lang.String getDocumentationUrl()
public java.lang.String getSourceBrowseUrl()
public java.lang.String getSourceRootUrl()
public java.lang.String getIssueTrackerUrl()
public java.lang.String getJavadocUrl()
public java.lang.String getGroupId()
artifactId
,
version
public java.lang.String getArtifactId()
public java.lang.String getVersion()
artifactId
,
groupId
public java.lang.String getTapestryVersion()
public java.util.List<java.lang.String> getTags()
public java.lang.String getDependencyManagementInfoUrl()
public void setName(java.lang.String name)
public void setDescription(java.lang.String description)
public void setHomepageUrl(java.lang.String homepageUrl)
public void setDocumentationUrl(java.lang.String documentationUrl)
public void setSourceBrowseUrl(java.lang.String sourceBrowseUrl)
public void setSourceRootUrl(java.lang.String sourceRootUrl)
public void setJavadocUrl(java.lang.String javadocUrl)
public void setVersion(java.lang.String version)
public void setTapestryVersion(java.lang.String tapestryVersion)
public void setGroupId(java.lang.String groupId)
public void setArtifactId(java.lang.String artifactId)
public void setIssueTrackerUrl(java.lang.String issueTrackingUrl)
public void setTags(java.util.List<java.lang.String> tags)
public void setLibraryMapping(LibraryMapping libraryMapping)
public void setSourceUrlResolver(ComponentLibraryInfo.SourceUrlResolver sourceUrlResolver)
public boolean isDependencyManagementInfoPresent()
public boolean isPart(java.lang.String logicalName)
public java.lang.String getJavadocUrl(java.lang.String className)
null
if the root JavaDoc URL was
not provided.className
- the fully qualified class name.public java.lang.String getSourceUrl(java.lang.String className)
null
if
not available. This implementation delegates to ComponentLibraryInfo.SourceUrlResolver
if set.className
- the fully qualified class name.public java.lang.String toString()
toString
in class java.lang.Object
${project.version} - Copyright © 2003-2015 The Apache Software Foundation.