8046614: Fill in missing doc comments

Reviewed-by: darcy
This commit is contained in:
Jonathan Gibbons 2014-06-25 19:04:52 -07:00
parent 25618fc470
commit a86ace6297
123 changed files with 3233 additions and 306 deletions

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -48,21 +48,63 @@ import javax.lang.model.element.Name;
*/
@jdk.Exported
public interface MethodTree extends Tree {
/**
* Returns the modifiers, including any annotations for the method being declared.
* @return the modifiers
*/
ModifiersTree getModifiers();
/**
* Returns the name of the method being declared.
* @return the name
*/
Name getName();
/**
* Returns the return type of the method being declared.
* Returns {@code null} for a constructor.
* @return the return type
*/
Tree getReturnType();
/**
* Returns the type parameters of the method being declared.
* @return the type parameters
*/
List<? extends TypeParameterTree> getTypeParameters();
/**
* Returns the parameters of the method being declared.
* @return the parameters
*/
List<? extends VariableTree> getParameters();
/**
* Return an explicit receiver parameter ("this" parameter).
* Return an explicit receiver parameter ("this" parameter),
* or {@code null} if none.
*
* @return an explicit receiver parameter ("this" parameter)
* @since 1.8
*/
VariableTree getReceiverParameter();
/**
* Returns the exceptions listed as being thrown by this method.
* @return the exceptions
*/
List<? extends ExpressionTree> getThrows();
/**
* Returns the method body, or {@code null} if this is an abstract or native method.
* @return the method body
*/
BlockTree getBody();
/**
* Returns the default value, if this is an element within
* an annotation type declaration.
* Returns {@code null} otherwise.
* @return the default value
*/
Tree getDefaultValue(); // for annotation types
}