org.jboss.gravia.resolver.spi

Class AbstractResolveContext

java.lang.Object

org.jboss.gravia.resolver.spi.AbstractResolveContext

All Implemented Interfaces:

ResolveContext

Direct Known Subclasses:

DefaultResolveContext

public abstract class AbstractResolveContext
extends Object
implements ResolveContext

The abstract implementation of a ResolveContext.

Since:

02-Apr-2012

Author:

thomas.diesler@jboss.com

Constructor Summary

Constructors

Constructor and Description
AbstractResolveContext(Environment environment, Set<org.jboss.gravia.resource.Resource> manres, Set<org.jboss.gravia.resource.Resource> optres)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract PreferencePolicy	createPreferencePolicy()
List<org.jboss.gravia.resource.Capability>	findProviders(org.jboss.gravia.resource.Requirement req) Find Capabilities that match the given Requirement.
Collection<org.jboss.gravia.resource.Resource>	getMandatoryResources() Return the resources that must be resolved for this resolve context.
Collection<org.jboss.gravia.resource.Resource>	getOptionalResources() Return the resources that the resolver should attempt to resolve for this resolve context.
Map<org.jboss.gravia.resource.Resource,org.jboss.gravia.runtime.Wiring>	getWirings() Returns the wirings for existing resolved resources.
boolean	isEffective(org.jboss.gravia.resource.Requirement req) Test if a given requirement should be wired in the resolve operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResolveContext

public AbstractResolveContext(Environment environment,
                      Set<org.jboss.gravia.resource.Resource> manres,
                      Set<org.jboss.gravia.resource.Resource> optres)

Method Detail

createPreferencePolicy

protected abstract PreferencePolicy createPreferencePolicy()

getMandatoryResources

public Collection<org.jboss.gravia.resource.Resource> getMandatoryResources()

Description copied from interface: ResolveContext

Return the resources that must be resolved for this resolve context.

The default implementation returns an empty collection.

Specified by:

getMandatoryResources in interface ResolveContext

Returns:

The resources that must be resolved for this resolve context. May be empty if there are no mandatory resources.

getOptionalResources

public Collection<org.jboss.gravia.resource.Resource> getOptionalResources()

Description copied from interface: ResolveContext

Return the resources that the resolver should attempt to resolve for this resolve context. Inability to resolve one of the specified resources will not result in a resolution exception.

The default implementation returns an empty collection.

Specified by:

getOptionalResources in interface ResolveContext

Returns:

The resources that the resolver should attempt to resolve for this resolve context. May be empty if there are no mandatory resources.

isEffective

public boolean isEffective(org.jboss.gravia.resource.Requirement req)

Description copied from interface: ResolveContext

Test if a given requirement should be wired in the resolve operation. If this method returns false, then the resolver should ignore this requirement during the resolve operation.

The primary use case for this is to test the effective directive on the requirement, though implementations are free to use any effective test.

Specified by:

isEffective in interface ResolveContext

Parameters:

req - The Requirement to test. Must not be null.

Returns:

true if the requirement should be considered as part of the resolve operation.

getWirings

public Map<org.jboss.gravia.resource.Resource,org.jboss.gravia.runtime.Wiring> getWirings()

Description copied from interface: ResolveContext

Returns the wirings for existing resolved resources.

Multiple calls to this method for this resolve context must return the same result.

Specified by:

getWirings in interface ResolveContext

Returns:

The wirings for existing resolved resources. The returned map is unmodifiable.

findProviders

public List<org.jboss.gravia.resource.Capability> findProviders(org.jboss.gravia.resource.Requirement req)

Description copied from interface: ResolveContext

Find Capabilities that match the given Requirement.

The returned list contains Capability objects where the Resource must be the declared Resource of the Capability.

The returned list is in priority order such that the Capabilities with a lower index have a preference over those with a higher index.

Each returned Capability must match the given Requirement.

Specified by:

findProviders in interface ResolveContext

Parameters:

req - The requirement that a resolver is attempting to satisfy. Must not be null.

Returns:

A list of Capability objects that match the specified requirement.