org.jboss.metadata.plugins.loader.thread
Class ThreadLocalMetaDataLoader

java.lang.Object
  extended by org.jboss.metadata.plugins.loader.AbstractMetaDataLoader
      extended by org.jboss.metadata.plugins.loader.BasicMetaDataLoader
          extended by org.jboss.metadata.plugins.loader.AbstractMutableMetaDataLoader
              extended by org.jboss.metadata.plugins.loader.thread.ThreadLocalMetaDataLoader
All Implemented Interfaces:
MetaDataLoader, MutableMetaDataLoader, MutableMetaData, MetaDataRetrieval

public class ThreadLocalMetaDataLoader
extends AbstractMutableMetaDataLoader

ThreadLocalMetaDataLoader.

Version:
$Revision: 69888 $
Author:
Adrian Brock

Field Summary
static ThreadLocalMetaDataLoader INSTANCE
          The singleton instance
 
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
 void clear()
          Clear all the values for the current thread
 ScopeKey getScope()
          Return the scope key
 ValidTime getValidTime()
          The valid time
 void invalidate()
          Invalidate
<T> boolean
isCachable(Item<T> item)
          Whether the item is cachable
 boolean isEmpty()
          Is metadata empty.
<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.AbstractMutableMetaDataLoader
checkRestricted, checkRestricted
 
Methods inherited from class org.jboss.metadata.plugins.loader.BasicMetaDataLoader
getComponentMetaDataRetrieval
 
Methods inherited from class org.jboss.metadata.plugins.loader.AbstractMetaDataLoader
getScopedRetrieval, 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
getComponentMetaDataRetrieval, getScopedRetrieval, retrieveLocalAnnotations, retrieveLocalMetaData
 

Field Detail

INSTANCE

public static final ThreadLocalMetaDataLoader INSTANCE
The singleton instance

Method Detail

clear

public void clear()
Clear all the values for the current thread


getScope

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

Specified by:
getScope in interface MetaDataRetrieval
Overrides:
getScope in class AbstractMetaDataLoader
Returns:
the scope key

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

getValidTime

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

Specified by:
getValidTime in interface MetaDataRetrieval
Overrides:
getValidTime in class AbstractMetaDataLoader
Returns:
the valid time

invalidate

public void invalidate()
Description copied from class: AbstractMetaDataLoader
Invalidate

Overrides:
invalidate in class AbstractMetaDataLoader

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.

Returns:
true if metadata empty


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