Package org.apache.tapestry5.services
Class ComponentLibraryInfo
java.lang.Object
org.apache.tapestry5.services.ComponentLibraryInfo
- All Implemented Interfaces:
Serializable
Class that encapsulates information about a component library, going beyond what a library mapping
provides.
- Since:
- 5.4
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classDefaultComponentLibraryInfo.SourceUrlResolverimplementation.static interfaceInterface that provides the source URL for a givenComponentLibraryInfo. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the component library's group id for dependency management tools like Maven and Gradle.Returns an URL decribing the dependency management information for this component library.Returns a description of the component library.Returns the URL of the component library's documentation.Returns the component library's group id for dependency management tools like Maven and Gradle.Returns the URL of the homepage of the component library.Returns the URL of the component's library issue tracker.Returns the URL of the component library's JavaDoc URL.getJavadocUrl(String className) Returns the JavaDoc URL for a given class ornullif the root JavaDoc URL was not provided.getName()Returns the actual name of the component library (not the identifier).Returns the URL where the component library's source can be browsed.Returns the URL where the root folder of component library's source can be found.getSourceUrl(String className) Returns the URL where the source of this class can be found ornullif not available.getTags()Returns the tags associated which describe this component library.Returns the Tapestry version used by this component library.Returns the component library version.booleanTells whether full dependency management info (group id, artifact id and version) are present.booleanGiven a logical name, tells whether a given component, page or mixin is part of this component library.voidsetArtifactId(String artifactId) voidsetDescription(String description) voidsetDocumentationUrl(String documentationUrl) voidsetGroupId(String groupId) voidsetHomepageUrl(String homepageUrl) voidsetIssueTrackerUrl(String issueTrackingUrl) voidsetJavadocUrl(String javadocUrl) voidsetLibraryMapping(LibraryMapping libraryMapping) voidvoidsetSourceBrowseUrl(String sourceBrowseUrl) voidsetSourceRootUrl(String sourceRootUrl) voidsetSourceUrlResolver(ComponentLibraryInfo.SourceUrlResolver sourceUrlResolver) voidvoidsetTapestryVersion(String tapestryVersion) voidsetVersion(String version) toString()
-
Constructor Details
-
ComponentLibraryInfo
public ComponentLibraryInfo()
-
-
Method Details
-
getName
Returns the actual name of the component library (not the identifier). For example, "Tapestry 5 Core Library". -
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
Returns the URL of the homepage of the component library. For example, "http://tapestry.apache.org". -
getDocumentationUrl
Returns the URL of the component library's documentation. For example, "http://tapestry.apache.org/documentation.html". -
getSourceBrowseUrl
Returns the URL where the component library's source can be browsed. For example, "https://git-wip-us.apache.org/repos/asf?p=tapestry-5.git;a=summary". -
getSourceRootUrl
Returns the URL where the root folder of component library's source can be found. For example, "https://git-wip-us.apache.org/repos/asf?p=tapestry-5.git;a=tree;f=tapestry-core/src/main/java/". -
getIssueTrackerUrl
Returns the URL of the component's library issue tracker. For example, "https://issues.apache.org/jira/browse/TAP5". -
getJavadocUrl
Returns the URL of the component library's JavaDoc URL. For example, "http://tapestry.apache.org/current/apidocs/" -
getGroupId
Returns the component library's group id for dependency management tools like Maven and Gradle. For example, "org.apache.tapestry".- See Also:
-
artifactIdversion
-
getArtifactId
Returns the component library's group id for dependency management tools like Maven and Gradle. For example, "tapestry-core".- See Also:
-
groupIdversion
-
getVersion
Returns the component library version. For example, "5.4.0".- See Also:
-
artifactIdgroupId
-
getTapestryVersion
Returns the Tapestry version used by this component library. For example, "5.4.0". -
getTags
Returns the tags associated which describe this component library. Use just lowercase letters, numbers and dashes. -
getDependencyManagementInfoUrl
Returns an URL decribing the dependency management information for this component library. -
setName
-
setDescription
-
setHomepageUrl
-
setDocumentationUrl
-
setSourceBrowseUrl
-
setSourceRootUrl
-
setJavadocUrl
-
setVersion
-
setTapestryVersion
-
setGroupId
-
setArtifactId
-
setIssueTrackerUrl
-
setTags
-
setLibraryMapping
-
setSourceUrlResolver
-
isDependencyManagementInfoPresent
Tells whether full dependency management info (group id, artifact id and version) are present. -
isPart
Given a logical name, tells whether a given component, page or mixin is part of this component library. -
getJavadocUrl
Returns the JavaDoc URL for a given class ornullif the root JavaDoc URL was not provided.- Parameters:
className- the fully qualified class name.
-
getSourceUrl
Returns the URL where the source of this class can be found ornullif not available. This implementation delegates toComponentLibraryInfo.SourceUrlResolverif set.- Parameters:
className- the fully qualified class name.
-
toString
-