6548433: (enum spec) java.lang.Enum docs should explain about values() and valueOf(String)
Reviewed-by: martin
This commit is contained in:
parent
17e0db945f
commit
6a6fc9ad3f
@ -34,11 +34,13 @@ import java.io.ObjectStreamException;
|
|||||||
/**
|
/**
|
||||||
* This is the common base class of all Java language enumeration types.
|
* This is the common base class of all Java language enumeration types.
|
||||||
*
|
*
|
||||||
* More information about enums, including implicit methods synthesised
|
* More information about enums, including descriptions of the
|
||||||
* by the compiler, can be found in <i>The Java™ Language
|
* implicitly declared methods synthesized by the compiler, can be
|
||||||
* Specification, Third Edition</i>, <a
|
* found in <i>The Java™ Language Specification, Third
|
||||||
|
* Edition</i>, <a
|
||||||
* href="http://java.sun.com/docs/books/jls/third_edition/html/classes.html#8.9">§8.9</a>.
|
* href="http://java.sun.com/docs/books/jls/third_edition/html/classes.html#8.9">§8.9</a>.
|
||||||
*
|
*
|
||||||
|
* @param <E> The enum type subclass
|
||||||
* @author Josh Bloch
|
* @author Josh Bloch
|
||||||
* @author Neal Gafter
|
* @author Neal Gafter
|
||||||
* @see Class#getEnumConstants()
|
* @see Class#getEnumConstants()
|
||||||
@ -197,6 +199,15 @@ public abstract class Enum<E extends Enum<E>>
|
|||||||
* to declare an enum constant in this type. (Extraneous whitespace
|
* to declare an enum constant in this type. (Extraneous whitespace
|
||||||
* characters are not permitted.)
|
* characters are not permitted.)
|
||||||
*
|
*
|
||||||
|
* <p>Note that for a particular enum type {@code T}, the
|
||||||
|
* implicitly declared {@code public static T valueOf(String)}
|
||||||
|
* method on that enum may be used instead of this method to map
|
||||||
|
* from a name to the corresponding enum constant. All the
|
||||||
|
* constants of an enum type can be obtained by calling the
|
||||||
|
* implicit {@code public static T[] values()} method of that
|
||||||
|
* type.
|
||||||
|
*
|
||||||
|
* @param <T> The enum type whose constant is to be returned
|
||||||
* @param enumType the {@code Class} object of the enum type from which
|
* @param enumType the {@code Class} object of the enum type from which
|
||||||
* to return a constant
|
* to return a constant
|
||||||
* @param name the name of the constant to return
|
* @param name the name of the constant to return
|
||||||
|
Loading…
Reference in New Issue
Block a user