/*

  * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH

  *

  * 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 de.smartics.properties.report.qdox;

 import java.util.List;

 import com.thoughtworks.qdox.Searcher;

 import com.thoughtworks.qdox.model.JavaAnnotation;

 import com.thoughtworks.qdox.model.JavaClass;

 import de.smartics.properties.api.core.annotations.PropertySet;

 import de.smartics.util.lang.Arg;

 import de.smartics.util.lang.NullArgumentException;

 /**

  * Filters interfaces that are annotated with the {@link PropertySet}

  * annotation.

  */

 public final class PropertyDescriptorSearcher implements Searcher

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   /**

    * The name of the annotation that identifies an interface as declaring

    * properties.

    */

   private static final String PROPERTY_SET_CLASS_NAME = PropertySet.class

       .getName();

   // --- members --------------------------------------------------------------

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- get&set --------------------------------------------------------------

   // --- business -------------------------------------------------------------

   /**

    * {@inheritDoc}

    *

    * @see com.thoughtworks.qdox.Searcher#eval(com.thoughtworks.qdox.model.JavaClass)

    * @throws NullArgumentException if {@code cls} is <code>null</code>.

    */

   @Override

   public boolean eval(final JavaClass cls) throws NullArgumentException

   {

     return hasPropertyAnnotation(cls);

   }

   /**

    * Checks if the given class provides the {@link PropertySet} annotation that

    * identifies an interfaces as declaring a property set.

    *

    * @param javaClass the class to check for being an interface and providing

    *          the {@link PropertySet} annotation.

    * @return <code>true</code> if the class is a property set interface,

    *         <code>false</code> otherwise.

    * @throws NullArgumentException if {@code javaClass} is <code>null</code>.

    */

   public static boolean hasPropertyAnnotation(final JavaClass javaClass)

     throws NullArgumentException

   {

     Arg.checkNotNull("javaClass", javaClass);

     if (javaClass.isInterface())

     {

       final List<JavaAnnotation> annotations = javaClass.getAnnotations();

       for (final JavaAnnotation annotation : annotations)

       {

         final String annotationClassName =

             annotation.getType().getFullyQualifiedName();

         if (PROPERTY_SET_CLASS_NAME.equals(annotationClassName))

         {

           return true;

         }

       }

     }

     return false;

   }

   // --- object basics --------------------------------------------------------

 }