MetaDataRetrieval


1   /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2006, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this software; if not, write to the Free
19  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21  */
22  package org.jboss.metadata.spi.retrieval;
23  
24  import java.lang.annotation.Annotation  ;
25  
26  import org.jboss.metadata.spi.scope.ScopeKey;
27  
28  /**
29   * MetaDataRetrieval.
30   * 
31   * @author <a HREF="adrian@jboss.com">Adrian Brock</a>
32   * @version $Revision: 57133 $
33   */
34  public interface MetaDataRetrieval
35  {
36     /**
37      * Return the scope key
38      * 
39      * @return the scope key
40      */
41     ScopeKey getScope();
42     
43     /**
44      * The valid time
45      * 
46      * @return the valid time
47      */
48     ValidTime getValidTime();
49     
50     /**
51      * Get all the annotations
52      * 
53      * @return the annotations
54      */
55     AnnotationsItem retrieveAnnotations();
56     
57     /**
58      * Get all the local annotations
59      * 
60      * @return the annotations
61      */
62     AnnotationsItem retrieveLocalAnnotations();
63  
64     /**
65      * Get annotation
66      * 
67      * @param <T> the annotation type
68      * @param annotationType the annotation type 
69      * @return the annotation or null if not present
70      */
71     <T extends Annotation  > AnnotationItem<T> retrieveAnnotation(Class  <T> annotationType);
72  
73     /**
74      * Get all the metadata
75      * 
76      * @return the metadata
77      */
78     MetaDatasItem retrieveMetaData();
79  
80     /**
81      * Get all the local metadata
82      * 
83      * @return the metadata
84      */
85     MetaDatasItem retrieveLocalMetaData();
86  
87     /**
88      * Get metadata
89      * 
90      * @param <T> the metadata type
91      * @param type the type
92      * @return the metadata or null if not present
93      */
94     <T> MetaDataItem<T> retrieveMetaData(Class  <T> type);
95  
96     /**
97      * Get metadata
98      * 
99      * @param name the name of the meta data
100     * @return the metadata or null if not present
101     */
102    MetaDataItem retrieveMetaData(String   name);
103 }
104
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags