src/share/classes/java/lang/Enum.java

Print this page
rev 826 : 6548433: (enum spec) java.lang.Enum docs should explain about values() and valueOf(String)
Reviewed-by: martin

*** 32,46 **** import java.io.ObjectStreamException; /** * This is the common base class of all Java language enumeration types. * ! * More information about enums, including implicit methods synthesised ! * by the compiler, can be found in <i>The Java&trade; Language ! * Specification, Third Edition</i>, <a * href="http://java.sun.com/docs/books/jls/third_edition/html/classes.html#8.9">&sect;8.9</a>. * * @author Josh Bloch * @author Neal Gafter * @see Class#getEnumConstants() * @since 1.5 */ --- 32,48 ---- import java.io.ObjectStreamException; /** * This is the common base class of all Java language enumeration types. * ! * More information about enums, including descriptions of the ! * implicitly declared methods synthesized by the compiler, can be ! * found in <i>The Java&trade; Language Specification, Third ! * Edition</i>, <a * href="http://java.sun.com/docs/books/jls/third_edition/html/classes.html#8.9">&sect;8.9</a>. * + * @param <E> The enum type subclass * @author Josh Bloch * @author Neal Gafter * @see Class#getEnumConstants() * @since 1.5 */
*** 195,204 **** --- 197,215 ---- * Returns the enum constant of the specified enum type with the * specified name. The name must match exactly an identifier used * to declare an enum constant in this type. (Extraneous whitespace * 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 * to return a constant * @param name the name of the constant to return * @return the enum constant of the specified enum type with the * specified name