io.github.dmlloyd.classfile.attribute.ModulePackagesAttribute Maven / Gradle / Ivy
/*
* Copyright (c) 2022, 2024, 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 io.github.dmlloyd.classfile.attribute;
import io.github.dmlloyd.classfile.Attribute;
import io.github.dmlloyd.classfile.ClassElement;
import io.github.dmlloyd.classfile.impl.BoundAttribute;
import java.util.Arrays;
import java.util.List;
import io.github.dmlloyd.classfile.constantpool.PackageEntry;
import io.github.dmlloyd.classfile.extras.constant.PackageDesc;
import io.github.dmlloyd.classfile.impl.TemporaryConstantPool;
import io.github.dmlloyd.classfile.impl.UnboundAttribute;
import io.github.dmlloyd.classfile.extras.PreviewFeature;
/**
* Models the {@code ModulePackages} attribute (JVMS {@jvms 4.7.26}), which can
* appear on classes that represent module descriptors.
* Delivered as a {@link io.github.dmlloyd.classfile.ClassElement} when
* traversing the elements of a {@link io.github.dmlloyd.classfile.ClassModel}.
*
* 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.
*
* The attribute was introduced in the Java SE Platform version 9.
*
* @since 22
*/
@PreviewFeature(feature = PreviewFeature.Feature.CLASSFILE_API)
public sealed interface ModulePackagesAttribute
extends Attribute, ClassElement
permits BoundAttribute.BoundModulePackagesAttribute,
UnboundAttribute.UnboundModulePackagesAttribute {
/**
* {@return the packages that are opened or exported by this module}
*/
List packages();
/**
* {@return a {@code ModulePackages} attribute}
* @param packages the packages
*/
static ModulePackagesAttribute of(List packages) {
return new UnboundAttribute.UnboundModulePackagesAttribute(packages);
}
/**
* {@return a {@code ModulePackages} attribute}
* @param packages the packages
*/
static ModulePackagesAttribute of(PackageEntry... packages) {
return of(List.of(packages));
}
/**
* {@return a {@code ModulePackages} attribute}
* @param packages the packages
*/
static ModulePackagesAttribute ofNames(List packages) {
var p = new PackageEntry[packages.size()];
for (int i = 0; i < packages.size(); i++) {
p[i] = TemporaryConstantPool.INSTANCE.packageEntry(TemporaryConstantPool.INSTANCE.utf8Entry(packages.get(i).internalName()));
}
return of(p);
}
/**
* {@return a {@code ModulePackages} attribute}
* @param packages the packages
*/
static ModulePackagesAttribute ofNames(PackageDesc... packages) {
// List view, since ref to packages is temporary
return ofNames(Arrays.asList(packages));
}
}