com.helger.commons.datetime

Class DateTimeFormatterCache

java.lang.Object

com.helger.commons.cache.AbstractCache<KEYTYPE,VALUETYPE>

com.helger.commons.cache.AbstractNotifyingCache<DateTimeFormatterPattern,DateTimeFormatter>

com.helger.commons.datetime.DateTimeFormatterCache

All Implemented Interfaces:

ICache<DateTimeFormatterPattern,DateTimeFormatter>, IMutableCache<DateTimeFormatterPattern,DateTimeFormatter>, IHasSize, IHasName

@ThreadSafe
 @Singleton
public final class DateTimeFormatterCache
extends AbstractNotifyingCache<DateTimeFormatterPattern,DateTimeFormatter>

This class provides a cache for DateTimeFormatter instances. It caches up to a limited number of compiled DateTimeFormatter objects.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CACHE_SIZE The default number of items to keep in the cache

Fields inherited from class com.helger.commons.cache.AbstractCache

m_aCacheAccessStats, m_aRWLock, STATISTICS_PREFIX

Method Summary

Modifier and Type	Method and Description
static DateTimeFormatter	getDateTimeFormatter(String sPattern, ResolverStyle eResolverStyle) Get the cached DateTimeFormatter using the provided resolver style.
static DateTimeFormatter	getDateTimeFormatterLenient(String sPattern) Get the cached DateTimeFormatter using LENIENT resolving.
static DateTimeFormatter	getDateTimeFormatterSmart(String sPattern) Get the cached DateTimeFormatter using SMART resolving.
static DateTimeFormatter	getDateTimeFormatterStrict(String sPattern) Get the cached DateTimeFormatter using STRICT resolving.
static DateTimeFormatterCache	getInstance()
protected DateTimeFormatter	getValueToCache(DateTimeFormatterPattern aPattern) This abstract method is invoked, once a new value needs to be put into the cache.
static boolean	isInstantiated()

Methods inherited from class com.helger.commons.cache.AbstractNotifyingCache

getFromCache

Methods inherited from class com.helger.commons.cache.AbstractCache

clearCache, createCache, getFromCacheNoStats, getFromCacheNoStatsNotLocked, getFromCacheNotLocked, getMaxSize, getName, getSize, hasMaxSize, isEmpty, isNotEmpty, putInCache, putInCacheNotLocked, removeFromCache, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.name.IHasName

getComparatorCollating, getComparatorName

Field Detail

MAX_CACHE_SIZE

public static final int MAX_CACHE_SIZE

The default number of items to keep in the cache

See Also:

Constant Field Values

Method Detail

isInstantiated

public static boolean isInstantiated()

getInstance

@Nonnull
public static DateTimeFormatterCache getInstance()

getValueToCache

@Nonnull
 @IsLocked(value=WRITE)
protected DateTimeFormatter getValueToCache(@Nonnull
                                                                               DateTimeFormatterPattern aPattern)

Description copied from class: AbstractNotifyingCache

This abstract method is invoked, once a new value needs to be put into the cache. This method is invoked within a locked section.

Specified by:

getValueToCache in class AbstractNotifyingCache<DateTimeFormatterPattern,DateTimeFormatter>

Parameters:

aPattern - The key for which the value to cache is required. May be nullable or not - depends upon the implementation.

Returns:

The value to be cached. May not be null.

getDateTimeFormatterStrict

@Nonnull
public static DateTimeFormatter getDateTimeFormatterStrict(@Nonnull @Nonempty
                                                                     String sPattern)

Get the cached DateTimeFormatter using STRICT resolving.

Parameters:

sPattern - The pattern to retrieve. May neither be null nor empty.

Returns:

The compiled DateTimeFormatter and never null .

Throws:

IllegalArgumentException - If the pattern is invalid

getDateTimeFormatterSmart

@Nonnull
public static DateTimeFormatter getDateTimeFormatterSmart(@Nonnull @Nonempty
                                                                    String sPattern)

Get the cached DateTimeFormatter using SMART resolving.

Parameters:

sPattern - The pattern to retrieve. May neither be null nor empty.

Returns:

The compiled DateTimeFormatter and never null .

Throws:

IllegalArgumentException - If the pattern is invalid

getDateTimeFormatterLenient

@Nonnull
public static DateTimeFormatter getDateTimeFormatterLenient(@Nonnull @Nonempty
                                                                      String sPattern)

Get the cached DateTimeFormatter using LENIENT resolving.

Parameters:

sPattern - The pattern to retrieve. May neither be null nor empty.

Returns:

The compiled DateTimeFormatter and never null .

Throws:

IllegalArgumentException - If the pattern is invalid

getDateTimeFormatter

@Nonnull
public static DateTimeFormatter getDateTimeFormatter(@Nonnull @Nonempty
                                                               String sPattern,
                                                               @Nonnull
                                                               ResolverStyle eResolverStyle)

Get the cached DateTimeFormatter using the provided resolver style.

Parameters:

sPattern - The pattern to retrieve. May neither be null nor empty.

eResolverStyle - The resolver style to be used. May not be null.

Returns:

The compiled DateTimeFormatter and never null.

Throws:

IllegalArgumentException - If the pattern is invalid