Package com.atlassian.confluence.content.render.xhtml.view.link

Interface ViewLinkMarshallerFactory

  • All Known Implementing Classes:
    ViewLinkMarshallerFactoryImpl
    public interface ViewLinkMarshallerFactory
    A factory specifically for creating Marshaller involved in the view rendering of Links.

    • Method Detail

      • newPageLinkMarshaller

        Marshaller<Link> newPageLinkMarshaller()
        Get a new instance of the default page link view marshaller.
        Returns:
        a new instance of a Marshaller suitable for view marshalling of page Links

      • newPageLinkMarshaller

        Marshaller<Link> newPageLinkMarshaller​(Marshaller<CreatePageLink> createPageLinkMarshaller,
                                       HrefEvaluator hrefEvaluator,
                                       Marshaller<Link> unresolvedLinkMarshaller)
        Get a new instance of a page link view marshaller which will use a specific 'create page' link Marshaller and a specific HrefEvaluator for creating the actual rendered link.

        If any of the parameters are null then the default version will be used in the returned marshaller.

        Parameters:
        createPageLinkMarshaller - a custom 'create page' link Marshaller to be used by the returned marshaller
        hrefEvaluator - a custom hrefEvaluator to be used by the returned marshaller.
        unresolvedLinkMarshaller - the marshaller to be used for unresolved links
        Returns:
        a new instance of a Marshaller suitable for view marshalling of page links.

      • newBlogPostLinkMarshaller

        Marshaller<Link> newBlogPostLinkMarshaller()
        Returns:
        a new instance of Link marshaller suitable for view marshalling of blog links.

      • newBlogPostLinkMarshaller

        Marshaller<Link> newBlogPostLinkMarshaller​(HrefEvaluator hrefEvaluator,
                                           Marshaller<Link> unresolvedLinkMarshaller)
        Get a new instance of a blog post link view marshaller which will usage a specific HrefEvaluator instead of the default for creating the actual href attribute in the rendererd link.
        Parameters:
        hrefEvaluator - a custom hrefEvaluator to be used to the returned marshaller.
        unresolvedLinkMarshaller - the marshaller to be used for unresolved links
        Returns:
        a new instance of Link marshaller suitable for view marshalling of blog links.

      • newUserLinkMarshaller

        Marshaller<Link> newUserLinkMarshaller()
        Returns:
        a new instance of Link marshaller suitable for view marshalling user links.

      • newUserLinkMarshaller

        Marshaller<Link> newUserLinkMarshaller​(HrefEvaluator hrefEvaluator,
                                       Marshaller<Link> unresolvedLinkMarshaller)
        Get a new instance of a user link view marshaller which will usage a specific HrefEvaluator instead of the default for creating the actual href attribute in the rendererd link.
        Parameters:
        hrefEvaluator - a custom hrefEvaluator to be used to the returned marshaller.
        unresolvedLinkMarshaller - the marshaller to be used for unresolved links
        Returns:
        a new instance of Link marshaller suitable for view marshalling of user links.

      • newPageTemplateLinkMarshaller

        default Marshaller<Link> newPageTemplateLinkMarshaller()
        Returns:
        a new instance of Link marshaller suitable for view marshalling page template links.
        Since:
        7.5.0