/*

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *      http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.apache.commons.classscan.model;

 import java.util.Set;

 import org.apache.commons.classscan.HasName;

 /**

  * Metadata about an Annotation

  */

 public interface MetaAnnotation extends HasName {

     /**

      * Get the name of the Annotation

      */

     String getName();

     /**

      * Get metadata about the properties of the corresponding Annotation

      * 

      * @return The read-only set of properties specified in the annotation

      */

     Set<? extends Property> getProperties();

     /**

      * Get a single property of the corresponding Annotation

      * 

      * @param propertyName

      *            The name of the Property desired.

      * @return The Property; or null, if the no Property exists with the given

      *         name.

      */

     Property getProperty(String propertyName);

     /**

      * Metadata about an Annotation property

      */

     public interface Property extends HasName {

         /**

          * Get the property value. This will be

          * <ul>

          * <li>a String for String value,</li>

          * <li>an Object of the wrapper type for primitive values,</li>

          * <li>an {@link EnumValue} for Enum values,</li>

          * <li>a MetaAnnotation for Annotations,</li>

          * <li>an Object[] for any array value</li>

          * </ul>

          */

         Object getValue();

     }

     /**

      * Metadata about an Annotation Enum value

      */

     public interface EnumValue {

         /**

          * Get information about the Enumeration

          */

         MetaClass getEnumType();

         /**

          * Get the name of the enumeration instance

          */

         String getEnumValue();

     }

 }