com.atlassian.confluence.renderer
Interface ShortcutLinksManager

All Known Implementing Classes:
DefaultShortcutLinksManager

public interface ShortcutLinksManager


Method Summary
 void addShortcutLink(String key, ShortcutLinkConfig expandedValue)
           
 ShortcutLinkConfig getShortcutLinkConfig(String key)
           
 Map<String,ShortcutLinkConfig> getShortcutLinks()
           
 boolean hasShortcutLink(String key)
           
 void removeShortcutLink(String key)
           
 String resolveDefaultLinkAlias(String key, String parameter)
          Resolves default alias.
 String resolveShortcutUrl(String key, String parameter)
          Resolves shortcut url.
 void updateShortcutLinks(Map shortcutLinks)
           
 

Method Detail

getShortcutLinks

Map<String,ShortcutLinkConfig> getShortcutLinks()

updateShortcutLinks

void updateShortcutLinks(Map shortcutLinks)

addShortcutLink

void addShortcutLink(String key,
                     ShortcutLinkConfig expandedValue)

removeShortcutLink

void removeShortcutLink(String key)

hasShortcutLink

boolean hasShortcutLink(String key)

getShortcutLinkConfig

ShortcutLinkConfig getShortcutLinkConfig(String key)

resolveShortcutUrl

String resolveShortcutUrl(String key,
                          String parameter)
Resolves shortcut url.

Parameters:
key - the shortcut key
parameter - parameter to substitute into shortcut
Returns:
the resolved url.
Throws:
IllegalArgumentException - if key does not exist. Call #hasShortcutLink() first.

resolveDefaultLinkAlias

String resolveDefaultLinkAlias(String key,
                               String parameter)
Resolves default alias.

Parameters:
key - the shortcut key
parameter - parameter to substitute into alias (if it has a variable)
Returns:
the resolved alias or empty string if no default alias is defined for the specified shortcut key
Throws:
IllegalArgumentException - if key does not exist. Call #hasShortcutLink() first.


Copyright © 2003-2011 Atlassian. All Rights Reserved.