com.amazon.ask.mvc.mapper.MethodParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ask-sdk-mvc Show documentation

The Alexa Skills Kit MVC Framework extends the existing ASK SDK, adding features for mapping requests to methods and rendering responses via view scripts and templates such as Nashorn Javascript and Freemarker. It also integrates with the ASK SDK Interaction Model Mapper framework to create a single environment where both the interaction model and business logic of skills can be managed as code packages.

The newest version!

/*
    Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.

    Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file
    except in compliance with the License. A copy of the License is located at

        http://aws.amazon.com/apache2.0/

    or in the "license" file accompanying this file. This file 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 com.amazon.ask.mvc.mapper;

import com.amazon.ask.util.ValidationUtils;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Objects;
import java.util.Optional;

/**
 * Contains details about a parameter in a method
 */
public class MethodParameter {
    protected final Method method;
    protected final int index;
    protected final Class type;
    protected final Annotation[] annotations;

    public static final Annotation[] EMPTY_ANNOTATIONS = new Annotation[0];

    /**
     * Builds a MethodParameter for a specific parameter in a method
     *
     * @param method the method where the parameter is defined
     * @param index index of the parameter
     * @param type type of the parameter
     * @param annotations the annotations of the parameter
     */
    public MethodParameter(Method method, int index, Class type, Annotation[] annotations) {
        ValidationUtils.assertNotNull(method, "method");
        ValidationUtils.assertNotNull(type, "type");
        ValidationUtils.assertNotNull(annotations, "parameterAnnotations");

        this.method = method;
        this.index = index;
        this.type = type;
        this.annotations = annotations;
    }

    /**
     * @param type annotation class
     * @param  type of annotation
     * @return returns an annotation of the indicated type, if present
     */
    public  Optional findAnnotation(Class type) {
        for (Annotation annotation : annotations) {
            if (annotation.annotationType().isAssignableFrom(type)) {
                return Optional.of((T) annotation);
            }
        }

        return Optional.empty();
    }

    /**
     * @return the method where the parameter is defined
     */
    public Method getMethod() {
        return method;
    }

    /**
     * @return index of the parameter
     */
    public int getIndex() {
        return index;
    }

    /**
     * @return type of the parameter
     */
    public Class getType() {
        return type;
    }

    /**
     * @return annotations of the parameter
     */
    public Annotation[] getAnnotations() {
        return annotations;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        MethodParameter that = (MethodParameter) o;
        return index == that.index &&
            Objects.equals(method, that.method) &&
            Objects.equals(type, that.type) &&
            Arrays.equals(annotations, that.annotations);
    }

    @Override
    public int hashCode() {
        int result = Objects.hash(method, index, type);
        result = 31 * result + Arrays.hashCode(annotations);
        return result;
    }
}