org.jboss.metadata.plugins.loader.memory
Class MemoryMetaDataLoader

java.lang.Object
  org.jboss.metadata.plugins.loader.AbstractMetaDataLoader
      org.jboss.metadata.plugins.loader.BasicMetaDataLoader
          org.jboss.metadata.plugins.loader.AbstractMutableMetaDataLoader
              org.jboss.metadata.plugins.loader.AbstractMutableComponentMetaDataLoader
                  org.jboss.metadata.plugins.loader.memory.MemoryMetaDataLoader

All Implemented Interfaces:

ComponentMutableMetaData, MetaDataLoader, MutableMetaDataLoader, MutableMetaData, MetaDataRetrieval

public class MemoryMetaDataLoader
extends AbstractMutableComponentMetaDataLoader

MemoryMetaDataLoader.

Version:

$Revision: 69888 $

Author:

Adrian Brock

Constructor Summary

MemoryMetaDataLoader()
Create a new MemoryMetaDataLoader.

MemoryMetaDataLoader(boolean cachable, boolean restricted)
Create a new MemoryMetaDataLoader.

MemoryMetaDataLoader(ScopeKey scope)
Create a new MemoryMetaDataLoader.

MemoryMetaDataLoader(ScopeKey scope, boolean cachable, boolean restricted)
Create a new MemoryMetaDataLoader.

Method Summary

<T extends Annotation> T	addAnnotation(T annotation) Add an annotation
<T> T	addMetaData(String name, T metaData, Class<T> type) Add metaData
<T> T	addMetaData(T metaData, Class<T> type) Add metaData
protected MetaDataRetrieval	initComponentRetrieval(Signature signature) Initialise a component metadata retrieval
protected void	invalidateAnnotationsItem() Invalidate the annotations item
protected void	invalidateMetaDatasItem() Invalidate the metaDatas item
<T> boolean	isCachable(Item<T> item) Whether the item is cachable
boolean	isEmpty() Is metadata empty.
protected BasicAnnotationsItem	noAnnotations() Set no annotations
protected BasicMetaDatasItem	noMetaDatas() Set no meta data
<T extends Annotation> T	removeAnnotation(Class<T> annotationType) Remove an annotation
<T> T	removeMetaData(Class<T> type) Remove metaData
<T> T	removeMetaData(String name, Class<T> type) Remove metadata
<T extends Annotation> AnnotationItem<T>	retrieveAnnotation(Class<T> annotationType) Get annotation
AnnotationsItem	retrieveAnnotations() Get all the annotations
MetaDatasItem	retrieveMetaData() Get all the metadata
<T> MetaDataItem<T>	retrieveMetaData(Class<T> type) Get metadata
MetaDataItem<?>	retrieveMetaData(String name) Get metadata

Methods inherited from class org.jboss.metadata.plugins.loader.AbstractMutableComponentMetaDataLoader

addAnnotation, addAnnotation, addAnnotation, addComponentMetaDataRetrieval, addMetaData, addMetaData, addMetaData, addMetaData, addMetaData, addMetaData, getComponentMetaDataRetrieval, initRetrieval, isNullOrEmpty, removeAnnotation, removeAnnotation, removeAnnotation, removeComponentMetaDataRetrieval, removeMetaData, removeMetaData, removeMetaData, removeMetaData, removeMetaData, removeMetaData

Methods inherited from class org.jboss.metadata.plugins.loader.AbstractMutableMetaDataLoader

checkRestricted, checkRestricted

Methods inherited from class org.jboss.metadata.plugins.loader.AbstractMetaDataLoader

getScope, getScopedRetrieval, getValidTime, invalidate, retrieveLocalAnnotations, retrieveLocalMetaData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.metadata.spi.retrieval.MetaDataRetrieval

getScope, getScopedRetrieval, getValidTime, retrieveLocalAnnotations, retrieveLocalMetaData

Constructor Detail

MemoryMetaDataLoader

public MemoryMetaDataLoader()

Create a new MemoryMetaDataLoader.

MemoryMetaDataLoader

public MemoryMetaDataLoader(boolean cachable,
                            boolean restricted)

Create a new MemoryMetaDataLoader.

Parameters:

cachable - whether items produced should be cachable

restricted - whether restricted items are allowed

MemoryMetaDataLoader

public MemoryMetaDataLoader(ScopeKey scope)

Create a new MemoryMetaDataLoader.

Parameters:

scope - the scope key

MemoryMetaDataLoader

public MemoryMetaDataLoader(ScopeKey scope,
                            boolean cachable,
                            boolean restricted)

Create a new MemoryMetaDataLoader.

Parameters:

scope - the scope key

cachable - whether items produced should be cachable

restricted - whether restricted items are allowed

Method Detail

isCachable

public <T> boolean isCachable(Item<T> item)

Description copied from interface: MetaDataLoader

Whether the item is cachable

Specified by:

isCachable in interface MetaDataLoader

Overrides:

isCachable in class AbstractMetaDataLoader

Type Parameters:

T - the item type

Parameters:

item - the item

Returns:

true when cachable

retrieveAnnotations

public AnnotationsItem retrieveAnnotations()

Description copied from interface: MetaDataRetrieval

Get all the annotations

Returns:

the annotations

retrieveAnnotation

public <T extends Annotation> AnnotationItem<T> retrieveAnnotation(Class<T> annotationType)

Description copied from interface: MetaDataRetrieval

Get annotation

Specified by:

retrieveAnnotation in interface MetaDataRetrieval

Overrides:

retrieveAnnotation in class BasicMetaDataLoader

Type Parameters:

T - the annotation type

Parameters:

annotationType - the annotation type

Returns:

the annotation or null if not present

addAnnotation

public <T extends Annotation> T addAnnotation(T annotation)

Description copied from interface: MutableMetaData

Add an annotation

Type Parameters:

T - the annotation type

Parameters:

annotation - the annotation

Returns:

any previous annotation

removeAnnotation

public <T extends Annotation> T removeAnnotation(Class<T> annotationType)

Description copied from interface: MutableMetaData

Remove an annotation

Type Parameters:

T - the annotation type

Parameters:

annotationType - the annotation type

Returns:

any previous annotation

retrieveMetaData

public MetaDatasItem retrieveMetaData()

Description copied from interface: MetaDataRetrieval

Get all the metadata

Specified by:

retrieveMetaData in interface MetaDataRetrieval

Overrides:

retrieveMetaData in class AbstractMetaDataLoader

Returns:

the metadata

retrieveMetaData

public <T> MetaDataItem<T> retrieveMetaData(Class<T> type)

Description copied from interface: MetaDataRetrieval

Get metadata

Specified by:

retrieveMetaData in interface MetaDataRetrieval

Overrides:

retrieveMetaData in class AbstractMetaDataLoader

Type Parameters:

T - the metadata type

Parameters:

type - the type

Returns:

the metadata or null if not present

retrieveMetaData

public MetaDataItem<?> retrieveMetaData(String name)

Description copied from interface: MetaDataRetrieval

Get metadata

Specified by:

retrieveMetaData in interface MetaDataRetrieval

Overrides:

retrieveMetaData in class BasicMetaDataLoader

Parameters:

name - the name of the meta data

Returns:

the metadata or null if not present

addMetaData

public <T> T addMetaData(T metaData,
                         Class<T> type)

Description copied from interface: MutableMetaData

Add metaData

Specified by:

addMetaData in interface MutableMetaData

Overrides:

addMetaData in class AbstractMutableMetaDataLoader

Type Parameters:

T - the metadata type

Parameters:

metaData - the meta data

type - the expected type

Returns:

any previous meta data

removeMetaData

public <T> T removeMetaData(Class<T> type)

Description copied from interface: MutableMetaData

Remove metaData

Specified by:

removeMetaData in interface MutableMetaData

Overrides:

removeMetaData in class AbstractMutableMetaDataLoader

Type Parameters:

T - the metadata type

Parameters:

type - the meta data type

Returns:

any previous meta data

addMetaData

public <T> T addMetaData(String name,
                         T metaData,
                         Class<T> type)

Description copied from interface: MutableMetaData

Add metaData

Specified by:

addMetaData in interface MutableMetaData

Overrides:

addMetaData in class AbstractMutableMetaDataLoader

Type Parameters:

T - the metadata type

Parameters:

name - the name

metaData - the meta data

type - the expected type

Returns:

any previous meta data

removeMetaData

public <T> T removeMetaData(String name,
                            Class<T> type)

Description copied from interface: MutableMetaData

Remove metadata

Specified by:

removeMetaData in interface MutableMetaData

Overrides:

removeMetaData in class AbstractMutableMetaDataLoader

Type Parameters:

T - the metadata type

Parameters:

name - the name of the meta data

type - the expected type of the metadata

Returns:

the metadata or null if not present

isEmpty

public boolean isEmpty()

Description copied from interface: MetaDataRetrieval

Is metadata empty.

Specified by:

isEmpty in interface MetaDataRetrieval

Overrides:

isEmpty in class AbstractMutableComponentMetaDataLoader

Returns:

true if metadata empty

invalidateAnnotationsItem

protected void invalidateAnnotationsItem()

Invalidate the annotations item

noAnnotations

protected BasicAnnotationsItem noAnnotations()

Set no annotations

Returns:

no annotations

invalidateMetaDatasItem

protected void invalidateMetaDatasItem()

Invalidate the metaDatas item

noMetaDatas

protected BasicMetaDatasItem noMetaDatas()

Set no meta data

Returns:

no meta data

initComponentRetrieval

protected MetaDataRetrieval initComponentRetrieval(Signature signature)

Description copied from class: AbstractMutableComponentMetaDataLoader

Initialise a component metadata retrieval

Specified by:

initComponentRetrieval in class AbstractMutableComponentMetaDataLoader

Parameters:

signature - the signature

Returns:

the result