Package com.atlan.cache

Class EnumCache

java.lang.Object

com.atlan.cache.EnumCache

public class EnumCache
extends Object

Lazily-loaded cache for accessing details of an enumeration.

Constructor Summary

Constructors

Constructor	Description
EnumCache(TypeDefsEndpoint typeDefsEndpoint)

Method Summary

Modifier and Type	Method	Description
EnumDef	getByName(String name)	Retrieve the enumeration definition by its name.
EnumDef	getByName(String name, boolean allowRefresh)	Retrieve the enumeration definition by its name.
protected EnumDef	getObjectByName(String name)	Thread-safe cache retrieval of the enumeration typedef, by its name.
void	refreshCache()	Refreshes the cache of enumerations by requesting the full set of enumerations from Atlan.

Methods inherited from class java.lang.Object

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

Constructor Details

EnumCache

public EnumCache(TypeDefsEndpoint typeDefsEndpoint)

Method Details

refreshCache

public void refreshCache()
                  throws AtlanException

Refreshes the cache of enumerations by requesting the full set of enumerations from Atlan.

Throws:

AtlanException - on any API communication problem

getObjectByName

protected EnumDef getObjectByName(String name)

Thread-safe cache retrieval of the enumeration typedef, by its name.

Parameters:

name - of the EnumDef

Returns:

the enumeration typedef itself (if cached), or null

getByName

public EnumDef getByName(String name)
                  throws AtlanException

Retrieve the enumeration definition by its name.

Parameters:

name - human-readable name of the enumeration

Returns:

the enumeration definition

Throws:

AtlanException - on any API communication problem if the cache needs to be refreshed

NotFoundException - if the enumeration cannot be found (does not exist) in Atlan

InvalidRequestException - if no name was provided for the enumeration to retrieve

getByName

public EnumDef getByName(String name,
 boolean allowRefresh)
                  throws AtlanException

Retrieve the enumeration definition by its name.

Parameters:

name - human-readable name of the enumeration

allowRefresh - whether to allow a refresh of the cache (true) or not (false)

Returns:

the enumeration definition

Throws:

AtlanException - on any API communication problem if the cache needs to be refreshed

NotFoundException - if the enumeration cannot be found (does not exist) in Atlan

InvalidRequestException - if no name was provided for the enumeration to retrieve