org.fabric3.spi.introspection

Interface IntrospectionContext

All Known Implementing Classes:

DefaultIntrospectionContext

public interface IntrospectionContext

Context for the current introspection session. The context allows both errors and warnings to be gathered. Errors indicate problems that will prevent an assembly from being activated such as a missing component implementation. Warnings indicate issues that are not in themselves fatal but which may result in an activation failure.

Method Summary

Modifier and Type	Method and Description
void	addError(org.fabric3.api.host.failure.ValidationFailure e) Add a fatal error to the validation results.
void	addErrors(java.util.List<org.fabric3.api.host.failure.ValidationFailure> errors) Add a collection of fatal errors to the validation results.
void	addTypeMapping(java.lang.Class<?> type, TypeMapping typeMapping) Adds a mapping from formal parameter types to actual types for a class to the cache.
void	addWarning(org.fabric3.api.host.failure.ValidationFailure e) Add a non-fatal warning to the validation results.
void	addWarnings(java.util.List<org.fabric3.api.host.failure.ValidationFailure> warnings) Add a collection of non-fatal warnings to the validation results.
java.lang.ClassLoader	getClassLoader() Returns the classloader of the contribution being installed.
java.net.URI	getContributionUri() Returns the active contribution URI.
java.util.List<org.fabric3.api.host.failure.ValidationFailure>	getErrors() Returns the list of fatal errors detected during validation.
java.net.URL	getSourceBase() Returns the location of the XML artifact being introspected.
java.lang.String	getTargetNamespace() Target namespace for this loader context.
TypeMapping	getTypeMapping(java.lang.Class<?> type) Used for introspecting Java generics.
java.util.Map<java.lang.Class<?>,TypeMapping>	getTypeMappings() Used for introspecting Java generics.
java.util.List<org.fabric3.api.host.failure.ValidationFailure>	getWarnings() Returns the list of non-fatal warnings detected during validation.
boolean	hasErrors() Returns true if the validation has detected any fatal errors.
boolean	hasWarnings() Returns true if the validation has detected any non-fatal warnings.
void	setTargetNamespace(java.lang.String namespace) Sets the current target namespace

Method Detail

getContributionUri

java.net.URI getContributionUri()

Returns the active contribution URI.

Returns:

the active contribution URI

hasErrors

boolean hasErrors()

Returns true if the validation has detected any fatal errors.

Returns:

true if the validation has detected any fatal errors

getErrors

java.util.List<org.fabric3.api.host.failure.ValidationFailure> getErrors()

Returns the list of fatal errors detected during validation.

Returns:

the list of fatal errors detected during validation

addError

void addError(org.fabric3.api.host.failure.ValidationFailure e)

Add a fatal error to the validation results.

Parameters:

e - the fatal error that has been found

addErrors

void addErrors(java.util.List<org.fabric3.api.host.failure.ValidationFailure> errors)

Add a collection of fatal errors to the validation results.

Parameters:

errors - the fatal errors that have been found

hasWarnings

boolean hasWarnings()

Returns true if the validation has detected any non-fatal warnings.

Returns:

true if the validation has detected any non-fatal warnings

getWarnings

java.util.List<org.fabric3.api.host.failure.ValidationFailure> getWarnings()

Returns the list of non-fatal warnings detected during validation.

Returns:

the list of non-fatal warnings detected during validation

addWarning

void addWarning(org.fabric3.api.host.failure.ValidationFailure e)

Add a non-fatal warning to the validation results.

Parameters:

e - the non-fatal warning that has been found

addWarnings

void addWarnings(java.util.List<org.fabric3.api.host.failure.ValidationFailure> warnings)

Add a collection of non-fatal warnings to the validation results.

Parameters:

warnings - the non-fatal warnings that have been found

getClassLoader

java.lang.ClassLoader getClassLoader()

Returns the classloader of the contribution being installed.

Returns:

the contribution classloader

getSourceBase

java.net.URL getSourceBase()

Returns the location of the XML artifact being introspected.

Returns:

the location of the XML artifact being introspected. This may return null if the source is not a dereferenceable artifact.

getTargetNamespace

java.lang.String getTargetNamespace()

Target namespace for this loader context.

Returns:

Target namespace.

setTargetNamespace

void setTargetNamespace(java.lang.String namespace)

Sets the current target namespace

Parameters:

namespace - the namespace to set

getTypeMapping

TypeMapping getTypeMapping(java.lang.Class<?> type)

Used for introspecting Java generics. Returns a cache of mappings from formal parameter types to actual types for a class. Since the IntrospectionContext is disposed after a contribution has been installed, it is safe to cache pointers to classes.

Parameters:

type - the class

Returns:

the cache of mappings from formal parameter types to actual types for a class or null if the mapping does not exist

getTypeMappings

java.util.Map<java.lang.Class<?>,TypeMapping> getTypeMappings()

Used for introspecting Java generics. Returns the cache of classes and their resolved parameter types mapped to actual types.

Returns:

the cache of classes and their resolved parameter types mapped to actual types

addTypeMapping

void addTypeMapping(java.lang.Class<?> type,
                    TypeMapping typeMapping)

Adds a mapping from formal parameter types to actual types for a class to the cache.

Parameters:

type - the class

typeMapping - the mappings