Utils (Sitevision API)

```
@Requireable(value="Utils")
public interface Utils
```
Main entry point to get instances of interfaces in the Sitevision Utility API.
An instance of this interface can be obtained from your portlet via the request attribute "sitevision.utils". Once you have obtained an Utils instance, you can use it to retrieve instances of all other interfaces in the Sitevision API. In all JCR capable portlets that are bundled with Sitevision and exposes a "Custom template", you always have an Utils instance available as "$sitevisionUtils" in the VelocityContext.

Example of how to get hold of a PropertyUtil instance from your JSR 286 portlet:
```
    Utils utils = (Utils) aRequest.getAttribute("sitevision.utils");
    PropertyUtil propertyUtil = utils.getPropertyUtil();
    ...
    propertyUtil.get...
 
```
Example of how to get hold of a PropertyUtil instance in Velocity for a JCR capable standard Sitevision portlet with a "Custom template" (e.g. the JCR Menu portlet):
```
    #set($propertyUtil = $sitevisionUtils.propertyUtil)
    ...
    $propertyUtil.get...
 
```
If sitevisionUtils is not available on the VelocityContext, you can use the PortletRequest instead if available (e.g. the Script portlet):
```
    #set($propertyUtil = $request.getAttribute('sitevision.utils').propertyUtil)
 
```
Author:

Magnus Lövgren

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AliasUtil`	`getAliasUtil()` Gets an instance of an alias utility class.
`ArchiveUtil`	`getArchiveUtil()` Gets an instance of an archive utility class
`ArticleUtil`	`getArticleUtil()` Gets an instance of an article utility class
`AuthenticationUtil`	`getAuthenticationUtil()` Gets an instance of an authentication utility class
`BookmarkUtil`	`getBookmarkUtil()` Gets an instance of a bookmark utility class
`BuddyIconRenderer`	`getBuddyIconRenderer()` Creates and returns a new instance of a stateful buddy icon renderer.
`ClientUtil`	`getClientUtil()` Gets an instance of a client utility class
`CollaborationFactory`	`getCollaborationFactory()` Gets an instance of a factory for collaboration-related instances.
`ColorUtil`	`getColorUtil()` Gets an instance of a color utility class
`ContentNodeUtil`	`getContentNodeUtil()` Gets an instance of a content node utility class.
`CurrencyFactory`	`getCurrencyFactory()` Gets an instance of a currency factory class.
`DateUtil`	`getDateUtil()` Gets an instance of an date utility class.
`DecorationUtil`	`getDecorationUtil()` Gets an instance of a decoration utility class
`DeviceUtil`	`getDeviceUtil()` Gets an instance of a device utility class
`DirectoryUtil`	`getDirectoryUtil()` Gets an instance of a directory utility class
`DocTypeUtil`	`getDocTypeUtil()` Gets an instance of a DOCTYPE utility class
`EndecUtil`	`getEndecUtil()` Gets an instance of an encode/decode utility class
`ExceptionSuppressingCollection`	`getExceptionSuppressingCollection(Collection aCollection)` Creates and returns an instance of a collection decorator that exposes an exception-suppressing iterator.
`ExceptionSuppressingIterator`	`getExceptionSuppressingIterator(Iterator anIterator)` Creates and returns an instance of an exception-suppressing iterator that returns exception-suppressing dynamic proxys.
`ExceptionSuppressingProxy`	`getExceptionSuppressingProxy(Object anObject)` Creates and returns an instance of an exception-suppressing proxy.
`FileIconRenderer`	`getFileIconRenderer()` Creates and returns a new instance of a stateful file icon renderer.
`FileUtil`	`getFileUtil()` Gets an instance of a file utility class
`FolderUtil`	`getFolderUtil()` Gets an instance of a folder utility class
`FontUtil`	`getFontUtil()` Gets an instance of a font utility class
`FormatterBuilderFactory`	`getFormatterBuilderFactory()` Gets an instance of a formatter builder factory class.
`IconUtil`	`getIconUtil()` Gets an instance of an icon utility class
`ImageLinkRenderer`	`getImageLinkRenderer()` Creates and returns a new instance of a stateful image link renderer.
`ImageRenderer`	`getImageRenderer()` Creates and returns a new instance of a stateful image renderer.
`ImageScaler`	`getImageScaler(int aMaxWidth, int aMaxHeight)` Gets an instance of an immutable image scaler that enables scaling of images to a certain size.
`ImageUtil`	`getImageUtil()` Gets an instance of an image utility class
`InstanceCreatorUtil`	`getInstanceCreatorUtil()` Gets an instance of an instance creator utility class.
`InstanceTypeUtil`	`getInstanceTypeUtil()` Gets an instance of an instance type utility class
`LandingPageUtil`	`getLandingPageUtil()` Gets an instance of a landing page utility class.
`LinkRenderer`	`getLinkRenderer()` Creates and returns a new instance of a stateful link renderer.
`LocaleUtil`	`getLocaleUtil()` Gets an instance of a locale utility class.
`LogUtil`	`getLogUtil()` Gets an instance of a logging utility class
`MailUtil`	`getMailUtil()` Gets an instance of a mail utility class.
`MessageDigesterFactory`	`getMessageDigesterFactory()` Gets an instance of a message digester factory class.
`MessagesFactory`	`getMessagesFactory()` Gets an instance of a messages factory class.
`MetadataDefinitionUtil`	`getMetadataDefinitionUtil()` Gets an instance of an metadata definition utility class
`MetadataUtil`	`getMetadataUtil()` Gets an instance of a metadata utility class
`MimeTypeUtil`	`getMimeTypeUtil()` Gets an instance of a MIME type utility class
`NodeComparatorUtil`	`getNodeComparatorUtil()` Gets an instance of a node comparator utility class.
`NodeFactoryUtil`	`getNodeFactoryUtil()` Gets an instance of a node factory utility class.
`NodeFilterUtil`	`getNodeFilterUtil()` Gets an instance of a node filter utility class.
`NodeIteratorUtil`	`getNodeIteratorUtil()` Gets an instance of a node iterator utility class
`NodeResolverUtil`	`getNodeResolverUtil()` Gets an instance of a node resolver utility class.
`NodeTreeUtil`	`getNodeTreeUtil()` Gets an instance of a utility class for node trees.
`NodeTypeUtil`	`getNodeTypeUtil()` Gets an instance of a node type utility class
`OutputUtil`	`getOutputUtil()` Gets an instance of a output utility class
`PageUtil`	`getPageUtil()` Gets an instance of a page utility class
`PermissionUtil`	`getPermissionUtil()` Gets an instance of a permission utility class
`PortletContextUtil`	`getPortletContextUtil()` Gets an instance of a portlet context utility class
`PortletUtil`	`getPortletUtil()` Gets an instance of a portlet utility class
`PrincipalUtil`	`getPrincipalUtil()` Gets an instance of an principal utility class
`PropertyUtil`	`getPropertyUtil()` Gets an instance of a utility class for jcr properties
`PublishingUtil`	`getPublishingUtil()` Gets an instance of a publishing utility class
`RedirectUtil`	`getRedirectUtil()` Gets an instance of a redirect utility class.
`ResourceLocatorUtil`	`getResourceLocatorUtil()` Gets an instance of a resource locator utility class
`RoleUtil`	`getRoleUtil()` Gets an instance of a role utility class.
`ScriptUtil`	`getScriptUtil()` Gets an instance of a scripting utility class
`SearchFactory`	`getSearchFactory()` Gets an instance of a factory for search-related instances.
`SearchFieldUtil`	`getSearchFieldUtil()` Deprecated.
`SearchUtil`	`getSearchUtil()` Gets an instance of a search utility class
`SiteCookieUtil`	`getSiteCookieUtil()` Gets an instance of a site cookie utility class.
`StructureUtil`	`getStructureUtil()` Gets an instance of a structure utility class
`SubscriberUtil`	`getSubscriberUtil()` Gets an instance of an subscriber utility class
`SubscriptionUtil`	`getSubscriptionUtil()` Gets an instance of an subscription utility class
`TagUtil`	`getTagUtil()` Gets an instance of a tag utility class.
`TemplateUtil`	`getTemplateUtil()` Gets an instance of a template utility class
`TextModuleRendererBuilder`	`getTextModuleRendererBuilder()` Gets an instance of a Text module renderer builder class.
`TimestampUtil`	`getTimestampUtil()` Gets an instance of a timestamp utility class.
`TranslationUtil`	`getTranslationUtil()` Gets an instance of a translation utility class.
`TrashcanUtil`	`getTrashcanUtil()` Gets an instance of a trashcan utility class
`UserFactory`	`getUserFactory()` Gets an instance of a factory for user-related instances.
`UserFieldRenderer`	`getUserFieldRenderer()` Creates and returns a new instance of a stateful user field renderer.
`UserUtil`	`getUserUtil()` Deprecated. use `getUserFactory()` to get a `SystemUserUtil` and `UserIdentityUtil` instead
`WebContentUtil`	`getWebContentUtil()` Gets an instance of a web content utility class
`WebResourceFactory`	`getWebResourceFactory()` Gets an instance of a web resource factory utility class.
`VelocityRenderer`	`getVelocityRenderer()` Gets an instance of a Velocity renderer class.
`VersionedPropertyUtil`	`getVersionedPropertyUtil(int aVersion)` Gets an instance of a property utility class for a specified version.
`VersionUtil`	`getVersionUtil()` Gets an instance of a version utility class
`XmlParserUtil`	`getXmlParserUtil()` Gets an instance of a xml parser utility class.
`XSLTUtil`	`getXSLTUtil()` Gets an instance of a XSLT utility class.

- Method Detail
  - getPortletContextUtil
```
PortletContextUtil getPortletContextUtil()
```
    Gets an instance of a portlet context utility class
    
    Returns:
    
    a context utility class
  - getNodeIteratorUtil
```
NodeIteratorUtil getNodeIteratorUtil()
```
    Gets an instance of a node iterator utility class
    
    Returns:
    
    a node iterator utility class
  - getNodeTreeUtil
```
NodeTreeUtil getNodeTreeUtil()
```
    Gets an instance of a utility class for node trees.
    
    Returns:
    
    a utility class for node trees
  - getPropertyUtil
```
PropertyUtil getPropertyUtil()
```
    Gets an instance of a utility class for jcr properties
    
    Returns:
    
    a utility class for jcr properties
  - getLinkRenderer
```
LinkRenderer getLinkRenderer()
```
    Creates and returns a new instance of a stateful link renderer. Since the renderer is stateful, re-use of the same instance instead of getting a new is preferred for best performance. (i.e. Just call this method once in the rendering phase of your portlet)
    
    Returns:
    
    a stateful link renderer
  - getOutputUtil
```
OutputUtil getOutputUtil()
```
    Gets an instance of a output utility class
    
    Returns:
    
    a output utility class
  - getColorUtil
```
ColorUtil getColorUtil()
```
    Gets an instance of a color utility class
    
    Returns:
    
    a color utility class
  - getDecorationUtil
```
DecorationUtil getDecorationUtil()
```
    Gets an instance of a decoration utility class
    
    Returns:
    
    a decoration utility class
  - getFontUtil
```
FontUtil getFontUtil()
```
    Gets an instance of a font utility class
    
    Returns:
    
    a font utility class
  - getResourceLocatorUtil
```
ResourceLocatorUtil getResourceLocatorUtil()
```
    Gets an instance of a resource locator utility class
    
    Returns:
    
    a resource locator utility class
  - getEndecUtil
```
EndecUtil getEndecUtil()
```
    Gets an instance of an encode/decode utility class
    
    Returns:
    
    a escape utility class
  - getScriptUtil
```
ScriptUtil getScriptUtil()
```
    Gets an instance of a scripting utility class
    
    Returns:
    
    a scripting utility class
  - getLogUtil
```
LogUtil getLogUtil()
```
    Gets an instance of a logging utility class
    
    Returns:
    
    a logging utility class
  - getIconUtil
```
IconUtil getIconUtil()
```
    Gets an instance of an icon utility class
    
    Returns:
    
    an icon utility class
  - getPermissionUtil
```
PermissionUtil getPermissionUtil()
```
    Gets an instance of a permission utility class
    
    Returns:
    
    a permission utility class
    
    Since:
    
    Sitevision 2.6
  - getDirectoryUtil
```
DirectoryUtil getDirectoryUtil()
```
    Gets an instance of a directory utility class
    
    Returns:
    
    a directory utility class
    
    Since:
    
    Sitevision 2.6
  - getClientUtil
```
ClientUtil getClientUtil()
```
    Gets an instance of a client utility class
    
    Returns:
    
    a client utility class
    
    Since:
    
    Sitevision 2.6_02
  - getSearchUtil
```
SearchUtil getSearchUtil()
```
    Gets an instance of a search utility class
    
    Returns:
    
    a search utility class
    
    Since:
    
    Sitevision 2.6_05
  - getSearchFieldUtil
```
@Deprecated
SearchFieldUtil getSearchFieldUtil()
```
    Deprecated.
    
    Gets an instance of a search field utility class
    
    Returns:
    
    a search field utility class
    
    Since:
    
    Sitevision 2.6.2, 2.7_06
  - getPortletUtil
```
PortletUtil getPortletUtil()
```
    Gets an instance of a portlet utility class
    
    Returns:
    
    a search utility class
    
    Since:
    
    Sitevision 2.6_06
  - getMetadataUtil
```
MetadataUtil getMetadataUtil()
```
    Gets an instance of a metadata utility class
    
    Returns:
    
    a metadata utility class
    
    Since:
    
    Sitevision 2.6.1
  - getBookmarkUtil
```
BookmarkUtil getBookmarkUtil()
```
    Gets an instance of a bookmark utility class
    
    Returns:
    
    a bookmark utility class
    
    Since:
    
    Sitevision 2.6.1
  - getPublishingUtil
```
PublishingUtil getPublishingUtil()
```
    Gets an instance of a publishing utility class
    
    Returns:
    
    a publishing utility class
    
    Since:
    
    Sitevision 2.6.1_04
  - getVersionUtil
```
VersionUtil getVersionUtil()
```
    Gets an instance of a version utility class
    
    Returns:
    
    a version utility class
    
    Since:
    
    Sitevision 2.6.1_04
  - getArchiveUtil
```
ArchiveUtil getArchiveUtil()
```
    Gets an instance of an archive utility class
    
    Returns:
    
    an archive utility class
    
    Since:
    
    Sitevision 2.6.2
  - getFolderUtil
```
FolderUtil getFolderUtil()
```
    Gets an instance of a folder utility class
    
    Returns:
    
    a folder utility class
    
    Since:
    
    Sitevision 2.6.2
  - getStructureUtil
```
StructureUtil getStructureUtil()
```
    Gets an instance of a structure utility class
    
    Returns:
    
    a structure utility class
    
    Since:
    
    Sitevision 2.6.2
  - getWebContentUtil
```
WebContentUtil getWebContentUtil()
```
    Gets an instance of a web content utility class
    
    Returns:
    
    a web content utility class
    
    Since:
    
    Sitevision 2.6.2
  - getArticleUtil
```
ArticleUtil getArticleUtil()
```
    Gets an instance of an article utility class
    
    Returns:
    
    an article utility class
    
    Since:
    
    Sitevision 2.6.2
  - getFileUtil
```
FileUtil getFileUtil()
```
    Gets an instance of a file utility class
    
    Returns:
    
    a file utility class
    
    Since:
    
    Sitevision 2.6.2
  - getImageUtil
```
ImageUtil getImageUtil()
```
    Gets an instance of an image utility class
    
    Returns:
    
    an image utility class
    
    Since:
    
    Sitevision 2.6.2
  - getPageUtil
```
PageUtil getPageUtil()
```
    Gets an instance of a page utility class
    
    Returns:
    
    a page utility class
    
    Since:
    
    Sitevision 2.6.2
  - getTrashcanUtil
```
TrashcanUtil getTrashcanUtil()
```
    Gets an instance of a trashcan utility class
    
    Returns:
    
    a trashcan utility class
    
    Since:
    
    Sitevision 2.6.2
  - getTemplateUtil
```
TemplateUtil getTemplateUtil()
```
    Gets an instance of a template utility class
    
    Returns:
    
    a template utility class
    
    Since:
    
    Sitevision 2.6.1_04
  - getAuthenticationUtil
```
AuthenticationUtil getAuthenticationUtil()
```
    Gets an instance of an authentication utility class
    
    Returns:
    
    a authentication utility class
    
    Since:
    
    Sitevision 2.6.1_03
  - getPrincipalUtil
```
PrincipalUtil getPrincipalUtil()
```
    Gets an instance of an principal utility class
    
    Returns:
    
    a principal utility class
    
    Since:
    
    Sitevision 2.6.1_06
  - getFileIconRenderer
```
FileIconRenderer getFileIconRenderer()
```
    Creates and returns a new instance of a stateful file icon renderer. Since the renderer is stateful, re-use of the same instance instead of getting a new is preferred for best performance. (i.e. Just call this method once in the rendering phase of your portlet)
    
    Returns:
    
    a stateful file icon renderer
    
    Since:
    
    Sitevision 2.6.1_08
  - getImageRenderer
```
ImageRenderer getImageRenderer()
```
    Creates and returns a new instance of a stateful image renderer. Since the renderer is stateful, re-use of the same instance instead of getting a new is preferred for best performance. (i.e. Just call this method once in the rendering phase of your portlet)
    
    Returns:
    
    a stateful image renderer
    
    Since:
    
    Sitevision 2.6.1_08
  - getImageScaler
```
ImageScaler getImageScaler(int aMaxWidth,
                           int aMaxHeight)
```
    Gets an instance of an immutable image scaler that enables scaling of images to a certain size.
    Image scaler instance will respect the size ratio of the original image when scaling it.
    
    Note that an image scaler must be created in context of a currently executing portlet. In other words: if PortletContextUtil.getCurrentPortlet() is null, no image scaler can be created (i.e. this method will return null).
    
    Parameters:
    
    aMaxWidth - max width in pixels for scaled images, must be 10 or higher
    
    aMaxHeight - max height in pixels for scaled images, must be 10 or higher
    
    Returns:
    
    an image scaler that can be used when rendering scaled images with an ImageRenderer. If aMaxWidth or aMaxHeight has illegal values, null will be returned.
    
    Since:
    
    Sitevision 2.6.1_08
  - getExceptionSuppressingProxy
```
ExceptionSuppressingProxy getExceptionSuppressingProxy(Object anObject)
```
    Creates and returns an instance of an exception-suppressing proxy.
    Note! Be aware of null's. They are never proxied. If you try to proxy null, this method will just return null, not a proxy instance. In other words: even though you're trying to use a ExceptionSuppressingProxy to suppress exceptions, method invocations will of course still throw NullPointerException.
    
    Parameters:
    
    anObject - an object to be proxied by an ExceptionSuppressingProxy
    
    Returns:
    
    anObject proxied by an ExceptionSuppressingProxy, or null if anObject is null. If anObject is a ExceptionSuppressingProxy), anObject will be returned "as-is" (no new instance will be created).
    
    Since:
    
    Sitevision 2.6.1_09
  - getExceptionSuppressingCollection
```
ExceptionSuppressingCollection getExceptionSuppressingCollection(Collection aCollection)
```
    Creates and returns an instance of a collection decorator that exposes an exception-suppressing iterator.
    Note! The sole purpose of the ExceptionSuppressingCollection is to provide easy access to a decorated iterator (ExceptionSuppressingIterator). You should not create a collection of object proxys (i.e. Collection<ExceptionSuppressingProxy>) yourself. You should use ExceptionSuppressingCollection with your "regular" collection since the actual proxying is done by the iterator itself.
    
    Parameters:
    
    aCollection - a collection to be decorated by a ExceptionSuppressingCollection. Note that this should be your "regular" collection, not a already proxied one (i.e. Collection<ExceptionSuppressingProxy>).
    
    Returns:
    
    the collection decorated by a ExceptionSuppressingCollection, or null if aCollection is null. If aCollection is a ExceptionSuppressingCollection), aCollection will be returned "as-is" (no new instance will be created).
    
    Since:
    
    Sitevision 2.6.1_09
  - getExceptionSuppressingIterator
```
ExceptionSuppressingIterator getExceptionSuppressingIterator(Iterator anIterator)
```
    Creates and returns an instance of an exception-suppressing iterator that returns exception-suppressing dynamic proxys.
    
    Parameters:
    
    anIterator - an iterator to be decorated by a ExceptionSuppressingIterator
    
    Returns:
    
    the iterator decorated by a ExceptionSuppressingIterator, or null if anIterator is null. If anIterator is a ExceptionSuppressingIterator), anIterator will be returned "as-is" (no new instance will be created).
    
    Since:
    
    Sitevision 2.6.1_09
  - getSubscriptionUtil
```
SubscriptionUtil getSubscriptionUtil()
```
    Gets an instance of an subscription utility class
    
    Returns:
    
    a subscription utility class
    
    Since:
    
    Sitevision 2.6.1_10
  - getSubscriberUtil
```
SubscriberUtil getSubscriberUtil()
```
    Gets an instance of an subscriber utility class
    
    Returns:
    
    a subscriber utility class
    
    Since:
    
    Sitevision 2.6.1_10
  - getInstanceTypeUtil
```
InstanceTypeUtil getInstanceTypeUtil()
```
    Gets an instance of an instance type utility class
    
    Returns:
    
    an instance type utility class
    
    Since:
    
    Sitevision 2.6.2
  - getNodeTypeUtil
```
NodeTypeUtil getNodeTypeUtil()
```
    Gets an instance of a node type utility class
    
    Returns:
    
    a node type utility class
    
    Since:
    
    Sitevision 2.6.2
  - getMetadataDefinitionUtil
```
MetadataDefinitionUtil getMetadataDefinitionUtil()
```
    Gets an instance of an metadata definition utility class
    
    Returns:
    
    a metadata definition utility class
    
    Since:
    
    Sitevision 2.6.2_04
  - getImageLinkRenderer
```
ImageLinkRenderer getImageLinkRenderer()
```
    Creates and returns a new instance of a stateful image link renderer. Since the renderer is stateful, re-use of the same instance instead of getting a new is preferred for best performance. (i.e. Just call this method once in the rendering phase of your portlet)
    
    Returns:
    
    an image link renderer
    
    Since:
    
    Sitevision 2.6.2_04
  - getMimeTypeUtil
```
MimeTypeUtil getMimeTypeUtil()
```
    Gets an instance of a MIME type utility class
    
    Returns:
    
    a MIME type utility class
    
    Since:
    
    Sitevision 3.0
  - getDocTypeUtil
```
DocTypeUtil getDocTypeUtil()
```
    Gets an instance of a DOCTYPE utility class
    
    Returns:
    
    a DOCTYPE utility class
    
    Since:
    
    Sitevision 3.0
  - getVersionedPropertyUtil
```
VersionedPropertyUtil getVersionedPropertyUtil(int aVersion)
```
    Gets an instance of a property utility class for a specified version.
    Note! This method returns an exotic sibling interface to PropertyUtil that can be used to extract property values from an other version than the one you are currently executing in. If you don't know what a version is or haven't thought much about it, you would typically use the common property extraction interface - getPropertyUtil().
    
    Parameters:
    
    aVersion - VersionUtil.OFFLINE_VERSION or VersionUtil.ONLINE_VERSION
    
    Returns:
    
    a VersionedPropertyUtil class for aVersion, i.e. OfflineVersionPropertyUtil or OnlineVersionPropertyUtil. if aVersion has an illegal value, null will be returned.
    
    Since:
    
    Sitevision 3.0
    
    See Also:
    
    PropertyUtil
  - getDeviceUtil
```
DeviceUtil getDeviceUtil()
```
    Gets an instance of a device utility class
    
    Returns:
    
    a device utility class
    
    Since:
    
    Sitevision 3.0
  - getUserUtil
```
@Deprecated
UserUtil getUserUtil()
```
    Deprecated. use getUserFactory() to get a SystemUserUtil and UserIdentityUtil instead
    
    Gets an instance of a user utility class
    
    Returns:
    
    a user utility class
    
    Since:
    
    Sitevision 3.0
  - getVelocityRenderer
```
VelocityRenderer getVelocityRenderer()
```
    Gets an instance of a Velocity renderer class.
    
    Returns:
    
    a Velocity renderer class
    
    Since:
    
    Sitevision 3.0
  - getInstanceCreatorUtil
```
InstanceCreatorUtil getInstanceCreatorUtil()
```
    Gets an instance of an instance creator utility class.
    
    Returns:
    
    an instance creator class
    
    Since:
    
    Sitevision 3.1
  - getDateUtil
```
DateUtil getDateUtil()
```
    Gets an instance of an date utility class.
    
    Returns:
    
    an date utility
    
    Since:
    
    Sitevision 3.5
  - getLandingPageUtil
```
LandingPageUtil getLandingPageUtil()
```
    Gets an instance of a landing page utility class.
    
    Returns:
    
    an landing page utility
    
    Since:
    
    Sitevision 3.5.1
  - getBuddyIconRenderer
```
BuddyIconRenderer getBuddyIconRenderer()
```
    Creates and returns a new instance of a stateful buddy icon renderer. Since the renderer is stateful, re-use of the same instance instead of getting a new is preferred for best performance. (i.e. Just call this method once in the rendering phase of your portlet)
    
    Returns:
    
    a stateful buddy icon renderer
    
    Since:
    
    Sitevision 3.5.3
  - getUserFieldRenderer
```
UserFieldRenderer getUserFieldRenderer()
```
    Creates and returns a new instance of a stateful user field renderer. Since the renderer is stateful, re-use of the same instance instead of getting a new is preferred for best performance. (i.e. Just call this method once in the rendering phase of your portlet)
    
    Returns:
    
    a stateful user field renderer
    
    Since:
    
    Sitevision 3.5.3
  - getMailUtil
```
MailUtil getMailUtil()
```
    Gets an instance of a mail utility class.
    
    Returns:
    
    a mail utility
    
    Since:
    
    Sitevision 3.6
  - getSearchFactory
```
SearchFactory getSearchFactory()
```
    Gets an instance of a factory for search-related instances.
    
    Returns:
    
    a factory for creating search-related instances
    
    Since:
    
    Sitevision 3.6
  - getLocaleUtil
```
LocaleUtil getLocaleUtil()
```
    Gets an instance of a locale utility class.
    
    Returns:
    
    an instance of a locale utility class
    
    Since:
    
    Sitevision 3.6
  - getUserFactory
```
UserFactory getUserFactory()
```
    Gets an instance of a factory for user-related instances.
    
    Returns:
    
    a factory for creating user-related instances
    
    Since:
    
    Sitevision 3.6
  - getCollaborationFactory
```
CollaborationFactory getCollaborationFactory()
```
    Gets an instance of a factory for collaboration-related instances.
    
    Returns:
    
    a factory for creating collaboration-related instances
    
    Since:
    
    Sitevision 3.6
  - getContentNodeUtil
```
ContentNodeUtil getContentNodeUtil()
```
    Gets an instance of a content node utility class.
    
    Returns:
    
    a content node utility class.
    
    Since:
    
    Sitevision 10.2
  - getNodeComparatorUtil
```
NodeComparatorUtil getNodeComparatorUtil()
```
    Gets an instance of a node comparator utility class.
    
    Returns:
    
    a node comparator utility class.
    
    Since:
    
    Sitevision 3.6
  - getNodeFilterUtil
```
NodeFilterUtil getNodeFilterUtil()
```
    Gets an instance of a node filter utility class.
    
    Returns:
    
    a node filter utility class.
    
    Since:
    
    Sitevision 3.6.2
  - getRedirectUtil
```
RedirectUtil getRedirectUtil()
```
    Gets an instance of a redirect utility class.
    
    Returns:
    
    a redirect utility class.
    
    Since:
    
    Sitevision 4.0.3
  - getNodeResolverUtil
```
NodeResolverUtil getNodeResolverUtil()
```
    Gets an instance of a node resolver utility class.
    
    Returns:
    
    a node resolver utility class
    
    Since:
    
    Sitevision 4.1
  - getNodeFactoryUtil
```
NodeFactoryUtil getNodeFactoryUtil()
```
    Gets an instance of a node factory utility class.
    
    Returns:
    
    a node factory utility class
    
    Since:
    
    Sitevision 4.1.2
  - getWebResourceFactory
```
WebResourceFactory getWebResourceFactory()
```
    Gets an instance of a web resource factory utility class.
    
    Returns:
    
    a web resource factory utility class
    
    Since:
    
    Sitevision 4.2
  - getTranslationUtil
```
TranslationUtil getTranslationUtil()
```
    Gets an instance of a translation utility class.
    
    Returns:
    
    a translation utility class
    
    Since:
    
    Sitevision 4.2.1
  - getXSLTUtil
```
XSLTUtil getXSLTUtil()
```
    Gets an instance of a XSLT utility class.
    
    Returns:
    
    a XSLT utility class
    
    Since:
    
    Sitevision 4.5
  - getTimestampUtil
```
TimestampUtil getTimestampUtil()
```
    Gets an instance of a timestamp utility class.
    
    Returns:
    
    a timestamp utility class
    
    Since:
    
    Sitevision 4.5.4.1
  - getMessageDigesterFactory
```
MessageDigesterFactory getMessageDigesterFactory()
```
    Gets an instance of a message digester factory class.
    
    Returns:
    
    a message digester factory
    
    Since:
    
    Sitevision 5.0.1
  - getXmlParserUtil
```
XmlParserUtil getXmlParserUtil()
```
    Gets an instance of a xml parser utility class.
    
    Returns:
    
    a xml parser utility class
    
    Since:
    
    Sitevision 5.1
  - getRoleUtil
```
RoleUtil getRoleUtil()
```
    Gets an instance of a role utility class.
    
    Returns:
    
    a role utility class
    
    Since:
    
    Sitevision 5.1
  - getSiteCookieUtil
```
SiteCookieUtil getSiteCookieUtil()
```
    Gets an instance of a site cookie utility class.
    
    Returns:
    
    a site cookie utility class
    
    Since:
    
    Sitevision 9.1
  - getCurrencyFactory
```
CurrencyFactory getCurrencyFactory()
```
    Gets an instance of a currency factory class.
    
    Returns:
    
    a currency factory class
    
    Since:
    
    Sitevision 6.1
  - getFormatterBuilderFactory
```
FormatterBuilderFactory getFormatterBuilderFactory()
```
    Gets an instance of a formatter builder factory class.
    
    Returns:
    
    a formatter builder factory class
    
    Since:
    
    Sitevision 6.1
  - getTextModuleRendererBuilder
```
TextModuleRendererBuilder getTextModuleRendererBuilder()
```
    Gets an instance of a Text module renderer builder class.
    
    Returns:
    
    a Text module renderer builder class
    
    Since:
    
    Sitevision 7
  - getTagUtil
```
TagUtil getTagUtil()
```
    Gets an instance of a tag utility class.
    
    Returns:
    
    a tag utility class
    
    Since:
    
    Sitevision 9.1
  - getAliasUtil
```
AliasUtil getAliasUtil()
```
    Gets an instance of an alias utility class.
    
    Returns:
    
    an alias utility class
    
    Since:
    
    Sitevision 2022.10.2
  - getMessagesFactory
```
MessagesFactory getMessagesFactory()
```
    Gets an instance of a messages factory class.
    
    Returns:
    
    a messages factory class
    
    Since:
    
    Sitevision 2024.03.01

Sitevision - Portal and Content Management Made Easy
Sitevision is an advanced Java enterprise portal product and a portlet container (JSR 286) that implements Java Content Repository (JSR 283).

Interface Utils

Method Summary

Method Detail

getPortletContextUtil

getNodeIteratorUtil

getNodeTreeUtil

getPropertyUtil

getLinkRenderer

getOutputUtil

getColorUtil

getDecorationUtil

getFontUtil

getResourceLocatorUtil

getEndecUtil

getScriptUtil

getLogUtil

getIconUtil

getPermissionUtil

getDirectoryUtil

getClientUtil

getSearchUtil

getSearchFieldUtil

getPortletUtil

getMetadataUtil

getBookmarkUtil

getPublishingUtil

getVersionUtil

getArchiveUtil

getFolderUtil

getStructureUtil

getWebContentUtil

getArticleUtil

getFileUtil

getImageUtil

getPageUtil

getTrashcanUtil

getTemplateUtil

getAuthenticationUtil

getPrincipalUtil

getFileIconRenderer

getImageRenderer

getImageScaler

getExceptionSuppressingProxy

getExceptionSuppressingCollection

getExceptionSuppressingIterator

getSubscriptionUtil

getSubscriberUtil

getInstanceTypeUtil

getNodeTypeUtil

getMetadataDefinitionUtil

getImageLinkRenderer

getMimeTypeUtil

getDocTypeUtil

getVersionedPropertyUtil

getDeviceUtil

getUserUtil

getVelocityRenderer

getInstanceCreatorUtil

getDateUtil

getLandingPageUtil

getBuddyIconRenderer

getUserFieldRenderer

getMailUtil

getSearchFactory

getLocaleUtil

getUserFactory

getCollaborationFactory

getContentNodeUtil

getNodeComparatorUtil

getNodeFilterUtil

getRedirectUtil

getNodeResolverUtil

getNodeFactoryUtil

getWebResourceFactory

getTranslationUtil

getXSLTUtil

getTimestampUtil

getMessageDigesterFactory

getXmlParserUtil

getRoleUtil