8325371: Missing ClassFile.Option in package summary

Reviewed-by: briangoetz
This commit is contained in:
Adam Sotona 2024-04-09 14:41:39 +00:00
parent a8fbeec9e9
commit f9bc2db9a9
2 changed files with 17 additions and 11 deletions
src/java.base/share/classes/java/lang/classfile

@ -180,7 +180,7 @@ public sealed interface ClassFile
/** /**
* Option describing whether to filter unresolved labels. * Option describing whether to filter unresolved labels.
* Default is {@code FAIL_ON_DEAD_LABELS} to throw IllegalStateException * Default is {@code FAIL_ON_DEAD_LABELS} to throw IllegalArgumentException
* when any {@link ExceptionCatch}, {@link LocalVariableInfo}, * when any {@link ExceptionCatch}, {@link LocalVariableInfo},
* {@link LocalVariableTypeInfo}, or {@link CharacterRangeInfo} * {@link LocalVariableTypeInfo}, or {@link CharacterRangeInfo}
* reference to unresolved {@link Label} during bytecode serialization. * reference to unresolved {@link Label} during bytecode serialization.

@ -174,20 +174,26 @@
* for some statically enumerated options, as well as factories for more complex options, * for some statically enumerated options, as well as factories for more complex options,
* including: * including:
* <ul> * <ul>
* <li>{@link java.lang.classfile.ClassFile.StackMapsOption} * <li>{@link java.lang.classfile.ClassFile.AttributeMapperOption#of(java.util.function.Function)}
* -- generate stackmaps (default is {@code STACK_MAPS_WHEN_REQUIRED})</li> * -- specify format of custom attributes</li>
* <li>{@link java.lang.classfile.ClassFile.AttributesProcessingOption}
* -- unrecognized or problematic original attributes (default is {@code PASS_ALL_ATTRIBUTES})</li>
* <li>{@link java.lang.classfile.ClassFile.ClassHierarchyResolverOption#of(java.lang.classfile.ClassHierarchyResolver)}
* -- specify a custom class hierarchy resolver used by stack map generation</li>
* <li>{@link java.lang.classfile.ClassFile.ConstantPoolSharingOption}}
* -- share constant pool when transforming (default is {@code SHARED_POOL})</li>
* <li>{@link java.lang.classfile.ClassFile.DeadCodeOption}}
* -- patch out unreachable code (default is {@code PATCH_DEAD_CODE})</li>
* <li>{@link java.lang.classfile.ClassFile.DeadLabelsOption}}
* -- filter unresolved labels (default is {@code FAIL_ON_DEAD_LABELS})</li>
* <li>{@link java.lang.classfile.ClassFile.DebugElementsOption} * <li>{@link java.lang.classfile.ClassFile.DebugElementsOption}
* -- processing of debug information, such as local variable metadata (default is {@code PASS_DEBUG}) </li> * -- processing of debug information, such as local variable metadata (default is {@code PASS_DEBUG}) </li>
* <li>{@link java.lang.classfile.ClassFile.LineNumbersOption} * <li>{@link java.lang.classfile.ClassFile.LineNumbersOption}
* -- processing of line numbers (default is {@code PASS_LINE_NUMBERS}) </li> * -- processing of line numbers (default is {@code PASS_LINE_NUMBERS}) </li>
* <li>{@link java.lang.classfile.ClassFile.AttributesProcessingOption} * <li>{@link java.lang.classfile.ClassFile.ShortJumpsOption}
* -- unrecognized or problematic original attributes (default is {@code PASS_ALL_ATTRIBUTES})</li> * -- automatically rewrite short jumps to long when necessary (default is {@code FIX_SHORT_JUMPS})</li>
* <li>{@link java.lang.classfile.ClassFile.ConstantPoolSharingOption}} * <li>{@link java.lang.classfile.ClassFile.StackMapsOption}
* -- share constant pool when transforming (default is {@code SHARED_POOL})</li> * -- generate stackmaps (default is {@code STACK_MAPS_WHEN_REQUIRED})</li>
* <li>{@link java.lang.classfile.ClassFile.ClassHierarchyResolverOption#of(java.lang.classfile.ClassHierarchyResolver)}
* -- specify a custom class hierarchy resolver used by stack map generation</li>
* <li>{@link java.lang.classfile.ClassFile.AttributeMapperOption#of(java.util.function.Function)}
* -- specify format of custom attributes</li>
* </ul> * </ul>
* <p> * <p>
* Most options allow you to request that certain parts of the classfile be * Most options allow you to request that certain parts of the classfile be