org.jboss.metadata.plugins.loader
Class AbstractMetaDataLoader

java.lang.Object
  extended by org.jboss.metadata.plugins.loader.AbstractMetaDataLoader
All Implemented Interfaces:
MetaDataLoader, MetaDataRetrieval
Direct Known Subclasses:
BasicMetaDataLoader

public abstract class AbstractMetaDataLoader
extends Object
implements MetaDataLoader

AbstractMetaDataLoader.

The default behaviour is to assume there are only annotations with the types and names of the getMetadata() methods interpreted as annotation types and class names.

Version:
$Revision: 71300 $
Author:
Adrian Brock

Constructor Summary
AbstractMetaDataLoader()
          Create a new AbstractMetaDataLoader.
AbstractMetaDataLoader(ScopeKey key)
          Create a new AbstractMetaDataLoader.
 
Method Summary
 ScopeKey getScope()
          Return the scope key
 MetaDataRetrieval getScopedRetrieval(ScopeLevel level)
          Get scoped retrieval for level param.
 ValidTime getValidTime()
          The valid time
 void invalidate()
          Invalidate
<T> boolean
isCachable(Item<T> item)
          Whether the item is cachable
 AnnotationsItem retrieveLocalAnnotations()
          Get all the local annotations
 MetaDatasItem retrieveLocalMetaData()
          Get all the local metadata
 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jboss.metadata.spi.retrieval.MetaDataRetrieval
getComponentMetaDataRetrieval, isEmpty, retrieveAnnotation, retrieveAnnotations
 

Constructor Detail

AbstractMetaDataLoader

public AbstractMetaDataLoader()
Create a new AbstractMetaDataLoader.


AbstractMetaDataLoader

public AbstractMetaDataLoader(ScopeKey key)
Create a new AbstractMetaDataLoader.

Parameters:
key - the scope
Method Detail

getScope

public ScopeKey getScope()
Description copied from interface: MetaDataRetrieval
Return the scope key

Specified by:
getScope in interface MetaDataRetrieval
Returns:
the scope key

getValidTime

public ValidTime getValidTime()
Description copied from interface: MetaDataRetrieval
The valid time

Specified by:
getValidTime in interface MetaDataRetrieval
Returns:
the valid time

isCachable

public <T> boolean isCachable(Item<T> item)
Description copied from interface: MetaDataLoader
Whether the item is cachable

Specified by:
isCachable in interface MetaDataLoader
Type Parameters:
T - the item type
Parameters:
item - the item
Returns:
true when cachable

retrieveLocalAnnotations

public AnnotationsItem retrieveLocalAnnotations()
Description copied from interface: MetaDataRetrieval
Get all the local annotations

Specified by:
retrieveLocalAnnotations in interface MetaDataRetrieval
Returns:
the annotations

retrieveMetaData

public <T> MetaDataItem<T> retrieveMetaData(Class<T> type)
Description copied from interface: MetaDataRetrieval
Get metadata

Specified by:
retrieveMetaData in interface MetaDataRetrieval
Type Parameters:
T - the metadata type
Parameters:
type - the type
Returns:
the metadata or null if not present

retrieveLocalMetaData

public MetaDatasItem retrieveLocalMetaData()
Description copied from interface: MetaDataRetrieval
Get all the local metadata

Specified by:
retrieveLocalMetaData in interface MetaDataRetrieval
Returns:
the metadata

retrieveMetaData

public MetaDatasItem retrieveMetaData()
Description copied from interface: MetaDataRetrieval
Get all the metadata

Specified by:
retrieveMetaData in interface MetaDataRetrieval
Returns:
the metadata

retrieveMetaData

public MetaDataItem<?> retrieveMetaData(String name)
Description copied from interface: MetaDataRetrieval
Get metadata

Specified by:
retrieveMetaData in interface MetaDataRetrieval
Parameters:
name - the name of the meta data
Returns:
the metadata or null if not present

getScopedRetrieval

public MetaDataRetrieval getScopedRetrieval(ScopeLevel level)
Description copied from interface: MetaDataRetrieval
Get scoped retrieval for level param.

Specified by:
getScopedRetrieval in interface MetaDataRetrieval
Parameters:
level - the scope level
Returns:
list of retrieval instances

invalidate

public void invalidate()
Invalidate



Copyright © 2011 JBoss, a division of Red Hat, Inc.. All Rights Reserved.