ParameterFactory.java

/*
 * #%L
 * Wisdom-Framework
 * %%
 * Copyright (C) 2013 - 2014 Wisdom Framework
 * %%
 * 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.
 * #L%
 */
package org.wisdom.api.router.parameters;

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

/**
 * Interface implemented by classes parsing action's annotation to create {@link ActionParameter}.
 *
 * @param <T> the handled annotation.
 */
public interface ParameterFactory<T extends Annotation> {

    /**
     * Creates an instance of action parameter from the given annotation.
     *
     * @param annotation  the annotation, must not be {@literal null}
     * @param rawClass    the class of the formal parameter in the action method
     * @param genericType metadata on generics if any
     * @return the created action's parameter
     * @throws java.lang.IllegalArgumentException if the parameter cannot be created form the given annotation.
     */
    ActionParameter build(T annotation, Class rawClass,
                          Type genericType) throws IllegalArgumentException;
}