Package com.atlassian.jira.util

Interface Summary

AttachmentConfig	Interface getting attachment configurations.
BaseUrl
BuildUtilsInfo	Provides version information about the currently running build of JIRA.
CacheMap<K,V>	An object that caches values that are mapped under keys.
ClockAware	Marks classes that perform time computations and are using Clocks.
Closeable	A Closeable is a source or destination of data that can be closed.
ComponentFactory	A factory that allows objects to be created through constructor dependency injection at runtime.
ComponentLocator	A locator that allows components to be looked up at runtime.
Consumer<T>	Consume the object a Supplier produces.
DateFieldFormat	Helper for handling JIRA date fields.
EmailFormatter	Returned email address appropriately masked/hidden for the current user.
ErrorCollection	A very simple interface to collect errors.
FileFactory	Interface for file operations.
Function<D,R>	A Function that resolves Descriptors (of type D) to a Resource (of type R).
GroupPermissionChecker
I18nHelper	I18nHelper is the main interface for finding internationalised text in JIRA.
I18nHelper.BeanFactory	Ths BeanFactory is used to instantiate I18nHelper instances for a specific Locale or User.
JiraContactHelper	Helper for getting User Contact information links
JiraDurationUtils.DurationFormatter	This interface defines methods for formatting time duration
JiraKey
JiraKeyUtils.KeyMatcher
KeyValuePair<K,V>	Represents a Key-Value Pair
LuceneDirectoryUtils
MessageSet	Used to communicate error and warning messages.
Named
NamedWithDescription
NamedWithId
Predicate<T>	Evaluate an input and return true or false.
Resolver<I,O>	A interface to resolve some input object into an output object.
ResourceLoader
Shutdown	Used to shut something down.
Supplier<T>	A Supplier of objects of a single type.
UserAgentUtil	Utility class for sniffer UserAgents
VelocityParamFactory	Factory that can create default Velocity Parameters for use in Velocity templates.
Visitor<T>	Callback interface for code that implements the Visitor Pattern.

Class Summary

AbstractMessageSet	Base class for the message set.
AttachmentUtils	Deprecated. Use AttachmentManager only.
AttachmentUtils.AttachmentAdapter	Deprecated. Use AttachmentStore with AttachmentStore.AttachmentAdapter.
Base64InputStreamConsumer	Basic slurp implementation of an InputStream Consumer which provides Base64 encoded output.
BaseUrlSwapper	Utility class for swapping the base of a URL.
BrowserUtils
BuildUtils	Deprecated. you shouldn't be using this class directly, use BuildUtilsInfo instead.
BuildUtilsInfoImpl	This class gives access to build-time properties at runtime.
CaseFolding	Utility for case folding Java Strings.
ClasspathResourceLoader
Clocks	Utilities for clocks.
CollectionAssert	Assertions for unit tests to use on collections.
CollectionReorderer<T>
Colours	Contains static utility methods pertaining to colour values.
CompositeClock	Composite clock that returns answer from one of the clocks it builds upon, depending on the number of times it was called already.
CompositeCloseable
CompositeShutdown	TODO: Document this class / interface here
ConcurrentCacheMap<K,V>	An implementation of CacheMap that allows null keys and values.
ConstantClock	Simple clock that returns a constant value given during construction.
DateFieldFormatImpl	Default implementation for formatting and parsing dates in JIRA.
DefaultAttachmentConfig
DefaultBaseUrl
DelimeterInserter	This can take an input string and look into it for occurences of given terms.
DomFactory
DowngradeUtilsImpl	provides access to the jira-downgrade.properties file
EasyList	Deprecated. Use Lists instead.
EmailFormatterImpl
EncodingMap	EncodingMap is a convenience class which handles conversions between IANA encoding names and Java encoding names, and vice versa.
ErrorCollectionAssert	Provides methods to help unit tests make assertions about ErrorCollection objects.
EvaluateAllPredicate<T>	A predicate that checks that all the given predicates evaulate to true for the specified input.
EventTypeOrderTransformer
ExceptionInterpreter
ExceptionInterpreterUtil	This util will feed an exception through the exception interpreter chain of responsibility.
ExceptionUtil
FileSystemFileFactory
FilterCronValidationErrorMappingUtil
Functions	Useful standard functions.
GlobalPermissionGroupAssociationUtil	This is a utility class to find out information about Permissions.ADMINISTER and Permissions.SYSTEM_ADMIN global permission information.
GroupPermissionCheckerImpl
ImportUtils	Utility code originally written to support various importers.
IOUtil	General IO Stream manipulation.
JiraArrayUtils
JiraCollectionUtils
JiraComponentFactory	Default implementation of ComponentFactory that uses JiraUtils.loadComponent(Class, java.util.Collection) and JiraUtils.loadComponent(Class).
JiraComponentLocator
JiraContactHelperImpl
JiraDateUtils
JiraDurationUtils	Util class reponsible for printing durations in various formats.
JiraDurationUtils.DaysDurationFormatter	This formatter formats time duration to days only.
JiraDurationUtils.HoursDurationFormatter	This formatter formats time duration to hours only.
JiraDurationUtils.PrettyDurationFormatter	This formatter formats time duration to "pretty" format, such as 3 weeks, 2 days, 1 hour, 15 minutes.
JiraEntityUtils
JiraKeyUtils
JiraKeyUtilsAccesor
JiraKeyUtilsAccesor.MockKeyMatcher
JiraKeyUtilsAccesor.MockProductionKeyMatcher
JiraKeyUtilsBean	Component that provides access to project and issue key utilities.
JiraTypeUtils
JiraUrlCodec	Class to wrap around the encoding of query strings.
JiraUtils	Miscellaneous utility methods.
JiraUtilsBean	A bean version of JiraUtils that can be mocked out out
JiraVelocityHelper	A simple class store methods we want to expose to velocity templates
JiraVelocityUtils	Helper class that contains a number of utility methods for velocity templates.
JiraVelocityUtils.LazyCalendar
JiraWebUtils
KeyValuePairImpl<K,V>
KeyValueParser	Parses a key-value pair in a String such as "portNumber=5432" into its separate values
LimitedOutputStream	An OutputStream that throws an LimitedOutputStream.TooBigIOException if more than the configured number of bytes are ever written to the output stream.
ListOrderedMessageSetImpl	Is a message set that keeps the messages and warnings in the order in which they were added.
LocaleParser	Static utility to parse locale Strings into Locale objects.
Lock	Used to lock resources using a file system file as a lock
LuceneDirectoryUtilsImpl
LuceneUtils	A simple utility class for our common Lucene usage methods.
MapUtils	Utility methods that work on Maps.
MeridianHour	Holder of a 12 hour time with a meridian indicator (am/pm).
MessageSet.MessageLink	A simple class for holding link text and a link url.
MessageSetImpl	Message set implementation that uses the messages natural ordering to sort the messages that are added.
MockAttachmentConfig
NameComparator	Comparison function that sorts based on the name of a Named object.
NanoStopWatch
NoopI18nFactory	A factory for NoopI18nHelper objects.
NoopI18nHelper	An I18nHelper that returns the i18n key concatenated with its arguments.
ObjectUtils
OracleDataSizeExceptionInterpreter	This implementation of ExceptionInterpreter shows links to confluence howto's on how to fix the oracle large string problem.
ParameterKeys
ParameterStore
ParameterUtils	This class can be used to "parse" values from a map of parameters.
PathUtils	This class contains utility methods for manipulating paths.
PeriodicClock	A Clock implementation that periodically increments the returned value.
PortUtil	Class that validates the value of a TCP/UDP port.
Predicates
Predicates.And<T>
Predicates.Composite<T>
Predicates.FalsePredicate<T>	A predicate that always returns false.
Predicates.Or<T>
Predicates.TruePredicate<T>	A predicate that always returns true.
RealClock	A clock implementation the returns the current time.
RegexpUtils
SimpleErrorCollection
SimpleToCronUtil	Helper class to carry out various cron conversion tasks.
Sinks
StopWatch
StreamCopyingConsumer	Copies an InputStream to the configured OutputStream.
StrictMockClock	A mock Clock that will return predefined dates and will throws exception, if called more times than the number of predefined values.
TempDirectoryUtil	This util class was added to be able to create a "temporary" directory.
UnsupportedBrowserManager	Contains a map of unsupported browsers and error message keys.
UriMatcher	Utility class for matching URIs.
UriQueryParser	This class converts the URI query parameters into a map.
UriValidator	Verify that a url is not executable Needs to be instantiated to support testing - oh PowerMock wherefore art thou
UriValidatorFactory	Instantiates an UriValidator using the encoding defined in the ApplicationProperties
UrlBuilder	Builds a URL from parameters.
URLCodec	Implements the 'www-form-urlencoded' encoding scheme, also misleadingly known as URL encoding.
UrlValidator	Performs URL validation.
UserAgentUtil.Browser
UserAgentUtil.OperatingSystem
UserAgentUtil.UserAgent
UserAgentUtilImpl	Default Implementation for Sniffing User Agents.
VelocityParamFactoryImpl
XmlReader	This handles several XML-related tasks that normal java.io Readers don't support, inluding use of IETF standard encoding names and automatic detection of most XML encodings.
ZipUtils	Simple utility functions for dealing with zip files.

Enum Summary

ErrorCollection.Reason
MessageSet.Level	Message levels
NaturalOrderStringComparator	Natural Order String Comparator compares Strings in a more "human friendly" way.
UserAgentUtil.BrowserFamily
UserAgentUtil.BrowserMajorVersion
UserAgentUtil.OperatingSystem.OperatingSystemFamily

Exception Summary

LimitedOutputStream.TooBigIOException
LockException	Thrown when a timeout has been reached while trying to obtain a lock
ParameterUtils.DateTooEarlyException	Deprecated. Only used in deprecated method.
PathTraversalException	Indicates that a potential path traversal was prevented.
RuntimeInterruptedException	Convenience class for re-throwing InterruptedException.
RuntimeIOException	An IOException was encountered and the stupid programmer didn't know how to recover, so this got thrown instead.
ValidationFailureException	A validation exception is essentially a "throwable" error collection.

Annotation Types Summary

InjectableComponent	The annotated type (a component), field (a component dependency for another class), or constructor was designed to be compatible with injection, meaning that: for Types, other classes can confidently access an instance of this type as a dependency via auto-wired injection; for Fields, they can be instantiated via auto-wired dependency injection; for Constructors, there are no parameters declared which are NonInjectableComponents, and thus should be satisfiable under default dependency injection circumstances
NonInjectableComponent	The annotated type (a component), field (a component dependency for another class), or constructor was not designed to be compatible with injection, meaning that: for Types, other classes should not attempt to access an instance of this type as a dependency via auto-wired injection, as instances of this type retain instance-specific state; for Fields, they should be instantiated manually; for Constructors, the parameters declared in them include components which are NonInjectableComponents, and thus would not be satisfiable under default dependency injection circumstances
NotNull	Deprecated. Use javax.annotation.Nonnull# instead.
OnDemand	Describes elements in JIRA code base, whose change will affect the On Demand code in terms of compilation or runtime behaviour.