com.cedarsoft.lookup

Interface Lookup

All Known Subinterfaces:

LookupStore

All Known Implementing Classes:

AbstractLookup, DynamicLookup, InstantiatorLookup, LazyLookup, LookupWrapper, MappedLookup, MergingLookup, SingletonLookup

public interface Lookup

A lookup offers a simple way to get "extensions" of the current object.

Author:

Johannes Schneider (js@cedarsoft.com)

Method Summary

Modifier and Type	Method and Description
<T> void	addChangeListener(Class<T> type, LookupChangeListener<? super T> lookupChangeListener) Add a lookup change listener for a given type
void	addChangeListener(LookupChangeListener<?> lookupChangeListener) Adds a lookup change listener
<T> void	addChangeListenerWeak(Class<T> type, LookupChangeListener<? super T> lookupChangeListener) Add a lookup change listener that is wrapped within a WeakLookupChangeListener for a given type
void	addChangeListenerWeak(LookupChangeListener<?> lookupChangeListener) Adds a lookup change listener that is wrapped within a WeakLookupChangeListener
<T> void	bind(Class<T> type, LookupChangeListener<? super T> lookupChangeListener) Binds the given lookup change listener.
<T> void	bind(TypedLookupChangeListener<T> lookupChangeListener) Binds the given lookup change listener with the key retrieved from TypedLookupChangeListener#getType().
<T> void	bindWeak(Class<T> type, LookupChangeListener<? super T> lookupChangeListener) Binds the given lookup change listener that is wrapped within a WeakLookupChangeListener.
<T> void	bindWeak(TypedLookupChangeListener<T> lookupChangeListener) Binds the given lookup change listener (that is wrapped within a WeakLookupChangeListener) with the key retrieved from TypedLookupChangeListener#getType().
<T> T	lookup(Class<T> type) Lookup a given object
<T> T	lookupNonNull(Class<T> type) Lookks up a given object
Map<Class<?>,Object>	lookups() Returns a map containing the available lookup objects.
<T> void	removeChangeListener(Class<T> type, LookupChangeListener<? super T> lookupChangeListener) Remove a lookup change listener from the given type
void	removeChangeListener(LookupChangeListener<?> lookupChangeListener) Remove a lookup change listener

Method Detail

lookup

@Nullable
<T> T lookup(@Nonnull
                       Class<T> type)

Lookup a given object

Type Parameters:

T - a T object.

Parameters:

type - the type

Returns:

the lookup object or null if nothing has been found

lookupNonNull

@Nonnull
<T> T lookupNonNull(@Nonnull
                             Class<T> type)
                      throws IllegalArgumentException

Lookks up a given object

Type Parameters:

T - a T object.

Parameters:

type - the type

Returns:

the looked up object

Throws:

IllegalArgumentException - if no object has been found

lookups

@Nonnull
Map<Class<?>,Object> lookups()

Returns a map containing the available lookup objects. This method can throw an UnsupportedOperationException if the map is not available. If no exception is thrown the map must contain every possible lookup object.

Returns:

a map containing the available lookup objects.

Throws:

UnsupportedOperationException - if this method is not supported

bind

<T> void bind(@Nonnull
              Class<T> type,
              @Nonnull
              LookupChangeListener<? super T> lookupChangeListener)

Binds the given lookup change listener. Adds the given listener and calls LookupChangeListener#lookupChanged(LookupChangeEvent) for the first time.

Type Parameters:

T - a T object.

Parameters:

lookupChangeListener - the listener that is added

type - a Class object.

bind

<T> void bind(@Nonnull
              TypedLookupChangeListener<T> lookupChangeListener)

Binds the given lookup change listener with the key retrieved from TypedLookupChangeListener#getType(). Adds the given listener and calls LookupChangeListener#lookupChanged(LookupChangeEvent) for the first time.

Type Parameters:

T - a T object.

Parameters:

lookupChangeListener - the listener that is added

bindWeak

<T> void bindWeak(@Nonnull
                  Class<T> type,
                  @Nonnull
                  LookupChangeListener<? super T> lookupChangeListener)

Binds the given lookup change listener that is wrapped within a WeakLookupChangeListener. Adds the given listener and calls LookupChangeListener#lookupChanged(LookupChangeEvent) for the first time.

Type Parameters:

T - a T object.

Parameters:

lookupChangeListener - the listener that is added

type - a Class object.

bindWeak

<T> void bindWeak(@Nonnull
                  TypedLookupChangeListener<T> lookupChangeListener)

Binds the given lookup change listener (that is wrapped within a WeakLookupChangeListener) with the key retrieved from TypedLookupChangeListener#getType(). Adds the given listener and calls LookupChangeListener#lookupChanged(LookupChangeEvent) for the first time.

Type Parameters:

T - a T object.

Parameters:

lookupChangeListener - the listener that is added

addChangeListener

void addChangeListener(@Nonnull
                       LookupChangeListener<?> lookupChangeListener)

Adds a lookup change listener

Parameters:

lookupChangeListener - the lookup change listener

addChangeListener

<T> void addChangeListener(@Nonnull
                           Class<T> type,
                           @Nonnull
                           LookupChangeListener<? super T> lookupChangeListener)

Add a lookup change listener for a given type

Type Parameters:

T - a T object.

Parameters:

type - the type

lookupChangeListener - the listener

addChangeListenerWeak

void addChangeListenerWeak(@Nonnull
                           LookupChangeListener<?> lookupChangeListener)

Adds a lookup change listener that is wrapped within a WeakLookupChangeListener

Parameters:

lookupChangeListener - the lookup change listener

addChangeListenerWeak

<T> void addChangeListenerWeak(@Nonnull
                               Class<T> type,
                               @Nonnull
                               LookupChangeListener<? super T> lookupChangeListener)

Add a lookup change listener that is wrapped within a WeakLookupChangeListener for a given type

Type Parameters:

T - a T object.

Parameters:

type - the type

lookupChangeListener - the listener

removeChangeListener

void removeChangeListener(@Nonnull
                          LookupChangeListener<?> lookupChangeListener)

Remove a lookup change listener

Parameters:

lookupChangeListener - the listener that is removed from *all* types

removeChangeListener

<T> void removeChangeListener(@Nonnull
                              Class<T> type,
                              @Nonnull
                              LookupChangeListener<? super T> lookupChangeListener)

Remove a lookup change listener from the given type

Type Parameters:

T - a T object.

Parameters:

type - the type of the listener

lookupChangeListener - the listener