Class ComponentLibraryInfo

java.lang.Object
org.apache.tapestry5.services.ComponentLibraryInfo
All Implemented Interfaces:
Serializable

public final class ComponentLibraryInfo extends Object implements Serializable
Class that encapsulates information about a component library, going beyond what a library mapping provides.
Since:
5.4
See Also:
  • Constructor Details

  • Method Details

    • getName

      public String 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

      public String 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

      Returns the component library's group id for dependency management tools like Maven and Gradle. For example, "tapestry-core".
      See Also:
      • groupId
      • version
    • getVersion

      public String getVersion()
      Returns the component library version. For example, "5.4.0".
      See Also:
      • artifactId
      • groupId
    • getTapestryVersion

      Returns the Tapestry version used by this component library. For example, "5.4.0".
    • getTags

      public List<String> 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

      public void setName(String name)
    • setDescription

      public void setDescription(String description)
    • setHomepageUrl

      public void setHomepageUrl(String homepageUrl)
    • setDocumentationUrl

      public void setDocumentationUrl(String documentationUrl)
    • setSourceBrowseUrl

      public void setSourceBrowseUrl(String sourceBrowseUrl)
    • setSourceRootUrl

      public void setSourceRootUrl(String sourceRootUrl)
    • setJavadocUrl

      public void setJavadocUrl(String javadocUrl)
    • setVersion

      public void setVersion(String version)
    • setTapestryVersion

      public void setTapestryVersion(String tapestryVersion)
    • setGroupId

      public void setGroupId(String groupId)
    • setArtifactId

      public void setArtifactId(String artifactId)
    • setIssueTrackerUrl

      public void setIssueTrackerUrl(String issueTrackingUrl)
    • setTags

      public void setTags(List<String> tags)
    • setLibraryMapping

      public void setLibraryMapping(LibraryMapping libraryMapping)
    • setSourceUrlResolver

    • isDependencyManagementInfoPresent

      Tells whether full dependency management info (group id, artifact id and version) are present.
    • isPart

      public boolean isPart(String logicalName)
      Given a logical name, tells whether a given component, page or mixin is part of this component library.
    • getJavadocUrl

      public String getJavadocUrl(String className)
      Returns the JavaDoc URL for a given class or null if the root JavaDoc URL was not provided.
      Parameters:
      className - the fully qualified class name.
    • getSourceUrl

      public String getSourceUrl(String className)
      Returns the URL where the source of this class can be found or null if not available. This implementation delegates to ComponentLibraryInfo.SourceUrlResolver if set.
      Parameters:
      className - the fully qualified class name.
    • toString

      public String toString()
      Overrides:
      toString in class Object