/*

  * 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.spi.core.util;

 import java.lang.reflect.Method;

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

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

 /**

  * Utilities to deal with property meta data.

  */

 public final class PropertyUtils

 {

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

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

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

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

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

   private PropertyUtils()

   {

   }

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

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

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

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

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

   /**

    * Checks of the given type is a property set types.

    * <p>

    * Property set types are interfaces marked with a {@link PropertySet}

    * annotation.

    * </p>

    *

    * @param propertySetType the type to check.

    * @throws NullPointerException if {@code propertySetType} is

    *           <code>null</code>.

    * @throws IllegalArgumentException of {@code propertySetType} is not a

    *           property set type.

    */

   public static void checkPropertySetType(final Class<?> propertySetType)

     throws NullPointerException, IllegalArgumentException

   {

     if (propertySetType.getAnnotation(PropertySet.class) == null

         || !propertySetType.isInterface())

     {

       throw new IllegalArgumentException("Type '" + propertySetType.getName()

                                          + "' is not annotated with '"

                                          + PropertySet.class.getName() + "'.");

     }

   }

   /**

    * Checks if the given {@code method} is a property accessor. The property

    * accessor is not required to provide a <code>get</code> prefix.

    *

    * @param method the method to check for being a property accessor.

    * @return <code>true</code> if it is a property descriptor,

    *         <code>false</code> otherwise.

    * @throws NullPointerException if {@code method} is <code>null</code>.

    */

   public static boolean isPropertyMethod(final Method method)

     throws NullPointerException

   {

     final PropertyMetaDataMethod annotation =

         method.getAnnotation(PropertyMetaDataMethod.class);

     if (annotation == null)

     {

       final String name = method.getName();

       if (!name.endsWith(PropertyMetaDataMethod.PROPERTY_DESCRIPTOR)

           && !name.endsWith(PropertyMetaDataMethod.PROPERTY_KEY))

       {

         return true;

       }

     }

     return false;

   }

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

 }