archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 06:45:07 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8308753: Class-File API transition to Preview

Browse source 
Reviewed-by: ihse, mchung, vromero
This commit is contained in:
Adam Sotona 2023-12-04 07:07:57 +00:00
parent b9df827adc
commit 2b00ac0d02
681 changed files with 7518 additions and 6502 deletions
Download patch file Download diff file Expand all files Collapse all files

128
src/java.base/share/classes/java/lang/classfile/attribute/ModuleHashesAttribute.java Normal file
View file

@ -0,0 +1,128 @@
/*
* Copyright (c) 2022, 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
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.lang.classfile.attribute;
import java.lang.classfile.Attribute;
import java.lang.classfile.ClassElement;
import java.util.List;
import java.lang.classfile.constantpool.Utf8Entry;
import jdk.internal.classfile.impl.BoundAttribute;
import jdk.internal.classfile.impl.TemporaryConstantPool;
import jdk.internal.classfile.impl.UnboundAttribute;
import jdk.internal.javac.PreviewFeature;
/**
* Models the {@code ModuleHashes} attribute, which can
* appear on classes that represent module descriptors. This is a JDK-specific
* attribute, which captures the hashes of a set of co-delivered modules.
* Delivered as a {@link java.lang.classfile.ClassElement} when
* traversing the elements of a {@link java.lang.classfile.ClassModel}.
*
* <p>The specification of the {@code ModuleHashes} attribute is:
* <pre> {@code
*
* ModuleHashes_attribute {
* // index to CONSTANT_utf8_info structure in constant pool representing
* // the string "ModuleHashes"
* u2 attribute_name_index;
* u4 attribute_length;
*
* // index to CONSTANT_utf8_info structure with algorithm name
* u2 algorithm_index;
*
* // the number of entries in the hashes table
* u2 hashes_count;
* { u2 module_name_index (index to CONSTANT_Module_info structure)
* u2 hash_length;
* u1 hash[hash_length];
* } hashes[hashes_count];
*
* }
* } </pre>
* <p>
* The attribute does not permit multiple instances in a given location.
* Subsequent occurrence of the attribute takes precedence during the attributed
* element build or transformation.
*
* @since 22
*/
@PreviewFeature(feature = PreviewFeature.Feature.CLASSFILE_API)
public sealed interface ModuleHashesAttribute
extends Attribute<ModuleHashesAttribute>, ClassElement
permits BoundAttribute.BoundModuleHashesAttribute, UnboundAttribute.UnboundModuleHashesAttribute {
/**
* {@return the algorithm name used to compute the hash}
*/
Utf8Entry algorithm();
/**
* {@return the hash information about related modules}
*/
List<ModuleHashInfo> hashes();
/**
* {@return a {@code ModuleHashes} attribute}
* @param algorithm the hashing algorithm
* @param hashes the hash descriptions
*/
static ModuleHashesAttribute of(String algorithm,
List<ModuleHashInfo> hashes) {
return of(TemporaryConstantPool.INSTANCE.utf8Entry(algorithm), hashes);
}
/**
* {@return a {@code ModuleHashes} attribute}
* @param algorithm the hashing algorithm
* @param hashes the hash descriptions
*/
static ModuleHashesAttribute of(String algorithm,
ModuleHashInfo... hashes) {
return of(algorithm, List.of(hashes));
}
/**
* {@return a {@code ModuleHashes} attribute}
* @param algorithm the hashing algorithm
* @param hashes the hash descriptions
*/
static ModuleHashesAttribute of(Utf8Entry algorithm,
List<ModuleHashInfo> hashes) {
return new UnboundAttribute.UnboundModuleHashesAttribute(algorithm, hashes);
}
/**
* {@return a {@code ModuleHashes} attribute}
* @param algorithm the hashing algorithm
* @param hashes the hash descriptions
*/
static ModuleHashesAttribute of(Utf8Entry algorithm,
ModuleHashInfo... hashes) {
return of(algorithm, List.of(hashes));
}
}