org.springframework.cloud.context.scope

Interface ScopeCache

All Known Implementing Classes:

StandardScopeCache, ThreadLocalScopeCache

public interface ScopeCache

A special purpose cache interface specifically for the GenericScope to use to manage cached bean instances. Implementations generally fall into two categories: those that store values "globally" (i.e. one instance per key), and those that store potentially multiple instances per key based on context (e.g. via a thread local). All implementations should be thread safe.

Author:

Dave Syer

Method Summary

Modifier and Type	Method and Description
Collection<Object>	clear() Clear the cache and return all objects in an unmodifiable collection.
Object	get(String name) Get the named object from the cache.
Object	put(String name, Object value) Put a value in the cache if the key is not already used.
Object	remove(String name) Remove the object with this name from the cache.

Method Detail

remove

Object remove(String name)

Remove the object with this name from the cache.

Parameters:

name - the object name

Returns:

the object removed or null if there was none

clear

Collection<Object> clear()

Clear the cache and return all objects in an unmodifiable collection.

Returns:

all objects stored in the cache

get

Object get(String name)

Get the named object from the cache.

Parameters:

name - the name of the object

Returns:

the object with that name or null if there is none

put

Object put(String name,
           Object value)

Put a value in the cache if the key is not already used. If one is already present with the name provided, it is not replaced, but is returned to the caller.

Parameters:

name - the key

value - the new candidate value

Returns:

the value that is in the cache at the end of the operation