org.jboss.dependency.plugins
Class AbstractScopeInfo

java.lang.Object
  org.jboss.dependency.plugins.AbstractScopeInfo

All Implemented Interfaces:

ScopeInfo

Direct Known Subclasses:

KernelScopeInfo

public class AbstractScopeInfo
extends Object
implements ScopeInfo

AbstractScopeInfo.

Version:

$Revision: 1.1 $

Author:

Adrian Brock

Constructor Summary

AbstractScopeInfo(Object name)
Create a new AbstractScopeInfo.

AbstractScopeInfo(Object name, String className)
Create a new AbstractScopeInfo.

AbstractScopeInfo(org.jboss.metadata.spi.scope.ScopeKey key, org.jboss.metadata.spi.scope.ScopeKey mutable)
Create a new AbstractScopeInfo.

Method Summary

void	addMetaData(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository, ControllerContext context) Add metadata
protected org.jboss.metadata.spi.retrieval.MetaDataRetrieval	createMetaDataRetrieval(ControllerContext context, List<org.jboss.metadata.spi.retrieval.MetaDataRetrieval> retrievals) Create metadata retrieval.
org.jboss.metadata.spi.scope.ScopeKey	getInstallScope() Get the install scope
org.jboss.metadata.spi.MetaData	getMetaData() Get the metadata
protected org.jboss.metadata.spi.loader.MutableMetaDataLoader	getMutableMetaDataLoader(org.jboss.metadata.spi.retrieval.MetaDataRetrieval retrieval) Get mutable metadata loader.
org.jboss.metadata.spi.scope.ScopeKey	getMutableScope() Get the mutable scope
org.jboss.metadata.spi.scope.ScopeKey	getScope() Get the scope
org.jboss.metadata.spi.retrieval.MetaDataRetrieval	initMetaDataRetrieval(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository, ControllerContext context) Initialise the main metadata retrieval
org.jboss.metadata.spi.retrieval.MetaDataRetrieval	initMetaDataRetrieval(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository, ControllerContext context, org.jboss.metadata.spi.scope.Scope scope) Initialise the metadata retrieval
org.jboss.metadata.spi.loader.MutableMetaDataLoader	initMutableMetaDataRetrieval(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository, ControllerContext context, org.jboss.metadata.spi.scope.ScopeKey scopeKey) Initialise the main mutable metadata retrieval.
void	removeMetaData(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository, ControllerContext context) Add metadata
void	setInstallScope(org.jboss.metadata.spi.scope.ScopeKey key) Set the install scope
void	setMutableScope(org.jboss.metadata.spi.scope.ScopeKey key) Set the mutable scope
void	setScope(org.jboss.metadata.spi.scope.ScopeKey key) Set the scope
protected void	updateMetaData(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository, ControllerContext context, org.jboss.metadata.spi.loader.MutableMetaDataLoader mutable, boolean add) Update metadata

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractScopeInfo

public AbstractScopeInfo(Object name)

Create a new AbstractScopeInfo.

Parameters:

name - the name

AbstractScopeInfo

public AbstractScopeInfo(Object name,
                         String className)

Create a new AbstractScopeInfo.

Parameters:

name - the name

className - the class name

AbstractScopeInfo

public AbstractScopeInfo(org.jboss.metadata.spi.scope.ScopeKey key,
                         org.jboss.metadata.spi.scope.ScopeKey mutable)

Create a new AbstractScopeInfo.

Parameters:

key - the scope key

mutable - the mutable scope key

Method Detail

getMetaData

public org.jboss.metadata.spi.MetaData getMetaData()

Description copied from interface: ScopeInfo

Get the metadata

Specified by:

getMetaData in interface ScopeInfo

Returns:

the metadata

addMetaData

public void addMetaData(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository,
                        ControllerContext context)

Description copied from interface: ScopeInfo

Add metadata

Specified by:

addMetaData in interface ScopeInfo

Parameters:

repository - the repository

context - the controller context

updateMetaData

protected void updateMetaData(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository,
                              ControllerContext context,
                              org.jboss.metadata.spi.loader.MutableMetaDataLoader mutable,
                              boolean add)

Update metadata

Parameters:

repository - the repository

context - the context

mutable - the mutable

add - true for add, false for remove

removeMetaData

public void removeMetaData(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository,
                           ControllerContext context)

Description copied from interface: ScopeInfo

Add metadata

Specified by:

removeMetaData in interface ScopeInfo

Parameters:

repository - the repository

context - the controller context

getMutableMetaDataLoader

protected org.jboss.metadata.spi.loader.MutableMetaDataLoader getMutableMetaDataLoader(org.jboss.metadata.spi.retrieval.MetaDataRetrieval retrieval)

Get mutable metadata loader.

Parameters:

retrieval - current metadata retrieval

Returns:

found mutable metadata loader instance, null otherwise

initMetaDataRetrieval

public org.jboss.metadata.spi.retrieval.MetaDataRetrieval initMetaDataRetrieval(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository,
                                                                                ControllerContext context,
                                                                                org.jboss.metadata.spi.scope.Scope scope)

Description copied from interface: ScopeInfo

Initialise the metadata retrieval

Specified by:

initMetaDataRetrieval in interface ScopeInfo

Parameters:

repository - the repository

context - the context

scope - the scope level

Returns:

the retrieval

initMetaDataRetrieval

public org.jboss.metadata.spi.retrieval.MetaDataRetrieval initMetaDataRetrieval(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository,
                                                                                ControllerContext context)

Description copied from interface: ScopeInfo

Initialise the main metadata retrieval

Specified by:

initMetaDataRetrieval in interface ScopeInfo

Parameters:

repository - the repository

context - the context

Returns:

the retrieval

initMutableMetaDataRetrieval

public org.jboss.metadata.spi.loader.MutableMetaDataLoader initMutableMetaDataRetrieval(org.jboss.metadata.spi.repository.MutableMetaDataRepository repository,
                                                                                        ControllerContext context,
                                                                                        org.jboss.metadata.spi.scope.ScopeKey scopeKey)

Description copied from interface: ScopeInfo

Initialise the main mutable metadata retrieval.

Specified by:

initMutableMetaDataRetrieval in interface ScopeInfo

Parameters:

repository - the mutable metadata repository

context - the controller context

scopeKey - the scope key

Returns:

new mutable metadata loader instance

getScope

public org.jboss.metadata.spi.scope.ScopeKey getScope()

Description copied from interface: ScopeInfo

Get the scope

Specified by:

getScope in interface ScopeInfo

Returns:

the scope

setScope

public void setScope(org.jboss.metadata.spi.scope.ScopeKey key)

Description copied from interface: ScopeInfo

Set the scope

Specified by:

setScope in interface ScopeInfo

Parameters:

key - the scope key

getMutableScope

public org.jboss.metadata.spi.scope.ScopeKey getMutableScope()

Description copied from interface: ScopeInfo

Get the mutable scope

Specified by:

getMutableScope in interface ScopeInfo

Returns:

the scope

setMutableScope

public void setMutableScope(org.jboss.metadata.spi.scope.ScopeKey key)

Description copied from interface: ScopeInfo

Set the mutable scope

Specified by:

setMutableScope in interface ScopeInfo

Parameters:

key - the scope key

getInstallScope

public org.jboss.metadata.spi.scope.ScopeKey getInstallScope()

Description copied from interface: ScopeInfo

Get the install scope

Specified by:

getInstallScope in interface ScopeInfo

Returns:

the scope

setInstallScope

public void setInstallScope(org.jboss.metadata.spi.scope.ScopeKey key)

Description copied from interface: ScopeInfo

Set the install scope

Specified by:

setInstallScope in interface ScopeInfo

Parameters:

key - the scope key

createMetaDataRetrieval

protected org.jboss.metadata.spi.retrieval.MetaDataRetrieval createMetaDataRetrieval(ControllerContext context,
                                                                                     List<org.jboss.metadata.spi.retrieval.MetaDataRetrieval> retrievals)

Create metadata retrieval.

Parameters:

context - the controller context

retrievals - the retrievals

Returns:

new metadata retrieval instance