org.jboss.gravia.resolver.spi

Class AbstractResolver

java.lang.Object

org.jboss.gravia.resolver.spi.AbstractResolver

All Implemented Interfaces:

Resolver

Direct Known Subclasses:

DefaultResolver

public abstract class AbstractResolver
extends Object
implements Resolver

An abstract resolver Resolver. The resolver maintains order on all levels. This should guarantee reproducable results.

Since:

31-May-2010

Author:

thomas.diesler@jboss.com

Constructor Summary

Constructors

Constructor and Description
AbstractResolver()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract org.jboss.gravia.resource.spi.AbstractWire	createWire(org.jboss.gravia.resource.Requirement req, org.jboss.gravia.resource.Capability cap)
protected abstract org.jboss.gravia.resource.spi.AbstractWiring	createWiring(org.jboss.gravia.resource.Resource resource, List<org.jboss.gravia.resource.Wire> reqwires, List<org.jboss.gravia.resource.Wire> provwires)
Map<org.jboss.gravia.resource.Resource,List<org.jboss.gravia.resource.Wire>>	resolve(ResolveContext context) Resolve the specified resolve context and return any new resources and wires to the caller.
Map<org.jboss.gravia.resource.Resource,List<org.jboss.gravia.resource.Wire>>	resolveAndApply(ResolveContext context) Resolve and apply the given ResolveContext.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractResolver

public AbstractResolver()

Method Detail

createWire

protected abstract org.jboss.gravia.resource.spi.AbstractWire createWire(org.jboss.gravia.resource.Requirement req,
                                                    org.jboss.gravia.resource.Capability cap)

createWiring

protected abstract org.jboss.gravia.resource.spi.AbstractWiring createWiring(org.jboss.gravia.resource.Resource resource,
                                                        List<org.jboss.gravia.resource.Wire> reqwires,
                                                        List<org.jboss.gravia.resource.Wire> provwires)

resolve

public Map<org.jboss.gravia.resource.Resource,List<org.jboss.gravia.resource.Wire>> resolve(ResolveContext context)
                                                                                     throws ResolutionException

Description copied from interface: Resolver

Resolve the specified resolve context and return any new resources and wires to the caller.

The resolver considers two groups of resources:

• Mandatory - any resource in the mandatory group must be resolved. A failure to satisfy any mandatory requirement for these resources will result in throwing a ResolutionException
• Optional - any resource in the optional group may be resolved. A failure to satisfy a mandatory requirement for a resource in this group will not fail the overall resolution but no resources or wires will be returned for that resource.

The resolve method returns the delta between the start state defined by ResolveContext.getWirings() and the end resolved state. That is, only new resources and wires are included.

The behavior of the resolver is not defined if the specified resolve context supplies inconsistent information.

Specified by:

resolve in interface Resolver

Parameters:

context - The resolve context for the resolve operation. Must not be null.

Returns:

The new resources and wires required to satisfy the specified resolve context. The returned map is the property of the caller and can be modified by the caller.

Throws:

ResolutionException - If the resolution cannot be satisfied.

resolveAndApply

public Map<org.jboss.gravia.resource.Resource,List<org.jboss.gravia.resource.Wire>> resolveAndApply(ResolveContext context)
                                                                                             throws ResolutionException

Description copied from interface: Resolver

Resolve and apply the given ResolveContext.

This creates or updates the Wiring on each resolved Resource

Specified by:

resolveAndApply in interface Resolver

Parameters:

context - The resolve context for the resolve operation. Must not be null.

Returns:

The new resources and wires required to satisfy the specified resolve context. The returned map is the property of the caller and can be modified by the caller.

Throws:

ResolutionException - If the resolution cannot be satisfied.