com.reqdesign.reqif

Class ReqIFArchiveManager

java.lang.Object

com.reqdesign.reqif.ReqIFArchiveManager

public final class ReqIFArchiveManager
extends java.lang.Object

This class is used to create ReqIF archives and manage existing archives.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVE_DEFAULT_EXTENSION
static java.lang.String[]	SUPPORTED_ARCHIVE_EXTENSIONS

Constructor Summary

Constructors

Constructor and Description
ReqIFArchiveManager()

Method Summary

Modifier and Type	Method and Description
static ReqIFArchive	createArchive() Creates an instance of this class.
static ReqIFArchive	load(java.lang.String path, java.util.function.Consumer<ValidationMessage> validationMessageConsumer) Loads a ReqIF archive from disk.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ARCHIVE_DEFAULT_EXTENSION

public static final java.lang.String ARCHIVE_DEFAULT_EXTENSION

See Also:

Constant Field Values

SUPPORTED_ARCHIVE_EXTENSIONS

public static final java.lang.String[] SUPPORTED_ARCHIVE_EXTENSIONS

Constructor Detail

ReqIFArchiveManager

public ReqIFArchiveManager()

Method Detail

createArchive

public static ReqIFArchive createArchive()
                                  throws com.reqdesign.reqif.LicenseException,
                                         FileException

Creates an instance of this class. You can add existing ReqIF files to this object or create ReqIF files from scratch. An empty archive is created in the temp folder.

For ReqIF files created from scratch, there are some restrictions on functionality until the ReqIF file is saved to disk with ReqIFArchive.saveAs(String, Consumer). For example, you can't add XHTML content that references external files until a load or save operation has occurred. This will provide the anchor point for the referenced files relative paths.

Returns:

an empty ReqIFArchive object, not null

Throws:

FileException - if a temp archive could not be created

LicenseException - if the REQIFdev license is missing or invalid

load

public static ReqIFArchive load(java.lang.String path,
                                java.util.function.Consumer<ValidationMessage> validationMessageConsumer)
                         throws FileException,
                                com.reqdesign.reqif.LicenseException

Loads a ReqIF archive from disk.

Parameters:

path - the full path to the .reqifz archive file, not null

validationMessageConsumer - a consumer of validation message objects ValidationMessage, not null

Returns:

the created ReqIFArchive object, not null

Throws:

FileException - if the specified path is not an archive

LicenseException - if the REQIFdev license is missing or invalid