org.openide.util
Class Lookup

java.lang.Object
  |
  +--org.openide.util.Lookup

Direct Known Subclasses:

AbstractLookup, ProxyLookup

public abstract class Lookup

extends Object

A general registrar permitting clients to find instances of services.

Inner Class Summary

static class	Lookup.Item A single item in a lookup result.
static class	Lookup.Result Result of a lookup request.
static class	Lookup.Template Template defining a pattern to filter instances by.

Field Summary

static Lookup

EMPTY A dummy lookup that never returns any results.

Constructor Summary

Lookup()
Empty constructor for use by subclasses.

Method Summary

static Lookup	getDefault() Static method to obtain the global lookup in the whole system.
abstract Object	lookup(Class clazz) Look up an object matching a given interface.
abstract Lookup.Result	lookup(Lookup.Template template) The general lookup method.
Lookup.Item	lookupItem(Lookup.Template template) Look up the first item matching a given template.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final Lookup EMPTY

A dummy lookup that never returns any results.

Constructor Detail

Lookup

public Lookup()

Empty constructor for use by subclasses.

Method Detail

getDefault

public static Lookup getDefault()

Static method to obtain the global lookup in the whole system.

Returns:

the global lookup in the system

lookup

public abstract Object lookup(Class clazz)

Look up an object matching a given interface. This is the simplest method to use. If more than one object matches, one will be returned arbitrarily. The template class may be a class or interface; the instance is guaranteed to be assignable to it.

Parameters:

clazz - class of the object we are searching for

Returns:

an object implementing the given class or null if no such implementation is found

lookup

public abstract Lookup.Result lookup(Lookup.Template template)

The general lookup method.

Parameters:

template - a template describing the services to look for

Returns:

an object containing the results

lookupItem

public Lookup.Item lookupItem(Lookup.Template template)

Look up the first item matching a given template. Includes not only the instance but other associated information.

Parameters:

template - the template to check

Returns:

a matching item or null

Since:

1.8