/* $Id: MethodArgument.java 992060 2010-09-02 19:09:47Z simonetripodi $
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.digester.annotations.reflect;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;

Class to supply the missing Java AnnotatedElement for method arguments. 
Since:
2.1/**
 * Class to supply the missing Java {@code AnnotatedElement} for method
 * arguments.
 *
 * @since 2.1
 */
public final class MethodArgument implements AnnotatedElement {

    
The method argument index.
/**
     * The method argument index.
     */
    private final int index;

    
The method argument type.
/**
     * The method argument type.
     */
    private final Class<?> parameterType;

    
The method argument annotations.
/**
     * The method argument annotations.
     */
    private final Annotation[] annotations;

    
Creates a new method argument as AnnotatedElement. 
Params:
index – the method argument index.
parameterType – the method argument type.
annotations – the method argument annotations./**
     * Creates a new method argument as {@code AnnotatedElement}.
     *
     * @param index the method argument index.
     * @param parameterType the method argument type.
     * @param annotations the method argument annotations.
     */
    public MethodArgument(int index, Class<?> parameterType, Annotation[] annotations) {
        this.index = index;
        this.parameterType = parameterType;
        this.annotations = annotations;
    }

    
Returns the method argument index.
Returns:
the method argument index./**
     * Returns the method argument index.
     *
     * @return the method argument index.
     */
    public int getIndex() {
        return this.index;
    }

    
Returns the method argument type.
Returns:
the method argument type./**
     * Returns the method argument type.
     *
     * @return the method argument type.
     */
    public Class<?> getParameterType() {
        return this.parameterType;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public <T extends Annotation> T getAnnotation(Class<T> annotationType) {
        for (Annotation annotation : this.annotations) {
            if (annotationType == annotation.annotationType()) {
                return annotationType.cast(annotation);
            }
        }
        return null;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public Annotation[] getAnnotations() {
        return this.getAnnotationsArrayCopy();
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public Annotation[] getDeclaredAnnotations() {
        return this.getAnnotationsArrayCopy();
    }

    
Returns an annotations array, copy of the declared annotations in this
method argument.
Returns:
an annotations array, copy of the declared annotations in this
        method argument./**
     * Returns an annotations array, copy of the declared annotations in this
     * method argument.
     *
     * @return an annotations array, copy of the declared annotations in this
     *         method argument.
     */
    private Annotation[] getAnnotationsArrayCopy() {
        Annotation[] annotations = new Annotation[this.annotations.length];
        System.arraycopy(this.annotations, 0, annotations, 0, annotations.length);
        return annotations;
    }

    
{@inheritDoc}
/**
     * {@inheritDoc}
     */
    public boolean isAnnotationPresent(Class<? extends Annotation> annotationType) {
        for (Annotation annotation : this.annotations) {
            if (annotationType == annotation.annotationType()) {
                return true;
            }
        }
        return false;
    }

}