javax.validation.metadata.MethodDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of validation-api Show documentation

Bean Validation API

There is a newer version: 2.0.1.Final

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and/or its affiliates, and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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 javax.validation.metadata;

import java.util.List;
import javax.validation.metadata.ElementDescriptor;

/**
 * Describes a validated method.
 *
 * @author Gunnar Morling
 */
public interface MethodDescriptor extends ElementDescriptor {

	/**
	 * Returns the name of the method represented by this descriptor.
	 *
	 * @return The name of the method represented by this descriptor.
	 */
	String getName();

	/**
	 * 
	 * Returns a list with descriptors for this method's parameters. The size of
	 * this list corresponds to the number of this method's parameters.
	 * 
	 *
	 * @return A list with descriptors for this method's parameters. An empty
	 *		 list will be returned if this method has no parameters, but never
	 *		 null.
	 */
	List getParameterDescriptors();

	/**
	 * Returns a descriptor for this method's return value.
	 *
	 * @return A descriptor for this method's return value or null
	 *		 if this method has no return value.
	 */
	ReturnValueDescriptor getReturnValueDescriptor();
}