Package org.opencms.util

Utility functions for String manipulation and other often used tasks.

Since:

6.0.0

Interface Summary

Interface	Description
I_CmsCloseable	Closeable interface that throws no exceptions.
I_CmsHtmlConverter	HTML converters can be used to clean up HTML code and/or pretty print the code.
I_CmsHtmlNodeVisitor	Interface for a combination of a visitor of HTML documents along with the hook to start the parser / lexer that triggers the visit.
I_CmsMacroResolver	Describes a macro mapper, which is used to efficiently resolve macros in the form of %(key) or ${key} in an input String.
I_CmsRegexSubstitution	Interface for generating a substitution for a pattern in a string.

Class Summary

Class	Description
A_CmsHtmlConverter
A_CmsModeIntEnumeration	Base class for all integer mode enumeration classes.
A_CmsModeStringEnumeration	Base class for all string mode enumeration classes.
CmsByteArrayDataSource	A DataSource backed by a byte array.
CmsCollectionsGenericWrapper	Provides Map wrapping utility functions for Java generics.
CmsCollectionsGenericWrapper.MapWrapper<K,V>	Wrapper for lazy maps providing a better containsKey implementation.
CmsConstantMap<K,V>	Returns the constant Object the map was initialized with for all CmsConstantMap.get(Object) calls, regardless of what the actual key is.
CmsDataTypeUtil	Utilities to handle basic data types.
CmsDateUtil	Utilities to get and set formated dates in OpenCms.
CmsDefaultSet<T>	A utility class used for keeping track of a set of objects.
CmsExpiringValue<T>	Simple utility class for caching a single value with a given cache expiration time.
CmsFileUtil	Provides File utility functions.
CmsFileUtil.FileWalkState	Data bean which walkFileSystem passes to its callback.
CmsGeoUtil	Utility methods for processing geo coordinates.
CmsHtml2TextConverter	Extracts the HTML page content.
CmsHtmlConverter	HTML cleaner and pretty printer.
CmsHtmlConverterJTidy	HTML cleaner and pretty printer using JTidy.
CmsHtmlConverterOption	Represents a single HTML converter configuration as defined in the OpenCms configuration file opencms-vfs.xml.
CmsHtmlExtractor	Extracts plain text from HTML.
CmsHtmlParser	Base utility class for OpenCms NodeVisitor implementations, which provides some often used utility functions.
CmsHtmlStripper	Simple html tag stripper that allows configuration of html tag names that are allowed.
CmsHtmlTagRemoveFactory	A tag factory for htmlparser that is able to "remove tags".
CmsHtmlValidator	Validates HTML.
CmsJsonUtil	Utility class for JSON-related functions.
CmsLog4jUtil	Utilities for dealing with log4j loggers.
CmsMacroResolver	Resolves macros in the form of %(key) or ${key} in an input String.
CmsManyToOneMap<K,V>	Special collection class which allows lookup from keys to values and from values to sets of keys.
CmsNoAutoCloseTag	A TagNode with an arbitrary name which is misused for avoiding the creation of the corresponding end tag in case the HTML to parse is not balanced.
CmsNullIgnoringConcurrentMap<K,V>	Wrapper around ConcurrentHashMap which allows null values.
CmsPair<A,B>	Generic pair class.
CmsParameterEscaper	This class is responsible for automatically escaping parameters in Flex requests.
CmsPath	Simple data holder class which stores a path in a normalized form.
CmsPathMap<V>	Data structure which stores contents indexed by path.
CmsPathTree<P,V>	Tree used to represent file system like data structures.
CmsRequestUtil	Provides utility functions for dealing with values a HttpServletRequest.
CmsResourceTranslator	Provides a resource name / path translation facility.
CmsRfsFileViewer	The representation of a RFS file along with the settings to provide access to certain portions (amount of lines) of it.
CmsSplitPrintStream
CmsStringUtil	Provides String utility functions.
CmsStringUtil.CmsSlashComparator	Compares two Strings according to the count of containing slashes.
CmsTaskWatcher	Helper class for building diagnostics code that tracks potentially long running operations.
CmsThreadLocalStack<T>	Thread local stack.
CmsTreeNode<T>	Generic tree node which can contain an object of generic type T as data, and which has a mutable list of child nodes.
CmsUriSplitter	Splits an URI String into separate components.
CmsUUID	Generates a UUID using spatial and temporal uniqueness.
CmsUUID_CustomFieldSerializer	GWT serializer for CmsUUID.
CmsVfsUtil	Provides Vfs utility functions.
CmsWaitHandle	Low-level utility class used for waiting for an action performed by another thread.
CmsXmlSaxWriter	Simple SAX event handler that generates a XML (or HTML) file from the events caught.
CmsXsltUtil	Provides utility functions for XSLT transformations.
Messages	Convenience class to access the localized messages of this OpenCms package.
PrintfFormat	PrintfFormat allows the formatting of an array of objects embedded within a string.

Exception Summary

Exception	Description
CmsRfsException	Used to signal issues with the real local file system (RFS), for example during file access.