MPackageReaderType

All Superinterfaces:: AutoCloseable

All Known Implementing Classes:: MPackageReader

public interface MPackageReaderType extends AutoCloseable

A package being read.

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static enum

MPackageReaderType.PlatformDependentModulePolicy

The policy for platform-dependent modules.
Method Summary

Modifier and Type

Method

Description

void

checkHash(MFileName file)

Check the digest of the given file, raising an exception if it does not match what is in the package declaration.

void

close()

MPackageDeclaration

packageDeclaration()

InputStream

readFile(MFileName file)

default void

unpackInto(Path output)

Unpack all files into the given output directory.

void

unpackInto(Path output, Function<MPlatformDependentModule, MPackageReaderType.PlatformDependentModulePolicy> filterPlatform)

Unpack all files into the given output directory.

Method Details
- packageDeclaration
  
  MPackageDeclaration packageDeclaration()
  
  Returns:
  
  The package declaration
- close
  
  void close() throws MException
  
  Specified by:
  
  close in interface AutoCloseable
  
  Throws:
  
  MException
- readFile
  
  InputStream readFile(MFileName file) throws MException
  
  Parameters:
  
  file - The file
  
  Returns:
  
  A stream for the given file
  
  Throws:
  
  MException - On errors
- checkHash
  
  void checkHash(MFileName file) throws MException
  
  Check the digest of the given file, raising an exception if it does not match what is in the package declaration.
  
  Parameters:
  
  file - The file
  
  Throws:
  
  MException - On errors
- unpackInto
  
  default void unpackInto(Path output) throws MException
  
  Unpack all files into the given output directory.
  
  Parameters:
  
  output - The output directory
  
  Throws:
  
  MException - On errors
- unpackInto
  
  void unpackInto(Path output, Function<MPlatformDependentModule, MPackageReaderType.PlatformDependentModulePolicy> filterPlatform) throws MException
  
  Unpack all files into the given output directory.
  
  Parameters:
  
  output - The output directory
  
  filterPlatform - The filter for platform-dependent modules
  
  Throws:
  
  MException - On errors