Modifier and Type	Class and Description
public static enum	ServiceLocatorFactory.CreatePolicy Tells the create method what to do if an existing ServiceLocator with the given name exists

Modifier and Type	Field and Description
private static ServiceLocatorFactory	INSTANCE

Access	Constructor and Description
public	ServiceLocatorFactory()

Method Summary

Modifier and Type	Method and Description
public abstract void	addListener(ServiceLocatorListener The non-null listener to add to the system listener) Adds a service listener to the unordered set of listeners that will be notified when named listeners are added or removed from the system.
public abstract ServiceLocator	Returns: The created or found named ServiceLocator create(String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system name) Creates (or finds) a ServiceLocator.
public abstract ServiceLocator	Returns: The created or found named ServiceLocator create(String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system name, ServiceLocator The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented parent) Creates or finds a ServiceLocator.
public abstract ServiceLocator	Returns: The created or found named ServiceLocator create(String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system name, ServiceLocator The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented parent, ServiceLocatorGenerator An implementation of the generator interface that can be used to provide an implementation of ServiceLocator. If null then the generator used will be discovered from the OSGi service registry or from META-INF/services generator) Creates or finds a ServiceLocator.
public abstract ServiceLocator	Returns: The created or found named ServiceLocator create(String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system name, ServiceLocator The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented parent, ServiceLocatorGenerator An implementation of the generator interface that can be used to provide an implementation of ServiceLocator. If null then the generator used will be discovered from the OSGi service registry or from META-INF/services generator, ServiceLocatorFactory.CreatePolicy The policy that should be used if there is an existing locator with the non-null name. If null the policy of RETURN will be used policy) Creates a ServiceLocator.
public abstract void	destroy(String The name of the ServiceLocator to destroy name) Removes the ServiceLocator with this name All services associated with this ServiceLocator will be shutdown
public abstract void	destroy(ServiceLocator The ServiceLocator to destroy. If null this will do nothing. If the ServiceLocator given was already destroyed this will do nothing locator) Removes the given ServiceLocator All services associated with this ServiceLocator will be shutdown
public abstract ServiceLocator	Returns: The ServiceLocator with the given name, or null if there is no ServiceLocator with that name find(String May not be null, is the name of the ServiceLocator to find name) Finds the ServiceLocator with this name
public static ServiceLocatorFactory	Returns: The factory to use to create service locators getInstance() This will return a factory where the ServiceLocatorGenerator is discovered from the META-INF/services of the process
public abstract void	removeListener(ServiceLocatorListener The non-null listener to remove from the system listener) Removes a service listener from the set of listeners that are notified when named listeners are added or removed from the system

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

INSTANCE	back to summary
private static ServiceLocatorFactory INSTANCE

Constructor Detail

ServiceLocatorFactory	back to summary
public ServiceLocatorFactory()

Method Detail

addListener	back to summary
public abstract void addListener(ServiceLocatorListener listener) Adds a service listener to the unordered set of listeners that will be notified when named listeners are added or removed from the system. If this listener is already registered this method does nothing Parameters listener:ServiceLocatorListener The non-null listener to add to the system

addListener

back to summary

public abstract void addListener(ServiceLocatorListener listener)

Adds a service listener to the unordered set of listeners that will be notified when named listeners are added or removed from the system. If this listener is already registered this method does nothing

Parameters

listener:ServiceLocatorListener: The non-null listener to add to the system

create	back to summary
public abstract ServiceLocator create(String name) Creates (or finds) a ServiceLocator. If there is already a ServiceLocator with the given name then this method will return that locator. Parameters name:String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system Returns:ServiceLocator The created or found named ServiceLocator

create

back to summary

public abstract ServiceLocator create(String name)

Creates (or finds) a ServiceLocator.

If there is already a ServiceLocator with the given name then this method will return that locator.

Parameters

name:String: The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system

Returns:ServiceLocator

The created or found named ServiceLocator

create	back to summary
public abstract ServiceLocator create(String name, ServiceLocator parent) Creates or finds a ServiceLocator. If there is already a ServiceLocator with the given name then this method will return that ServiceLocator. The parent argument will be ignored in that case Parameters name:String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system parent:ServiceLocator The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented Returns:ServiceLocator The created or found named ServiceLocator

create

back to summary

public abstract ServiceLocator create(String name, ServiceLocator parent)

Creates or finds a ServiceLocator.

If there is already a ServiceLocator with the given name then this method will return that ServiceLocator. The parent argument will be ignored in that case

Parameters

name:String: The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system
parent:ServiceLocator: The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented

Returns:ServiceLocator

The created or found named ServiceLocator

create	back to summary
public abstract ServiceLocator create(String name, ServiceLocator parent, ServiceLocatorGenerator generator) Creates or finds a ServiceLocator. If there is already a ServiceLocator with the given name then this method will return that ServiceLocator. The parent argument will be ignored in that case. If a null name is given then a new ServiceLocator with a generated name will be returned. Parameters name:String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system parent:ServiceLocator The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented generator:ServiceLocatorGenerator An implementation of the generator interface that can be used to provide an implementation of ServiceLocator. If null then the generator used will be discovered from the OSGi service registry or from META-INF/services Returns:ServiceLocator The created or found named ServiceLocator

create

back to summary

public abstract ServiceLocator create(String name, ServiceLocator parent, ServiceLocatorGenerator generator)

Creates or finds a ServiceLocator.

If there is already a ServiceLocator with the given name then this method will return that ServiceLocator. The parent argument will be ignored in that case. If a null name is given then a new ServiceLocator with a generated name will be returned.

Parameters

name:String: The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system
parent:ServiceLocator: The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented
generator:ServiceLocatorGenerator: An implementation of the generator interface that can be used to provide an implementation of ServiceLocator. If null then the generator used will be discovered from the OSGi service registry or from META-INF/services

Returns:ServiceLocator

The created or found named ServiceLocator

create	back to summary
public abstract ServiceLocator create(String name, ServiceLocator parent, ServiceLocatorGenerator generator, ServiceLocatorFactory.CreatePolicy policy) Creates a ServiceLocator. If there is already a ServiceLocator with the given name then this method will honor the given CreatePolicy. return that ServiceLocator. The policies are RETURN: Return the existing locator DESTOY: Destroy the existing locator ERROR: Throw an IllegalStateException exception Parameters name:String The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system parent:ServiceLocator The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented generator:ServiceLocatorGenerator An implementation of the generator interface that can be used to provide an implementation of ServiceLocator. If null then the generator used will be discovered from the OSGi service registry or from META-INF/services policy:ServiceLocatorFactory.CreatePolicy The policy that should be used if there is an existing locator with the non-null name. If null the policy of RETURN will be used Returns:ServiceLocator The created or found named ServiceLocator

create

back to summary

public abstract ServiceLocator create(String name, ServiceLocator parent, ServiceLocatorGenerator generator, ServiceLocatorFactory.CreatePolicy policy)

Creates a ServiceLocator.

If there is already a ServiceLocator with the given name then this method will honor the given CreatePolicy. return that ServiceLocator. The policies are

RETURN: Return the existing locator
DESTOY: Destroy the existing locator
ERROR: Throw an IllegalStateException exception

Parameters

name:String: The name of this service locator. Passing a null name will result in a newly created service locator with a generated name and that will not be tracked by the system
parent:ServiceLocator: The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null if the returned ServiceLocator should not be parented
generator:ServiceLocatorGenerator: An implementation of the generator interface that can be used to provide an implementation of ServiceLocator. If null then the generator used will be discovered from the OSGi service registry or from META-INF/services
policy:ServiceLocatorFactory.CreatePolicy: The policy that should be used if there is an existing locator with the non-null name. If null the policy of RETURN will be used

Returns:ServiceLocator

The created or found named ServiceLocator

destroy	back to summary
public abstract void destroy(String name) Removes the ServiceLocator with this name All services associated with this ServiceLocator will be shutdown Parameters name:String The name of the ServiceLocator to destroy

destroy

back to summary

public abstract void destroy(String name)

Removes the ServiceLocator with this name

All services associated with this ServiceLocator will be shutdown

Parameters

name:String: The name of the ServiceLocator to destroy

destroy	back to summary
public abstract void destroy(ServiceLocator locator) Removes the given ServiceLocator All services associated with this ServiceLocator will be shutdown Parameters locator:ServiceLocator The ServiceLocator to destroy. If null this will do nothing. If the ServiceLocator given was already destroyed this will do nothing

destroy

back to summary

public abstract void destroy(ServiceLocator locator)

Removes the given ServiceLocator

All services associated with this ServiceLocator will be shutdown

Parameters

locator:ServiceLocator: The ServiceLocator to destroy. If null this will do nothing. If the ServiceLocator given was already destroyed this will do nothing

find	back to summary
public abstract ServiceLocator find(String name) Finds the ServiceLocator with this name Parameters name:String May not be null, is the name of the ServiceLocator to find Returns:ServiceLocator The ServiceLocator with the given name, or null if there is no ServiceLocator with that name

find

back to summary

public abstract ServiceLocator find(String name)

Finds the ServiceLocator with this name

Parameters

name:String: May not be null, is the name of the ServiceLocator to find

Returns:ServiceLocator

The ServiceLocator with the given name, or null if there is no ServiceLocator with that name

getInstance	back to summary
public static ServiceLocatorFactory getInstance() This will return a factory where the ServiceLocatorGenerator is discovered from the META-INF/services of the process Returns:ServiceLocatorFactory The factory to use to create service locators

getInstance

back to summary

public static ServiceLocatorFactory getInstance()

This will return a factory where the ServiceLocatorGenerator is discovered from the META-INF/services of the process

Returns:ServiceLocatorFactory: The factory to use to create service locators

removeListener	back to summary
public abstract void removeListener(ServiceLocatorListener listener) Removes a service listener from the set of listeners that are notified when named listeners are added or removed from the system Parameters listener:ServiceLocatorListener The non-null listener to remove from the system

removeListener

back to summary

public abstract void removeListener(ServiceLocatorListener listener)

Removes a service listener from the set of listeners that are notified when named listeners are added or removed from the system

Parameters

listener:ServiceLocatorListener: The non-null listener to remove from the system

org.glassfish.hk2.api back to summary

public final Enum ServiceLocatorFactory.CreatePolicy

Class Inheritance

extends Enum<ServiceLocatorFactory.CreatePolicy>

java.lang.Object
java.lang.Enum
org.glassfish.hk2.api.ServiceLocatorFactory.CreatePolicy

Tells the create method what to do if an existing ServiceLocator with the given name exists

Author: jwells

Field Summary

Modifier and Type	Field and Description
public static final ServiceLocatorFactory.CreatePolicy	DESTROY Destroy the existing ServiceLocator
public static final ServiceLocatorFactory.CreatePolicy	ERROR Throw an IllegalStateException
public static final ServiceLocatorFactory.CreatePolicy	RETURN Return the existing ServiceLocator

Constructor Summary

Access	Constructor and Description
private	CreatePolicy()

Method Summary

Modifier and Type	Method and Description
public static ServiceLocatorFactory.CreatePolicy	valueOf(String name)
public static ServiceLocatorFactory.CreatePolicy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DESTROY	back to summary
public static final ServiceLocatorFactory.CreatePolicy DESTROY Destroy the existing ServiceLocator

ERROR	back to summary
public static final ServiceLocatorFactory.CreatePolicy ERROR Throw an IllegalStateException

RETURN	back to summary
public static final ServiceLocatorFactory.CreatePolicy RETURN Return the existing ServiceLocator

Constructor Detail

CreatePolicy	back to summary
private CreatePolicy()

Method Detail

valueOf	back to summary
public static ServiceLocatorFactory.CreatePolicy valueOf(String name)

values	back to summary
public static ServiceLocatorFactory.CreatePolicy[] values()

public abstract Class ServiceLocatorFactory

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ServiceLocatorFactory.CreatePolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail