Package org.apache.tapestry5.services
Class ComponentLibraryInfo
-
- org.apache.tapestry5.services.ComponentLibraryInfo
-
- All Implemented Interfaces:
public final class ComponentLibraryInfo extends implements
Class that encapsulates information about a component library, going beyond what a library mapping provides.- Since:
- 5.4
- See Also:
LibraryMapping
,ComponentLibraryInfo.SourceUrlResolver
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ComponentLibraryInfo.DefaultSourceUrlResolver
DefaultComponentLibraryInfo.SourceUrlResolver
implementation.static interface
ComponentLibraryInfo.SourceUrlResolver
Interface that provides the source URL for a givenComponentLibraryInfo
.
-
Constructor Summary
Constructors Constructor Description ComponentLibraryInfo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description getArtifactId()
Returns the component library's group id for dependency management tools like Maven and Gradle.getDependencyManagementInfoUrl()
Returns an URL decribing the dependency management information for this component library.getDescription()
Returns a description of the component library.getDocumentationUrl()
Returns the URL of the component library's documentation.getGroupId()
Returns the component library's group id for dependency management tools like Maven and Gradle.getHomepageUrl()
Returns the URL of the homepage of the component library.getIssueTrackerUrl()
Returns the URL of the component's library issue tracker.getJavadocUrl()
Returns the URL of the component library's JavaDoc URL.className)
Returns the JavaDoc URL for a given class ornull
if the root JavaDoc URL was not provided.getName()
Returns the actual name of the component library (not the identifier).getSourceBrowseUrl()
Returns the URL where the component library's source can be browsed.getSourceRootUrl()
Returns the URL where the root folder of component library's source can be found.className)
Returns the URL where the source of this class can be found ornull
if not available.<>
getTags()
Returns the tags associated which describe this component library.getTapestryVersion()
Returns the Tapestry version used by this component library.getVersion()
Returns the component library version.boolean
isDependencyManagementInfoPresent()
Tells whether full dependency management info (group id, artifact id and version) are present.boolean
logicalName)
Given a logical name, tells whether a given component, page or mixin is part of this component library.void
artifactId)
void
description)
void
documentationUrl)
void
groupId)
void
homepageUrl)
void
issueTrackingUrl)
void
javadocUrl)
void
setLibraryMapping(LibraryMapping libraryMapping)
void
name)
void
sourceBrowseUrl)
void
sourceRootUrl)
void
setSourceUrlResolver(ComponentLibraryInfo.SourceUrlResolver sourceUrlResolver)
void
<> tags)
void
tapestryVersion)
void
version)
toString()
-
-
-
Constructor Detail
-
ComponentLibraryInfo
public ComponentLibraryInfo()
-
-
Method Detail
-
getName
public getName()
Returns the actual name of the component library (not the identifier). For example, "Tapestry 5 Core Library".
-
getDescription
public getDescription()
Returns a description of the component library. For example, "The set of components, pages and mixins provided by Tapestry out-of-the-box.".
-
getHomepageUrl
public getHomepageUrl()
Returns the URL of the homepage of the component library. For example, "http://tapestry.apache.org".
-
getDocumentationUrl
public getDocumentationUrl()
Returns the URL of the component library's documentation. For example, "http://tapestry.apache.org/documentation.html".
-
getSourceBrowseUrl
public getSourceBrowseUrl()
Returns the URL where the component library's source can be browsed. For example, "http://git-wip-us.apache.org/repos/asf?p=tapestry-5.git;a=summary".
-
getSourceRootUrl
public getSourceRootUrl()
Returns the URL where the root folder of component library's source can be found. For example, "http://git-wip-us.apache.org/repos/asf?p=tapestry-5.git;a=tree;f=tapestry-core/src/main/java/".
-
getIssueTrackerUrl
public getIssueTrackerUrl()
Returns the URL of the component's library issue tracker. For example, "http://issues.apache.org/jira/browse/TAP5".
-
getJavadocUrl
public getJavadocUrl()
Returns the URL of the component library's JavaDoc URL. For example, "http://tapestry.apache.org/current/apidocs/"
-
getGroupId
public getGroupId()
Returns the component library's group id for dependency management tools like Maven and Gradle. For example, "org.apache.tapestry".- See Also:
artifactId
,version
-
getArtifactId
public getArtifactId()
Returns the component library's group id for dependency management tools like Maven and Gradle. For example, "tapestry-core".
-
getVersion
public getVersion()
Returns the component library version. For example, "5.4.0".- See Also:
artifactId
,groupId
-
getTapestryVersion
public getTapestryVersion()
Returns the Tapestry version used by this component library. For example, "5.4.0".
-
getTags
public <> getTags()
Returns the tags associated which describe this component library. Use just lowercase letters, numbers and dashes.
-
getDependencyManagementInfoUrl
public getDependencyManagementInfoUrl()
Returns an URL decribing the dependency management information for this component library.
-
setName
public void name)
-
setDescription
public void description)
-
setHomepageUrl
public void homepageUrl)
-
setDocumentationUrl
public void documentationUrl)
-
setSourceBrowseUrl
public void sourceBrowseUrl)
-
setSourceRootUrl
public void sourceRootUrl)
-
setJavadocUrl
public void javadocUrl)
-
setVersion
public void version)
-
setTapestryVersion
public void tapestryVersion)
-
setGroupId
public void groupId)
-
setArtifactId
public void artifactId)
-
setIssueTrackerUrl
public void issueTrackingUrl)
-
setTags
public void <> tags)
-
setLibraryMapping
public void setLibraryMapping(LibraryMapping libraryMapping)
-
setSourceUrlResolver
public void setSourceUrlResolver(ComponentLibraryInfo.SourceUrlResolver sourceUrlResolver)
-
isDependencyManagementInfoPresent
public boolean isDependencyManagementInfoPresent()
Tells whether full dependency management info (group id, artifact id and version) are present.
-
isPart
public boolean logicalName)
Given a logical name, tells whether a given component, page or mixin is part of this component library.
-
getJavadocUrl
public className)
Returns the JavaDoc URL for a given class ornull
if the root JavaDoc URL was not provided.- Parameters:
className
- the fully qualified class name.
-
getSourceUrl
public className)
Returns the URL where the source of this class can be found ornull
if not available. This implementation delegates toComponentLibraryInfo.SourceUrlResolver
if set.- Parameters:
className
- the fully qualified class name.
-
toString
public toString()
- Overrides:
in class
-
-