lumis.portal.documentation

Class DocumentationUtil

java.lang.Object

lumis.portal.documentation.DocumentationUtil

public class DocumentationUtil
extends Object

Documentation utilities.

Since:

9.0.0

Version:

$Revision: 19136 $ $Date: 2016-06-02 21:14:45 +0000 (Thu, 02 Jun 2016) $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentationUtil.Bag<T1,T2>
static interface	DocumentationUtil.DocumentationRunnable<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOC_PREFIX The prefix for documentation localization strings
static String	DOC_STR_PREFIX The documentation localization string added with the STR_ prefix
static String	DOC_STR_SECTION_PREFIX The document localization prefix for sections

Constructor Summary

Constructors

Constructor and Description
DocumentationUtil()

Method Summary

Modifier and Type	Method and Description
static void	addPermissionToSection(IPermission permission, IDocumentationTemplate.DocumentationSection permissionsSection, IResource resource, Locale locale) Generates a permission section.
static IDocumentationTemplate.DocumentationSectionEntry	documentationGetTemplateSectionField(IResource resource, Locale locale, Node fieldNode) Returns a single documentation section entry representing a field.
static boolean	isDocumentationDebugModeEnabled() Returns the documentationDebugModeEnabled.
static Optional<String>	localizeTargetString(String fullId, Locale locale, IResource resource) Attempt to localize a given target id by running thru all possible localization string names, prioritizing the complete names over the relative ones.
static void	processDocumentationSectionHeaderAndFooter(IDocumentationTemplate.DocumentationSection documentationSection, String qualifiedId, IResource resource, Locale locale)
static void	setDocumentationDebugModeEnabled(boolean documentationDebugModeEnabled) Sets the documentationDebugModeEnabled.
static <T> T	withTransaction(DocumentationUtil.DocumentationRunnable<T> runnable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOC_PREFIX

public static final String DOC_PREFIX

The prefix for documentation localization strings

Since:

9.0.0

See Also:

Constant Field Values

DOC_STR_PREFIX

public static final String DOC_STR_PREFIX

The documentation localization string added with the STR_ prefix

Since:

9.0.0

See Also:

Constant Field Values

DOC_STR_SECTION_PREFIX

public static final String DOC_STR_SECTION_PREFIX

The document localization prefix for sections

Since:

9.0.0

See Also:

Constant Field Values

Constructor Detail

DocumentationUtil

public DocumentationUtil()

Method Detail

isDocumentationDebugModeEnabled

public static boolean isDocumentationDebugModeEnabled()

Returns the documentationDebugModeEnabled.

Returns:

the documentationDebugModeEnabled

Since:

9.0.0

setDocumentationDebugModeEnabled

public static void setDocumentationDebugModeEnabled(boolean documentationDebugModeEnabled)

Sets the documentationDebugModeEnabled.

Parameters:

documentationDebugModeEnabled - the documentationDebugModeEnabled value to set.

Since:

9.0.0

withTransaction

public static <T> T withTransaction(DocumentationUtil.DocumentationRunnable<T> runnable)
                             throws PortalException

Throws:

PortalException

processDocumentationSectionHeaderAndFooter

public static void processDocumentationSectionHeaderAndFooter(IDocumentationTemplate.DocumentationSection documentationSection,
                                                              String qualifiedId,
                                                              IResource resource,
                                                              Locale locale)
                                                       throws PortalException

Throws:

PortalException

addPermissionToSection

public static void addPermissionToSection(IPermission permission,
                                          IDocumentationTemplate.DocumentationSection permissionsSection,
                                          IResource resource,
                                          Locale locale)
                                   throws PortalException

Generates a permission section.

Parameters:

permission - the permission for which documentation should be generated

permissionsSection - the documentation section to which permission should be inserted

resource - used to translate strings.

locale - the locale in which the documentation should be generated.

Throws:

PortalException

Since:

9.0.0

documentationGetTemplateSectionField

public static IDocumentationTemplate.DocumentationSectionEntry documentationGetTemplateSectionField(IResource resource,
                                                                                                    Locale locale,
                                                                                                    Node fieldNode)
                                                                                             throws PortalException

Returns a single documentation section entry representing a field.

Parameters:

resource - used to translate strings.

locale - the locale in which the documentation should be generated.

fieldNode - the field node used to generate the documentation section entry.

Returns:

Throws:

PortalException

Since:

9.0.0

localizeTargetString

public static Optional<String> localizeTargetString(String fullId,
                                                    Locale locale,
                                                    IResource resource)
                                             throws PortalException

Attempt to localize a given target id by running thru all possible localization string names, prioritizing the complete names over the relative ones.

Returns:

The localized string or null

Throws:

PortalException

Since:

9.0.0