Module jdk.jlink

Package jdk.tools.jlink.plugin

Interface ResourcePoolEntry

public interface ResourcePoolEntry

A ResourcePoolEntry is the elementary unit of data inside an image. It is generally a file. e.g.: a java class file, a resource file, a shared library.
A ResourcePoolEntry is identified by a path of the form:

• For jimage content: /{module name}/{package1}/.../{packageN}/{file name}
• For top-level files:/{module name}/{file name}
• For other files (shared lib, launchers, config, ...):/{module name}/ bin|conf|native/{dir1}/.../{dirN}/{file name}

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ResourcePoolEntry.Type	Type of module data.

Method Summary

Modifier and Type	Method	Description
InputStream	content()	The ResourcePoolEntry content as an InputStream.
default byte[]	contentBytes()	The ResourcePoolEntry content as an array of bytes.
long	contentLength()	The ResourcePoolEntry content length.
default ResourcePoolEntry	copyWithContent(byte[] content)	Create a ResourcePoolEntry with new content but other information copied from this ResourcePoolEntry.
default ResourcePoolEntry	copyWithContent(Path file)	Create a ResourcePoolEntry with new content but other information copied from this ResourcePoolEntry.
static ResourcePoolEntry	create(String path, byte[] content)	Create a ResourcePoolEntry for a resource of type ResourcePoolEntry.Type.CLASS_OR_RESOURCE.
static ResourcePoolEntry	create(String path, Path file)	Create a ResourcePoolEntry for a resource of type ResourcePoolEntry.Type.CLASS_OR_RESOURCE.
static ResourcePoolEntry	create(String path, ResourcePoolEntry.Type type, byte[] content)	Create a ResourcePoolEntry for a resource of the given type.
static ResourcePoolEntry	create(String path, ResourcePoolEntry.Type type, Path file)	Create a ResourcePoolEntry for a resource of the given type.
static ResourcePoolEntry	createSymLink(String path, ResourcePoolEntry.Type type, ResourcePoolEntry target)	Create a ResourcePoolEntry for a resource the given path and type.
default ResourcePoolEntry	linkedTarget()	Returns a target linked with this entry.
String	moduleName()	The module name of this ResourcePoolEntry.
String	path()	The path of this ResourcePoolEntry.
ResourcePoolEntry.Type	type()	The ResourcePoolEntry's type.
default void	write(OutputStream out)	Write the content of this ResourcePoolEntry to an OutputStream.

Method Detail

moduleName

String moduleName()

The module name of this ResourcePoolEntry.

Returns:

The module name.

path

String path()

The path of this ResourcePoolEntry.

Returns:

The module path.

type

ResourcePoolEntry.Type type()

The ResourcePoolEntry's type.

Returns:

The data type.

contentLength

long contentLength()

The ResourcePoolEntry content length.

Returns:

The content length.

content

InputStream content()

The ResourcePoolEntry content as an InputStream.

Returns:

The resource content as an InputStream.

linkedTarget

default ResourcePoolEntry linkedTarget()

Returns a target linked with this entry.

Implementation Requirements:

The default implementation returns null.

Returns:

the target ResourcePoolEntry linked with this entry.

contentBytes

default byte[] contentBytes()

The ResourcePoolEntry content as an array of bytes.

Returns:

An Array of bytes.

write

default void write(OutputStream out)

Write the content of this ResourcePoolEntry to an OutputStream.

Parameters:

out - the output stream

copyWithContent

default ResourcePoolEntry copyWithContent(byte[] content)

Create a ResourcePoolEntry with new content but other information copied from this ResourcePoolEntry.

Parameters:

content - The new resource content.

Returns:

A new ResourcePoolEntry.

copyWithContent

default ResourcePoolEntry copyWithContent(Path file)

Create a ResourcePoolEntry with new content but other information copied from this ResourcePoolEntry.

Parameters:

file - The new resource content.

Returns:

A new ResourcePoolEntry.

create

static ResourcePoolEntry create(String path,
                                ResourcePoolEntry.Type type,
                                byte[] content)

Create a ResourcePoolEntry for a resource of the given type.

Parameters:

path - The resource path.

type - The ResourcePoolEntry type.

content - The resource content.

Returns:

A new ResourcePoolEntry.

create

static ResourcePoolEntry create(String path,
                                byte[] content)

Create a ResourcePoolEntry for a resource of type ResourcePoolEntry.Type.CLASS_OR_RESOURCE.

Parameters:

path - The resource path.

content - The resource content.

Returns:

A new ResourcePoolEntry.

create

static ResourcePoolEntry create(String path,
                                ResourcePoolEntry.Type type,
                                Path file)

Create a ResourcePoolEntry for a resource of the given type.

Parameters:

path - The resource path.

type - The ResourcePoolEntry type.

file - The resource file.

Returns:

A new ResourcePoolEntry.

create

static ResourcePoolEntry create(String path,
                                Path file)

Create a ResourcePoolEntry for a resource of type ResourcePoolEntry.Type.CLASS_OR_RESOURCE.

Parameters:

path - The resource path.

file - The resource file.

Returns:

A new ResourcePoolEntry.

createSymLink

static ResourcePoolEntry createSymLink(String path,
                                       ResourcePoolEntry.Type type,
                                       ResourcePoolEntry target)

Create a ResourcePoolEntry for a resource the given path and type. If the target platform supports symbolic links, it will be created as a symbolic link to the given target entry; otherwise, the ResourcePoolEntry contains the relative path to the target entry.

Parameters:

path - The resource path.

type - The ResourcePoolEntry type.

target - The target entry

Returns:

A new ResourcePoolEntry