6884227: Clarify ordering requirements of javax.lang.model.TypeElement.getEnclosedElements

Mon, 21 Sep 2009 21:08:11 -0700

author
darcy
date
Mon, 21 Sep 2009 21:08:11 -0700
changeset 411
789ee1acf107
parent 410
5dd400fd62d9
child 412
9596dff46093
child 414
e992e602788e

6884227: Clarify ordering requirements of javax.lang.model.TypeElement.getEnclosedElements
Reviewed-by: ahe

src/share/classes/javax/lang/model/element/TypeElement.java file | annotate | diff | comparison | revisions
     1.1 --- a/src/share/classes/javax/lang/model/element/TypeElement.java	Fri Sep 18 08:48:50 2009 -0700
     1.2 +++ b/src/share/classes/javax/lang/model/element/TypeElement.java	Mon Sep 21 21:08:11 2009 -0700
     1.3 @@ -60,6 +60,22 @@
     1.4   * @since 1.6
     1.5   */
     1.6  public interface TypeElement extends Element, Parameterizable, QualifiedNameable {
     1.7 +    /**
     1.8 +     * {@inheritDoc}
     1.9 +     *
    1.10 +     * <p> Note that as a particular instance of the {@linkplain
    1.11 +     * javax.lang.model.element general accuracy requirements} and the
    1.12 +     * ordering behavior required of this interface, the list of
    1.13 +     * enclosed elements will be returned in the natural order for the
    1.14 +     * originating source of information about the type.  For example,
    1.15 +     * if the information about the type is originating from a source
    1.16 +     * file, the elements will be returned in source code order.
    1.17 +     * (However, in that case the the ordering of synthesized
    1.18 +     * elements, such as a default constructor, is not specified.)
    1.19 +     *
    1.20 +     * @return the enclosed elements in proper order, or an empty list if none
    1.21 +     */
    1.22 +    List<? extends Element> getEnclosedElements();
    1.23  
    1.24      /**
    1.25       * Returns the <i>nesting kind</i> of this type element.

mercurial