diff --git a/README.md b/README.md index 870a9f56..c6c37cec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ODF Validator -Latest version is 0.18.5. +Latest version is 0.20-alpha-2. ## About diff --git a/docs/detection/index.md b/docs/detection/index.md index 67dfc1f0..9f80d706 100644 --- a/docs/detection/index.md +++ b/docs/detection/index.md @@ -4,41 +4,81 @@ ### Document Errors - +| Ref | Detection & Reference | +|-----|-------------| +| [[#DOC-1][]] | An OpenDocument document SHALL be a single XML file or a Zip file. | +| DOC-2 | OpenDocument version %s detected. An informational message that indicates the detected ODF version of the main document. | +| [[#DOC-3][]] | OpenDocument MIMETYPE %s detected. An informational message that indicates the detected MIME type. | +| [[#DOC-4][]] | Invalid MIMETYPE declaration %s detected. An error indicating that the MIME type detected is not a legal ODF media type. | +| [[#DOC-5][]] | No MIMETYPE declaration detected. While this is valid in some circumstances a warning is issued. | +| DOC-6 | OpenDocument document SHALL be format ``, no format was detected. This error is only issued if the `-f`/`--format` options is selected and the document doesn't contain a MIME type indicator. | +| #DOC-7 | OpenDocument document SHALL be format ``, but format `` was detected. This error is only issued if the `-f`/`--format` options is selected and the document's MIME type is not identical to the selected option. | +| [[#DOC-8][]] | This XML OpenDocument uses the following extended namespace prefixes ``. This message provides a list of any extended/foreign namespaces detected in an ODF document. This is an error message if the `-e`/`--extended` option for extended conformance isn't selected. If extended validation is requested this message becomes informational. | ### Package Errors -| Ref | Detection | +| Ref | Detection & Reference | |-----|-------------| -| PKG-1 | An OpenDocument package SHALL be a well formed Zip Archive.
This is detected via a full parse of the package zip file. If an exception is raised when reading the zip file or one of it's entries, this error is reported. | -PKG-2 | All files contained in the Zip file SHALL be non compressed (STORED) or compressed using the "deflate" (DEFLATED) algorithm. Zip entry %s is compressed with an unknown algorithm.
The zip library is used to examine the compression algorithm used, if it's outside of the prescribed values, this error is raised. | -PKG-3 | An OpenDocument package SHALL contain a file "META-INF/manifest.xml".
Simply check whether such a zip entry exists. | -PKG-4 | An OpenDocument package SHOULD contain a file "mimetype".
Simply check whether such a zip entry exists. | -PKG-5 | An OpenDocument package SHALL only contain the "META-INF/manifest.xml" and files containg the term "signatures" in their name in the "META-INF" folder. File %s does not meet this criteria.
Each zip entry is examined. If a file is found below `META-INF/` that is not `manifest.xml` and whose name does not contain the term "signatures" this error is raised. | -PKG-7 | An OpenDocument package SHOULD contain a preview image Thumbnails/thumbnail.png.
Simply check whether such a zip entry exists. | - +| [[#PKG-1][]] | An OpenDocument package SHALL be a well formed Zip Archive.
This is detected via a full parse of the package zip file. If an exception is raised when reading the zip file or one of it's entries, this error is reported. | +| [[#PKG-2][]] | All files contained in the Zip file SHALL be non compressed (STORED) or compressed using the "deflate" (DEFLATED) algorithm. Zip entry %s is compressed with an unknown algorithm.
The zip library is used to examine the compression algorithm used, if it's outside of the prescribed values, this error is raised. | +| [[#PKG-3][]] | An OpenDocument package SHALL contain a file "META-INF/manifest.xml".
Simply check whether such a zip entry exists. | +| [[#PKG-4][]] | An OpenDocument package SHOULD contain a file "mimetype".
Simply check whether such a zip entry exists. | +| [[#PKG-5][]] | An OpenDocument package SHALL only contain the "META-INF/manifest.xml" and files containing the term "signatures" in their name in the "META-INF" folder. File %s does not meet this criteria.
Each zip entry is examined. If a file is found below `META-INF/` that is not `manifest.xml` and whose name does not contain the term "signatures" this error is raised. | +| [[#PKG-7][]] | An OpenDocument package SHOULD contain a preview image Thumbnails/thumbnail.png.
Simply check whether such a zip entry exists. | +| [[#PKG-8][]] | Encrypted file entries shall be flagged as 'STORED' rather than 'DEFLATED' in the zip file's central directory. Zip entry %s is encrypted and flagged as 'DEFLATED'. | +| [[#PKG-10][]] |PKG-10 = Encrypted file entry detected. The software cannot decrypt encrypted ODF documents. This is flagged as a warning and the validation status is unknown as not all of the file contents could be accessed for validation. | ### Manifest Errors | Ref | Detection | |-----|-------------| -| MAN-1 | The manifest SHALL contain an entry for every file in the package, zip entry %s has no corresponding manifest file entry.
The software creates two lists of package contents:
  • Zip Entries: Gathered from the zip archive directory
  • Manifest Entries: Gathered from `META-INF/manifest.xml` file.
These are then compared and this error is fired only if there is a Zip Entry that doesn't have a corresponding Manfiest Entry. | -| MAN-2 | An OpenDocument package manifest SHALL NOT contain a file entry for itself.
This simply detects the presence of a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `META-INF/manifest.xml`. | -| MAN-3 | An OpenDocument package manifest SHALL NOT contain a file entry the mimetype file.
This simply detects the presence of a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `mimetype`. | -| MAN-4 | The manifest SHALL contain an entry for every file in the package, manifest file entry %s has no corresponding zip entry.
The software creates two lists of package contents:
  • Zip Entries: Gathered from the zip archive directory
  • Manifest Entries: Gathered from `META-INF/manifest.xml` file.
These are then compared and this error is fired only if there is a Manifest Entry that doesn't have a corresponding Zip Entry. | -| MAN-5 | An OpenDocument package manifest SHALL contain a element whose manifest:full-path attribute has the value \"/\" if a mimetype file is present.
This rule checks that a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `/` exists. IF it doesn't AND a `mimetype` entry exists this error is fired, if a `mimetype` entry does not exist then the warning `MAN-7` is fired instead. | -| MAN-6 | The OpenDocument package manifest NEED NOT contain entries for file paths starting with META-INF/, %s.
This rule checks that a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value starting with `META-INF/` exists. An information message that says this is unnecessary is raised. | -| MAN-7 | An OpenDocument package SHOULD contain a element whose manifest:full-path attribute has the value \"/\"".
This rule checks that a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `/` exists. IF it doesn't AND a `mimetype` entry also doesn't exist this warning is fired, if a `mimetype` entry does not exist then the error `MAN-5` is fired instead. | -| MAN-8 | For directories, the manifest file SHOULD contain a element only if a directory contains a document or a sub document. | -| MAN-9 | A directory for administrative or convenience purposes, such as a directory that contains various unrelated image files, SHOULD NOT have an entry in the manifest file. | +| [[#MAN-1][]] | The manifest SHALL contain an entry for every file in the package, zip entry %s has no corresponding manifest file entry.
The software creates two lists of package contents:
  • Zip Entries: Gathered from the zip archive directory
  • Manifest Entries: Gathered from `META-INF/manifest.xml` file.
These are then compared and this error is fired only if there is a Zip Entry that doesn't have a corresponding Manifest Entry. | +| [[#MAN-2][]] | An OpenDocument package manifest SHALL NOT contain a file entry for itself.
This simply detects the presence of a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `META-INF/manifest.xml`. | +| [[#MAN-3][]] | An OpenDocument package manifest SHALL NOT contain a file entry the mimetype file.
This simply detects the presence of a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `mimetype`. | +| [[#MAN-4][]] | The manifest SHALL contain an entry for every file in the package, manifest file entry %s has no corresponding zip entry.
The software creates two lists of package contents:
  • Zip Entries: Gathered from the zip archive directory
  • Manifest Entries: Gathered from `META-INF/manifest.xml` file.
These are then compared and this error is fired only if there is a Manifest Entry that doesn't have a corresponding Zip Entry. | +| [[#MAN-5][]] | An OpenDocument package manifest SHALL contain a element whose manifest:full-path attribute has the value \"/\" if a mimetype file is present.
This rule checks that a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `/` exists. IF it doesn't AND a `mimetype` entry exists this error is fired, if a `mimetype` entry does not exist then the warning `MAN-7` is fired instead. | +| [[#MAN-6][]] | The OpenDocument package manifest NEED NOT contain entries for file paths starting with META-INF/, %s.
This rule checks that a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value starting with `META-INF/` exists. An information message that says this is unnecessary is raised. | +| [[#MAN-7][]] | An OpenDocument package SHOULD contain a element whose manifest:full-path attribute has the value \"/\"".
This rule checks that a `META-INF/manifest.xml` `` element with a `manifest:full-path` attribute value `/` exists. IF it doesn't AND a `mimetype` entry also doesn't exist this warning is fired, if a `mimetype` entry does not exist then the error `MAN-5` is fired instead. | +| [[#MAN-8][]] | For directories, the manifest file SHOULD contain a element only if a directory contains a document or a sub document. | +| [[#MAN-9][]] | A directory for administrative or convenience purposes, such as a directory that contains various unrelated image files, SHOULD NOT have an entry in the manifest file. | ### MIME Media Type Errors | Ref | Detection | |-----|-------------| -| MIM-1 | The "mimetype" file SHALL be the first file of the zip file.
The zip archives entries are extracted in physical order and the name of the first entry is recorded. IF the package contains a `mimetype` file AND it is not the first entry this error is raised. | -| MIM-2 | The "mimetype" file SHALL NOT be compressed.
The software uses the zip library to examine the compression type used for the `mimetype` entry. If this is not `STORED` (which indicates no compression) then this error is raised. | -| MIM-3 | The "mimetype" file SHALL NOT use an 'extra field' in its header.
The software uses the zip library to retrieve the list of extra fields for the `mimetype` entry. If the retured array has a size > 0 then this error is raised. | -| MIM-4 | An OpenDocument package SHALL contain a mimetype file IF the manifest contains a element whose manifest:full-path attribute has the value "/".
IF the file doesn't contain a `mimetype` entry AND `META-INF/manifest.xml` DOES contain an entry with `manifest:full-path` "/" then this error is raised. If no such `` exists then the warning `PKG-4` is raised instead. | -| MIM-5 | An OpenDocument package mimetype file content SHALL be equal to the manifest:media-type attribute of the manifest element whose manifest:full-path attribute has the value \"/\".
IF the file doesn't contain a `mimetype` entry AND `META-INF/manifest.xml` DOES contain an entry with `manifest:full-path` "/" then the value of the `mimetype` file contents and the `manifest:media-type` attribute are compared. If they aren't equal then this error is raised. | -| MIM-6 | The content of the "mimetype" file SHALL be ASCII encoded.
Detection is impractical. | +| [[#MIM-1][]] | The "mimetype" file SHALL be the first file of the zip file.
The zip archives entries are extracted in physical order and the name of the first entry is recorded. IF the package contains a `mimetype` file AND it is not the first entry this error is raised. | +| [[#MIM-2][]] | The "mimetype" file SHALL NOT be compressed.
The software uses the zip library to examine the compression type used for the `mimetype` entry. If this is not `STORED` (which indicates no compression) then this error is raised. | +| [[#MIM-3][]] | The "mimetype" file SHALL NOT use an 'extra field' in its header.
The software uses the zip library to retrieve the list of extra fields for the `mimetype` entry. If the retured array has a size > 0 then this error is raised. | +| [[#MIM-4][]] | An OpenDocument package SHALL contain a mimetype file IF the manifest contains a element whose manifest:full-path attribute has the value "/".
IF the file doesn't contain a `mimetype` entry AND `META-INF/manifest.xml` DOES contain an entry with `manifest:full-path` "/" then this error is raised. If no such `` exists then the warning `PKG-4` is raised instead. | +| [[#MIM-5][]] | An OpenDocument package mimetype file content SHALL be equal to the manifest:media-type attribute of the manifest element whose manifest:full-path attribute has the value \"/\".
IF the file doesn't contain a `mimetype` entry AND `META-INF/manifest.xml` DOES contain an entry with `manifest:full-path` "/" then the value of the `mimetype` file contents and the `manifest:media-type` attribute are compared. If they aren't equal then this error is raised. | +| [[#MIM-6][]] | The content of the "mimetype" file SHALL be ASCII encoded.
Detection is impractical. | + +[#DOC-1]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part3-schema/OpenDocument-v1.3-os-part3-schema.html#a_2_2_Document_Conformance +[#DOC-3]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#DOC-4]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#DOC-5]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#DOC-8]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_2_2_2_OpenDocument_Extended_Document +[#PKG-1]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#OpenDocument_Package +[#PKG-2]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#OpenDocument_Package +[#PKG-3]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#PKG-4]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#PKG-5]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#OpenDocument_Package +[#PKG-7]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_8_Preview_Image +[#PKG-8]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#Encryption-General +[#PKG-10]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#Encryption +[#MAN-1]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-2]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-3]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-4]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-5]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-6]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-7]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#a_3_2_Manifest +[#MAN-8]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#element-manifest-file-entry +[#MAN-9]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#element-manifest-file-entry +[#MIM-1]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#MIM-2]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#MIM-3]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#MIM-4]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#MIM-5]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream +[#MIM-6]: https://docs.oasis-open.org/office/OpenDocument/v1.3/os/part2-packages/OpenDocument-v1.3-os-part2-packages.html#MIME_type_stream + diff --git a/docs/developer/index.md b/docs/developer/index.md index 5581162b..f7773ed4 100644 --- a/docs/developer/index.md +++ b/docs/developer/index.md @@ -10,7 +10,7 @@ To include the core validation library in your project, add the following depend org.openpreservation.odf odf-core - 0.18.5 + 0.20-alpha-2 ``` diff --git a/docs/site/apidocs/allclasses-index.html b/docs/site/apidocs/allclasses-index.html index 20807a48..b27664e4 100644 --- a/docs/site/apidocs/allclasses-index.html +++ b/docs/site/apidocs/allclasses-index.html @@ -1,299 +1,548 @@ + - -All Classes and Interfaces (ODF spreadsheet validator. 0.18.5 API) - + +All Classes (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -
-

All Classes and Interfaces

-
-
-
-
-
-
Class
-
Description
-
Attribute
-
+

All Classes

+
+
+
+ +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/allclasses.html b/docs/site/apidocs/allclasses.html new file mode 100644 index 00000000..37c4d90b --- /dev/null +++ b/docs/site/apidocs/allclasses.html @@ -0,0 +1,106 @@ + + + + + +All Classes (ODF Document validator. 0.20-alpha-2 API) + + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/docs/site/apidocs/allpackages-index.html b/docs/site/apidocs/allpackages-index.html index 3d6d4495..14b7fc10 100644 --- a/docs/site/apidocs/allpackages-index.html +++ b/docs/site/apidocs/allpackages-index.html @@ -1,93 +1,216 @@ + - -All Packages (ODF spreadsheet validator. 0.18.5 API) - + +All Packages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -

All Packages

-
Package Summary
-
-
Package
-
Description
-
org.openpreservation.format.xml
-
 
-
org.openpreservation.format.zip
-
 
-
org.openpreservation.odf
-
 
-
org.openpreservation.odf.apps
-
 
-
org.openpreservation.odf.apps.pkg
-
 
-
org.openpreservation.odf.document
-
 
-
org.openpreservation.odf.fmt
-
 
-
org.openpreservation.odf.pkg
-
 
-
org.openpreservation.odf.validation
-
 
-
org.openpreservation.odf.validation.messages
-
 
-
org.openpreservation.odf.validation.rules
-
 
-
org.openpreservation.odf.xml
-
 
-
org.openpreservation.utils
-
 
+
+
+ +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/constant-values.html b/docs/site/apidocs/constant-values.html index 535a6de3..394843d7 100644 --- a/docs/site/apidocs/constant-values.html +++ b/docs/site/apidocs/constant-values.html @@ -1,213 +1,440 @@ + - -Constant Field Values (ODF spreadsheet validator. 0.18.5 API) - + +Constant Field Values (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -

Constant Field Values

-
+

Contents

-
+
+ + +

org.openpreservation.*

-
+
+ +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/deprecated-list.html b/docs/site/apidocs/deprecated-list.html new file mode 100644 index 00000000..dd951575 --- /dev/null +++ b/docs/site/apidocs/deprecated-list.html @@ -0,0 +1,150 @@ + + + + + +Deprecated List (ODF Document validator. 0.20-alpha-2 API) + + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+
+
+ + + diff --git a/docs/site/apidocs/help-doc.html b/docs/site/apidocs/help-doc.html index 3a85fe17..b04e0657 100644 --- a/docs/site/apidocs/help-doc.html +++ b/docs/site/apidocs/help-doc.html @@ -1,122 +1,130 @@ + - -API Help (ODF spreadsheet validator. 0.18.5 API) - + +API Help (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -
-

JavaDoc Help

- -
-
-

Navigation

-Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces - +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-
-
-

Kinds of Pages

-The following sections describe the different kinds of pages in this collection. -
-

Overview

+
+
    +
  • +
    +

    Overview

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    -
    -

    Package

    -

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

    -
      + +
    • +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

      +
      • Interfaces
      • Classes
        • -
      • Enum Classes
        • +
      • Enums
      • Exceptions
      • Errors
        • -
      • Annotation Interfaces
        • +
      • Annotation Types
      -
      -

      Class or Interface

      -

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

      -
        + +
      • +
        +

        Class or Interface

        +

        Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

        +
        • Class Inheritance Diagram
        • Direct Subclasses
        • All Known Subinterfaces
          • @@ -125,72 +133,150 @@

          Class or Interface

        • Class or Interface Description

        -
          +
          • Nested Class Summary
            • -
          • Enum Constant Summary
          • Field Summary
          • Property Summary
          • Constructor Summary
          • Method Summary
            • -
          • Required Element Summary
            • -
          • Optional Element Summary

          -
            -
          • Enum Constant Details
            • -
          • Field Details
            • -
          • Property Details
            • -
          • Constructor Details
            • -
          • Method Details
            • -
          • Element Details
            • +
              +
            • Field Detail
              • +
            • Property Detail
              • +
            • Constructor Detail
              • +
            • Method Detail
            -

            Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

            -

            The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

            +

            Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

        -
        -

        Other Files

        -

        Packages and modules may contain pages with additional information related to the declarations nearby.

        +
        • +
      • +
        +

        Annotation Type

        +

        Each annotation type has its own separate page with the following sections:

        +
          +
        • Annotation Type Declaration
          • +
        • Annotation Type Description
          • +
        • Required Element Summary
          • +
        • Optional Element Summary
          • +
        • Element Detail
          • +
        +
        +
        • +
      • +
        +

        Enum

        +

        Each enum has its own separate page with the following sections:

        +
          +
        • Enum Declaration
          • +
        • Enum Description
          • +
        • Enum Constant Summary
          • +
        • Enum Constant Detail
          • +
        -
        -

        Use

        -

        Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.

        +
        • +
      • +
        +

        Use

        +

        Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

        -
        -

        Tree (Class Hierarchy)

        +
        • +
      • +
        +

        Tree (Class Hierarchy)

        There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

        -
          -
        • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
          • -
        • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
          • +
            +
          • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • +
          • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
        -
        -

        Constant Field Values

        -

        The Constant Field Values page lists the static final fields and their values.

        +
        • +
      • +
        +

        Deprecated API

        +

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        +
        +
        • +
      • +
        +

        Index

        +

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

        -
        -

        Serialized Form

        -

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.

        +
        • +
      • +
        +

        All Classes

        +

        The All Classes link shows all classes and interfaces except non-static nested types.

        -
        -

        All Packages

        -

        The All Packages page contains an alphabetic index of all packages contained in the documentation.

        +
        • +
      • +
        +

        Serialized Form

        +

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

        -
        -

        All Classes and Interfaces

        -

        The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

        +
        • +
      • +
        +

        Constant Field Values

        +

        The Constant Field Values page lists the static final fields and their values.

        -
        -

        Index

        -

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

        +
        • +
      • +
        +

        Search

        +

        You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

        -
+ +
-This help file applies to API documentation generated by the standard doclet.
+This help file applies to API documentation generated by the standard doclet.
+ + +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/index-all.html b/docs/site/apidocs/index-all.html index 8542fac9..cc370717 100644 --- a/docs/site/apidocs/index-all.html +++ b/docs/site/apidocs/index-all.html @@ -1,1688 +1,1768 @@ + - -Index (ODF spreadsheet validator. 0.18.5 API) - + +Index (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -
-
-

Index

-
-A B C D E F G H I J L M N O P R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form -

A

-
-
accepts(ZipEntry) - Method in interface org.openpreservation.format.zip.ZipEntryProcessor
+
A B C D E F G H I J L M N O P R S T U V W X Z 
All Classes All Packages + + +

A

+
+
accepts(ZipEntry) - Method in interface org.openpreservation.format.zip.ZipEntryProcessor
Returns true if the processor accepts the supplied ZipEntry for processing.
-
add(String, String) - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
+
add(String, String) - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
 
-
add(String, Collection<? extends Message>) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
add(String, Collection<? extends Message>) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
-
Add a Collection of Messages to the log for a particular path.
+
Add a Collection of Messages to the log for a particular path.
-
add(String, Collection<? extends Message>) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
add(String, Collection<? extends Message>) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
add(String, Message) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
add(String, Message) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Add a Message to the log for a particular path.
-
add(String, Message) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
add(String, Message) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
add(Map<String, List<Message>>) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
add(Map<String, List<Message>>) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Add a map of messages to the log.
-
addAll(Map<String, List<Message>>) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
addAll(Map<String, List<Message>>) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
ANIM - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
ANIM - org.openpreservation.odf.xml.OdfNamespaces
 
-
Attribute - Interface in org.openpreservation.format.xml
+
Attribute - Interface in org.openpreservation.format.xml
An interface defining the behaviour of XML attributes.
-

B

-
-
BuildVersionProvider - Class in org.openpreservation.odf.apps
+ + + +

B

+
+
BuildVersionProvider - Class in org.openpreservation.odf.apps
A version provider that reads build version information from a properties resource.
-
BuildVersionProvider() - Constructor for class org.openpreservation.odf.apps.BuildVersionProvider
+
BuildVersionProvider() - Constructor for class org.openpreservation.odf.apps.BuildVersionProvider
 
-

C

-
-
characters(char[], int, int) - Method in class org.openpreservation.odf.xml.ExtendedConformanceFilter
+ + + +

C

+
+
characters(char[], int, int) - Method in class org.openpreservation.odf.xml.ExtendedConformanceFilter
 
-
CHART - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
CHART - org.openpreservation.odf.xml.DocumentType
Chart document type, e.g.
-
CHART - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
CHART - org.openpreservation.odf.xml.OdfNamespaces
 
-
check(OpenDocument) - Method in interface org.openpreservation.odf.validation.Profile
+
check(OpenDocument) - Method in interface org.openpreservation.odf.validation.Profile
Check the given document against the profile.
-
check(OpenDocument) - Method in interface org.openpreservation.odf.validation.Rule
+
check(OpenDocument) - Method in interface org.openpreservation.odf.validation.Rule
 
-
check(OpenDocument) - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
check(OpenDocument) - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
 
-
Check - Interface in org.openpreservation.odf.validation
+
Check - Interface in org.openpreservation.odf.validation
Interface for a check, the application of a validation rule and message to an ODF document.
-
CheckImpl - Class in org.openpreservation.odf.validation
+
CheckImpl - Class in org.openpreservation.odf.validation
+
 
+
Checks - Class in org.openpreservation.utils
 
-
Checks - Class in org.openpreservation.utils
+
clear() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
 
-
clear() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
+
close() - Method in class org.openpreservation.format.zip.ZipFileProcessor
 
-
close() - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
COL_ERR - Static variable in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
COL_ERR - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
COL_GREEN - Static variable in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
COL_GREEN - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
COL_INFO - Static variable in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
COL_INFO - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
COL_RED - Static variable in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
COL_RED - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
COL_WARN - Static variable in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
COL_WARN - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
COL_YELLOW - Static variable in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
COL_YELLOW - Static variable in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
colourise(String, String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
colourise(String, String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
colourise(Path, Message) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
colourise(Path, Message) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
colourise(Path, Message, String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
colourise(Path, Message, String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
colourise(Message) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
colourise(Message) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
colourise(Message, String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
colourise(Message, String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
CONFIG - org.openpreservation.odf.xml.OdfNamespaces
 
-
CONFIG - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
ConsoleFormatter - Enum in org.openpreservation.odf.apps
 
-
ConsoleFormatter - Enum Class in org.openpreservation.odf.apps
+
Constants - Class in org.openpreservation.odf.fmt
 
-
Constants - Class in org.openpreservation.odf.fmt
+
Constants - Class in org.openpreservation.odf.pkg
 
-
Constants - Class in org.openpreservation.odf.pkg
+
Constants - Class in org.openpreservation.odf.xml
 
-
Constants - Class in org.openpreservation.odf.xml
+
convert(String) - Method in class org.openpreservation.odf.apps.FormatsConverter
 
-
create(boolean, boolean[]) - Static method in class org.openpreservation.odf.apps.DebugInfo
+
create(boolean, boolean[]) - Static method in class org.openpreservation.odf.apps.DebugInfo
Static factory method to create a DebugInfo instance.
-

D

-
-
DATABASE - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+ + + +

D

+
+
DATABASE - org.openpreservation.odf.xml.DocumentType
Database document type, e.g.
-
DB - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
DB - org.openpreservation.odf.xml.OdfNamespaces
 
-
DC - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
DC - org.openpreservation.odf.xml.OdfNamespaces
 
-
DebugInfo - Class in org.openpreservation.odf.apps
+
DebugInfo - Class in org.openpreservation.odf.apps
 
-
DEFAULT_MESSAGE - Static variable in enum class org.openpreservation.odf.validation.messages.Messages
+
DEFAULT_MESSAGE - Static variable in enum org.openpreservation.odf.validation.messages.Messages
 
-
detectedFormat - Variable in class org.openpreservation.odf.Source
+
detectedFormat - Variable in class org.openpreservation.odf.Source
 
-
Documents - Class in org.openpreservation.odf.document
+
Documents - Class in org.openpreservation.odf.document
 
-
DocumentType - Enum Class in org.openpreservation.odf.xml
+
DocumentType - Enum in org.openpreservation.odf.xml
Enum representing the type of ODF document.
-
DR3D - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
DR3D - org.openpreservation.odf.xml.OdfNamespaces
 
-
DRAW - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
DRAW - org.openpreservation.odf.xml.OdfNamespaces
 
-
DRAWING - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
DRAWING - org.openpreservation.odf.xml.DocumentType
Drawing document type, e.g.
-
DS - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
DS - org.openpreservation.odf.xml.OdfNamespaces
 
-
DSIG - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
DSIG - org.openpreservation.odf.xml.OdfNamespaces
 
-

E

-
-
EmbeddedObjectsRule - Class in org.openpreservation.odf.validation.rules
+ + + +

E

+
+
EmbeddedObjectsRule - Class in org.openpreservation.odf.validation.rules
 
-
EMPTY_MESSAGE - Static variable in enum class org.openpreservation.odf.validation.messages.Messages
+
EMPTY_MESSAGE - Static variable in enum org.openpreservation.odf.validation.messages.Messages
 
-
encoding - Variable in enum class org.openpreservation.format.xml.Encodings
+
encoding - Variable in enum org.openpreservation.format.xml.Encodings
The String encoding name for the Byte Order Mark
-
Encodings - Enum Class in org.openpreservation.format.xml
+
Encodings - Enum in org.openpreservation.format.xml
An enum defining the Byte Order Marks for UTF-8, UTF-16 and UTF-32.
-
endElement(String, String, String) - Method in class org.openpreservation.odf.xml.ExtendedConformanceFilter
+
endElement(String, String, String) - Method in class org.openpreservation.odf.xml.ExtendedConformanceFilter
 
-
equals(Object) - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
equals(Object) - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
equals(Object) - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
equals(Object) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
equals(Object) - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
errMessage(String, String) - Static method in class org.openpreservation.utils.Checks
 
-
errMessage(String, String) - Static method in class org.openpreservation.utils.Checks
+
error(String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
error(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
error(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
 
-
error(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
-
 
-
ERROR - Enum constant in enum class org.openpreservation.odf.validation.messages.Message.Severity
+
ERROR - org.openpreservation.odf.validation.messages.Message.Severity
The message is an error, equivalent to MUST
-
existingFileCheck(Path) - Static method in class org.openpreservation.utils.Checks
+
existingFileCheck(Path) - Static method in class org.openpreservation.utils.Checks
 
-
ExtendedConformanceFilter - Class in org.openpreservation.odf.xml
+
ExtendedConformanceFilter - Class in org.openpreservation.odf.xml
 
-
ExtendedConformanceFilter(Version) - Constructor for class org.openpreservation.odf.xml.ExtendedConformanceFilter
+
ExtendedConformanceFilter(Version) - Constructor for class org.openpreservation.odf.xml.ExtendedConformanceFilter
Creates a new instance of NamespaceFilter
-
extendedOdf2() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
extendedOdf2() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
extension - Variable in enum class org.openpreservation.odf.fmt.Formats
+
extension - Variable in enum org.openpreservation.odf.fmt.Formats
The String extension associated with the MIME type
-
extractorInstance(Path, boolean) - Static method in class org.openpreservation.format.zip.Zips
+
extractorInstance(Path, boolean) - Static method in class org.openpreservation.format.zip.Zips
Create a ZipEntryProcessor instance that processes the entries and extracts them to the supplied root Path.
-

F

-
-
factoryInstance() - Static method in class org.openpreservation.format.zip.Zips
+ + + +

F

+
+
factoryInstance() - Static method in class org.openpreservation.format.zip.Zips
Create a ZipProcessor.Factory instance that can be used to create ZipProcessor instances.
-
FATAL - Enum constant in enum class org.openpreservation.odf.validation.messages.Message.Severity
+
FATAL - org.openpreservation.odf.validation.messages.Message.Severity
The message is a fatal error, usually an system issue
-
fatalError(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
+
fatalError(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
 
-
FileEntry - Interface in org.openpreservation.odf.pkg
+
FileEntry - Interface in org.openpreservation.odf.pkg
 
-
FileType - Enum Class in org.openpreservation.odf.document
+
FileType - Enum in org.openpreservation.odf.document
Enum representing the type of ODF file.
-
FLAT_XML - Enum constant in enum class org.openpreservation.odf.document.FileType
+
FLAT_XML - org.openpreservation.odf.document.FileType
OpenDocument flat XML files.
-
FO - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
FO - org.openpreservation.odf.xml.OdfNamespaces
 
-
FORM - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
FORM - org.openpreservation.odf.xml.OdfNamespaces
 
-
Formats - Enum Class in org.openpreservation.odf.fmt
+
Formats - Enum in org.openpreservation.odf.fmt
The Formats enum represents the different formats supported by the ODF validator.
-
FormatSniffer - Class in org.openpreservation.odf.fmt
+
FormatsConverter - Class in org.openpreservation.odf.apps
+
 
+
FormatsConverter() - Constructor for class org.openpreservation.odf.apps.FormatsConverter
 
-
FORMULA - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
FormatSniffer - Class in org.openpreservation.odf.fmt
+
 
+
FORMULA - org.openpreservation.odf.xml.DocumentType
Formula document type, e.g.
-
from(Path) - Static method in class org.openpreservation.odf.Source
+
from(Path) - Static method in class org.openpreservation.odf.Source
Create a new source from a Path
-
from(ZipEntryProcessor) - Method in interface org.openpreservation.format.zip.ZipProcessor.Factory
+
from(ZipEntryProcessor) - Method in interface org.openpreservation.format.zip.ZipProcessor.Factory
Factory for creating a ZipProcessor from a ZipEntryProcessor.
-
fromEncoding(String) - Static method in enum class org.openpreservation.format.xml.Encodings
+
fromEncoding(String) - Static method in enum org.openpreservation.format.xml.Encodings
Get an Encodings instance from the String name or Encodings.NONE if no match
-
fromExtension(String) - Static method in enum class org.openpreservation.odf.fmt.Formats
+
fromExtension(String) - Static method in enum org.openpreservation.odf.fmt.Formats
Identifies the format based on the provided file extension.
-
fromId(String) - Static method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
fromId(String) - Static method in enum org.openpreservation.odf.xml.OdfNamespaces
Get an instance of OdfNamespaces from a namespace ID string.
-
fromId(URI) - Static method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
fromId(URI) - Static method in enum org.openpreservation.odf.xml.OdfNamespaces
Get an instance of OdfNamespaces from a namespace ID URI.
-
fromMime(String) - Static method in enum class org.openpreservation.odf.fmt.Formats
+
fromMime(String) - Static method in enum org.openpreservation.odf.fmt.Formats
Identifies the format based on the provided MIME type.
-
fromPrefix(String) - Static method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
fromPrefix(String) - Static method in enum org.openpreservation.odf.xml.OdfNamespaces
Get an instance of OdfNamespaces from a prefix.
-
fromRepresentation(byte[]) - Static method in enum class org.openpreservation.format.xml.Encodings
+
fromRepresentation(byte[]) - Static method in enum org.openpreservation.format.xml.Encodings
Get an Encodings instance from the byte array representation, or Encodings.NONE if no match.
-
fromVersion(String) - Static method in enum class org.openpreservation.odf.xml.Version
+
fromVersion(String) - Static method in enum org.openpreservation.odf.xml.Version
Returns the Version enum constant based on the provided version string.
-

G

-
-
getBodyElementName() - Method in enum class org.openpreservation.odf.xml.DocumentType
+ + + +

G

+
+
getBodyElementName() - Method in enum org.openpreservation.odf.xml.DocumentType
Get the body element name associated with this document type.
-
getBytes() - Method in enum class org.openpreservation.odf.fmt.Formats
+
getBytes() - Method in enum org.openpreservation.odf.fmt.Formats
Get the MIME type as an ASCII encoded byte array.
-
getChecks() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getChecks() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all messages in the log.
-
getChecks() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getChecks() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get a list of all checks, from all Results contained in the file.
-
getChecks() - Method in interface org.openpreservation.odf.validation.ValidationResult
+
getChecks() - Method in interface org.openpreservation.odf.validation.ValidationResult
Get all of the validation messages for the OpenDocument.
-
getChecks() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
getChecks() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
getChecksById(String) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getChecksById(String) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all messages in the log for a particular ID
-
getChecksBySeverity(Message.Severity) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getChecksBySeverity(Message.Severity) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all messages in the log of a particular severity.
-
getChecksForPath(String) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getChecksForPath(String) - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all messages in the log for a particular path
-
getCompressedSize() - Method in interface org.openpreservation.format.zip.ZipEntry
+
getCompressedSize() - Method in interface org.openpreservation.format.zip.ZipEntry
Get the compressed size of the entry in bytes
-
getCompressedSize() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
getCompressedSize() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
getCrc() - Method in interface org.openpreservation.format.zip.ZipEntry
+
getCrc() - Method in interface org.openpreservation.format.zip.ZipEntry
Get the CRC of the entry
-
getCrc() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
getCrc() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
getDeclaredNamespaces() - Method in interface org.openpreservation.format.xml.ParseResult
+
getDeclaredNamespaces() - Method in interface org.openpreservation.format.xml.ParseResult
Get all of the declared Namespaces in the document
-
getDescription() - Method in interface org.openpreservation.odf.validation.Profile
+
getDescription() - Method in interface org.openpreservation.odf.validation.Profile
Get a short description of the profile.
-
getDescription() - Method in interface org.openpreservation.odf.validation.Rule
-
 
-
getDescription() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
getDescription() - Method in interface org.openpreservation.odf.validation.Rule
 
-
getDescription() - Method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
getDescription() - Method in enum org.openpreservation.odf.xml.OdfNamespaces
Get a description of the namespace.
-
getDetectedFormat() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getDetectedFormat() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the detected Formats of the package.
+
Get the detected Formats of the package.
-
getDetectedFormat() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getDetectedFormat() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get the detected format of the OpenDocument.
-
getDetectedVersion() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getDetectedVersion() - Method in interface org.openpreservation.odf.pkg.OdfPackage
-
Get the detected Version of the package.
+
Get the detected Version of the package.
-
getDnaProfile(boolean) - Static method in class org.openpreservation.odf.validation.rules.Rules
+
getDnaProfile(boolean) - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
getDocument() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getDocInfoMessages(OdfXmlDocument) - Static method in class org.openpreservation.odf.validation.OdfXmlValidator
+
 
+
getDocument() - Method in interface org.openpreservation.odf.document.OpenDocument
Get the main ODF Document details, this will be the only document for a single XML file, a package may have sub-documents
-
getDocument() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getDocument() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the OdfPackageDocument for the package, this is the root document of the ODF Package
-
getDocumentEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getDocumentEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the set of FileEntry objects that are documents, i.e.
-
getDocumentMap() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getDocumentMap() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the Map of the package's OdfPackageDocument objects by String path key.
-
getDocumentType() - Method in interface org.openpreservation.odf.document.OdfDocument
+
getDocumentType() - Method in interface org.openpreservation.odf.document.OdfDocument
Gets the parsed type of the ODF document.
-
getEncryptedEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getEncryptedEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the Set of FileEntry objects fior all manifest entries with encryption XML data.
-
getEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getEntries() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the Set of FileEntry objects in the Manifest.
-
getEntriesByMediaType(String) - Method in interface org.openpreservation.odf.pkg.Manifest
+
getEntriesByMediaType(String) - Method in interface org.openpreservation.odf.pkg.Manifest
Get the Set of FileEntry objects in the Manifest that have the supplied media type.
-
getEntry(String) - Method in interface org.openpreservation.odf.pkg.Manifest
+
getEntry(String) - Method in interface org.openpreservation.odf.pkg.Manifest
Get a manifest entry by name
-
getEntryCount() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getEntryCount() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the number of entries in the Manifest.
-
getEntryInputStream(String) - Method in interface org.openpreservation.format.zip.ZipArchiveCache
+
getEntryInputStream(String) - Method in interface org.openpreservation.format.zip.ZipArchiveCache
Get the InputStream for the entry with the passed name, equivalent to the path.
-
getEntryInputStream(String) - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
getEntryInputStream(String) - Method in class org.openpreservation.format.zip.ZipFileProcessor
 
-
getEntryMediaType(String) - Method in interface org.openpreservation.odf.pkg.Manifest
+
getEntryMediaType(String) - Method in interface org.openpreservation.odf.pkg.Manifest
Get a manifest entry media type by name
-
getEntryStream(FileEntry) - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getEntryStream(FileEntry) - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the InputStream for any item from the document's Manifest
-
getEntryXmlParseResult(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getEntryXmlParseResult(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the XML ParseResult of and identified ODF XML documents in the package
-
getEntryXmlStream(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getEntryXmlStream(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the InputStream to any of an identified ODF XML document in the package
-
getError(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getError(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve error Message by unique persistent id
-
getError(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getError(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve error Message by unique persistent id and format with the given arguments
-
getErrorCount() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getErrorCount() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get the number of error messages in the log.
-
getErrors() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getErrors() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all error messages in the log.
-
getExtendedValidatingParser() - Static method in class org.openpreservation.odf.validation.OdfValidators
+
getExtendedValidatingParser() - Static method in class org.openpreservation.odf.validation.OdfValidators
Get a validating parser instance that implements extended validation/conformance.
-
getExtra() - Method in interface org.openpreservation.format.zip.ZipEntry
+
getExtra() - Method in interface org.openpreservation.format.zip.ZipEntry
Get the extra field data for the entry
-
getExtra() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
getExtra() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
getFatal(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getFatal(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve fatal Message by unique persistent id
-
getFatal(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getFatal(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve error Message by unique persistent id and format with the given arguments
-
getFileEntry() - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
+
getFileEntry() - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
Returns the manifest file entry for the package document.
-
getFilename() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getFilename() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get the name of the document being validated.
-
getFileType() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getFileType() - Method in interface org.openpreservation.odf.document.OpenDocument
Indicates the type of OpenDocument, a zip archive package or a single XML file
-
getFirstEntry() - Method in interface org.openpreservation.format.zip.ZipArchive
+
getFirstEntry() - Method in interface org.openpreservation.format.zip.ZipArchive
Returns the first physical ZipEntry in the archive.
-
getFirstEntry() - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
getFirstEntry() - Method in class org.openpreservation.format.zip.ZipFileProcessor
Returns the first physical ZipEntry in the archive.
-
getForeignNamespaces() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getForeignNamespaces() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the set of foreign namespaces used in the document, e.g.
-
getFormat() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getFormat() - Method in interface org.openpreservation.odf.document.OpenDocument
Get the format of the OpenDocument, this will be the declared format of the package or the parsed format of a single document.
-
getFormat() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getFormat() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get the detected format of the OpenDocument.
-
getFormat() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getFormat() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the declared ODF MIME type of the document, parsed from a root element attribute
-
getFormats() - Method in enum class org.openpreservation.odf.xml.DocumentType
+
getFormats() - Method in enum org.openpreservation.odf.xml.DocumentType
Get the set of formats associated with this document type.
-
getFullPath() - Method in interface org.openpreservation.odf.pkg.FileEntry
+
getFullPath() - Method in interface org.openpreservation.odf.pkg.FileEntry
Get the full internal path of the file entry.
-
getId() - Method in interface org.openpreservation.format.xml.Namespace
+
getId() - Method in interface org.openpreservation.format.xml.Namespace
Get the URI id of the Namespace.
-
getId() - Method in interface org.openpreservation.odf.validation.messages.Message
+
getId() - Method in interface org.openpreservation.odf.validation.messages.Message
Get the unique, persistent message identifier.
-
getId() - Method in interface org.openpreservation.odf.validation.Profile
+
getId() - Method in interface org.openpreservation.odf.validation.Profile
Get the id of the profile.
-
getId() - Method in interface org.openpreservation.odf.validation.Rule
-
 
-
getId() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
getId() - Method in interface org.openpreservation.odf.validation.Rule
 
-
getId() - Method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
getId() - Method in enum org.openpreservation.odf.xml.OdfNamespaces
 
-
getIndex() - Method in interface org.openpreservation.format.xml.Attribute
+
getIndex() - Method in interface org.openpreservation.format.xml.Attribute
Get the index of the Attribute in the element Array.
-
getInfo(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getInfo(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve info Message by unique persistent id
-
getInfo(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getInfo(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve info Message by unique persistent id and format with the given arguments
-
getInfoCount() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getInfoCount() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get the number of info messages in the log.
-
getInfos() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getInfos() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all info messages in the log.
-
getInstance() - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getInstance() - Static method in enum org.openpreservation.odf.validation.messages.Messages
Get a MessageFactory instance with the default property based bundle name and the default user locale
-
getInstance(String) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getInstance(String) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Get a MessageFactory instance with the requested property based bundle name and the default user locale
-
getInstance(String, Locale) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getInstance(String, Locale) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Get a MessageFactory instance with the requested property based bundle name and a specific locale
-
getJsonReport(ValidationReport) - Static method in class org.openpreservation.odf.validation.ValidationReports
+
getJsonReport(ValidationReport) - Static method in class org.openpreservation.odf.validation.ValidationReports
Convert a ValidationReport to a JSON string.
-
getLength() - Method in enum class org.openpreservation.format.xml.Encodings
+
getLength() - Method in enum org.openpreservation.format.xml.Encodings
Returns the length of the Byte Order Mark in bytes
-
getLength() - Method in enum class org.openpreservation.odf.fmt.Signatures
+
getLength() - Method in enum org.openpreservation.odf.fmt.Signatures
 
-
getLocalName() - Method in interface org.openpreservation.format.xml.Attribute
+
getLocalName() - Method in interface org.openpreservation.format.xml.Attribute
Get the String local name of the Attribute.
-
getLocalRootName() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getLocalRootName() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the name of the local/unqualified of the document's root element.
-
getManifest() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getManifest() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the Manifest object for the package, this is parsed as long as the META-INF/manifest.xml file exists and is a well formed XML document.
-
getManifest() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getManifest() - Method in interface org.openpreservation.odf.validation.ValidationReport
The Manifest object for the ODF document.
-
getMaxSignatureLength() - Method in enum class org.openpreservation.odf.fmt.Formats
+
getMaxSignatureLength() - Method in enum org.openpreservation.odf.fmt.Formats
Get the maximum length of a signature for the format.
-
getMediaType() - Method in interface org.openpreservation.odf.pkg.FileEntry
+
getMediaType() - Method in interface org.openpreservation.odf.pkg.FileEntry
Get the declared media type of the file entry.
-
getMessage() - Method in interface org.openpreservation.odf.validation.Check
+
getMessage() - Method in interface org.openpreservation.odf.validation.Check
Get the message associated with the check.
-
getMessage() - Method in class org.openpreservation.odf.validation.CheckImpl
+
getMessage() - Method in class org.openpreservation.odf.validation.CheckImpl
 
-
getMessage(String, Message.Severity) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getMessage(String, Message.Severity) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve Message by unique persistent id and Severity
-
getMessage(String, Message.Severity, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getMessage(String, Message.Severity, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve Message by unique persistent id and format with the given arguments
-
getMessageInstance(String) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getMessageInstance(String) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a new message instance with a DEFAULT_ID
-
getMessageInstance(String, Message.Severity, String) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getMessageInstance(String, Message.Severity, String) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a Message instance with the give id and message value
-
getMessageInstance(String, Message.Severity, String, String) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getMessageInstance(String, Message.Severity, String, String) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a new Message instance with the given id, message and sub-message
-
getMessageInstance(String, Message.Severity, String, String, Parameter.ParameterList) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getMessageInstance(String, Message.Severity, String, String, Parameter.ParameterList) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a new Message instance with the given id, message and sub-message
-
getMessageInstance(String, Message.Severity, String, Parameter.ParameterList) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
getMessageInstance(String, Message.Severity, String, Parameter.ParameterList) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a Message instance with the give id and message value
-
getMessageLog() - Method in interface org.openpreservation.odf.validation.ValidationResult
+
getMessageLog() - Method in interface org.openpreservation.odf.validation.ValidationResult
Get the profile message log
-
getMessageLog() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
getMessageLog() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
getMessages() - Method in interface org.openpreservation.format.xml.ParseResult
+
getMessages() - Method in interface org.openpreservation.format.xml.ParseResult
The List of Message instances generated when parsing the document, which may be empty
-
getMessages() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getMessages() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all messages in the log.
-
getMetadata() - Method in interface org.openpreservation.odf.document.OdfDocument
+
getMetadata() - Method in interface org.openpreservation.odf.document.OdfDocument
Gets the Metadata object parsed from the main ODF XML document for single file XML documents or from the meta.xml file for documents parsed from a package.
-
getMetadata() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getMetadata() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get the Metadata object for the ODF document.
-
getMetaInfMap() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getMetaInfMap() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Retrieve the Map of String path keys and ParseResult values for any ZipEntry below the META-INF directory.
-
getMethod() - Method in interface org.openpreservation.format.zip.ZipEntry
+
getMethod() - Method in interface org.openpreservation.format.zip.ZipEntry
Get the integer code for the compression method used for the entry.
-
getMethod() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
getMethod() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
getMimeType() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getMimeType() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the declared mimetype of the package.
-
getName() - Method in interface org.openpreservation.format.zip.ZipEntry
+
getName() - Method in interface org.openpreservation.format.zip.ZipEntry
Get the name of the entry
-
getName() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
getName() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
getName() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getName() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the name or identifier of the package, often the path to the file parsed.
-
getName() - Method in interface org.openpreservation.odf.validation.messages.Parameter
+
getName() - Method in interface org.openpreservation.odf.validation.messages.Parameter
 
-
getName() - Method in interface org.openpreservation.odf.validation.Profile
+
getName() - Method in interface org.openpreservation.odf.validation.Profile
Get the name of the profile.
-
getName() - Method in interface org.openpreservation.odf.validation.Rule
+
getName() - Method in interface org.openpreservation.odf.validation.Rule
 
-
getName() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
-
 
-
getName() - Method in interface org.openpreservation.odf.validation.ValidationResult
+
getName() - Method in interface org.openpreservation.odf.validation.ValidationResult
Get the name of the validation profile been used.
-
getName() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
getName() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
getName() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
+
getName() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
Get the name of the user defined field.
-
getNonValidatingFactory() - Static method in class org.openpreservation.format.xml.XmlParsers
+
getNonValidatingFactory() - Static method in class org.openpreservation.format.xml.XmlParsers
Convenience method to obtain a pre-configured SAXParserFactory that is not validating and is namespace aware.
-
getNonValidatingParser() - Static method in class org.openpreservation.format.xml.XmlParsers
+
getNonValidatingParser() - Static method in class org.openpreservation.format.xml.XmlParsers
Obtains a pre-configured XmlParser that is non validating.
-
getOdfValidator() - Static method in class org.openpreservation.odf.validation.OdfValidators
+
getOdfValidator() - Static method in class org.openpreservation.odf.validation.OdfValidators
 
-
getOdfValidator(boolean) - Static method in class org.openpreservation.odf.validation.OdfValidators
+
getOdfValidator(boolean) - Static method in class org.openpreservation.odf.validation.OdfValidators
 
-
getOpenDocument() - Method in class org.openpreservation.odf.Source
+
getOpenDocument() - Method in class org.openpreservation.odf.Source
 
-
getPackage() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getPackage() - Method in interface org.openpreservation.odf.document.OpenDocument
Get the ODF Package for the OpenDocument, this will be null for a single XML file.
-
getPackageParser() - Static method in class org.openpreservation.odf.pkg.OdfPackages
+
getPackageParser() - Static method in class org.openpreservation.odf.pkg.OdfPackages
A factory method for PackageParser instances.
-
getParameters() - Method in interface org.openpreservation.odf.validation.messages.Message
+
getParameters() - Method in interface org.openpreservation.odf.validation.messages.Message
Get the parameters
-
getParseResult() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getParseResult() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the parse result of the XML document
-
getPath() - Method in interface org.openpreservation.format.zip.ZipArchive
+
getPath() - Method in interface org.openpreservation.format.zip.ZipArchive
Get the path to the archive
-
getPath() - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
getPath() - Method in class org.openpreservation.format.zip.ZipFileProcessor
 
-
getPath() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getPath() - Method in interface org.openpreservation.odf.document.OpenDocument
Get the path to the OpenDocument file.
-
getPath() - Method in interface org.openpreservation.odf.validation.Check
+
getPath() - Method in interface org.openpreservation.odf.validation.Check
Get the path to the element in the ODF document that the check applies to.
-
getPath() - Method in class org.openpreservation.odf.validation.CheckImpl
+
getPath() - Method in class org.openpreservation.odf.validation.CheckImpl
 
-
getPrefix() - Method in interface org.openpreservation.format.xml.Attribute
+
getPrefix() - Method in interface org.openpreservation.format.xml.Attribute
Get the String namespace prefix of the Attribute.
-
getPrefix() - Method in interface org.openpreservation.format.xml.Namespace
+
getPrefix() - Method in interface org.openpreservation.format.xml.Namespace
Get the String prefix of the Namespace.
-
getPrefix() - Method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
getPrefix() - Method in enum org.openpreservation.odf.xml.OdfNamespaces
 
-
getQualifiedName() - Method in interface org.openpreservation.format.xml.Attribute
+
getQualifiedName() - Method in interface org.openpreservation.format.xml.Attribute
Get the qualified name of the Attribute.
-
getReport(ValidationReport, ValidationReports.FormatOption) - Static method in class org.openpreservation.odf.validation.ValidationReports
+
getReport(ValidationReport, ValidationReports.FormatOption) - Static method in class org.openpreservation.odf.validation.ValidationReports
Get a string representation of the validation report in the specified format.
-
getResult(boolean, List<Message>) - Method in class org.openpreservation.format.xml.ParsingHandler
+
getResult(boolean, List<Message>) - Method in class org.openpreservation.format.xml.ParsingHandler
 
-
getRootAttributes() - Method in interface org.openpreservation.format.xml.ParseResult
+
getRootAttributes() - Method in interface org.openpreservation.format.xml.ParseResult
Get the root element Attributes
-
getRootAttributeValue(String) - Method in interface org.openpreservation.format.xml.ParseResult
+
getRootAttributeValue(String) - Method in interface org.openpreservation.format.xml.ParseResult
Get the value of the root element attribute with the supplied qualified name.
-
getRootMediaType() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getRootMediaType() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the declared media type of the Manifest from the root "/" element.
-
getRootName() - Method in interface org.openpreservation.format.xml.ParseResult
+
getRootName() - Method in interface org.openpreservation.format.xml.ParseResult
Get the unqualified name of the document's root element
-
getRootName() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getRootName() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the namespace prefixed/qualfied name of the document's root element.
-
getRootNamespace() - Method in interface org.openpreservation.format.xml.ParseResult
+
getRootNamespace() - Method in interface org.openpreservation.format.xml.ParseResult
Get the Namespace associated with the document's root element
-
getRootNamespace() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getRootNamespace() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the default namespace associated with the root element of the document
-
getRootPrefix() - Method in interface org.openpreservation.format.xml.ParseResult
+
getRootPrefix() - Method in interface org.openpreservation.format.xml.ParseResult
Get the root element namespace prefix
-
getRootVersion() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getRootVersion() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the declared version of the ODF package from the root "/" element.
-
getRules() - Method in interface org.openpreservation.odf.validation.Profile
+
getRules() - Method in interface org.openpreservation.odf.validation.Profile
Get the set of rules that comprise the profile.
-
getSchema(OdfNamespaces, Version) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
+
getSchema(OdfNamespaces, Version) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
 
-
getSchemalocation() - Method in interface org.openpreservation.format.xml.Namespace
+
getSchemalocation() - Method in interface org.openpreservation.format.xml.Namespace
Get the String location of the Namespace.
-
getSchemalocation() - Method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
getSchemalocation() - Method in enum org.openpreservation.odf.xml.OdfNamespaces
 
-
getSchemas(Set<OdfNamespaces>, Version) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
+
getSchemas(Set<OdfNamespaces>, Version) - Method in class org.openpreservation.odf.xml.OdfSchemaFactory
 
-
getSeverity() - Method in interface org.openpreservation.odf.validation.messages.Message
+
getSeverity() - Method in interface org.openpreservation.odf.validation.messages.Message
Get the message severity
-
getSeverity() - Method in interface org.openpreservation.odf.validation.Rule
-
 
-
getSeverity() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
getSeverity() - Method in interface org.openpreservation.odf.validation.Rule
 
-
getSignature() - Method in enum class org.openpreservation.odf.fmt.Signatures
+
getSignature() - Method in enum org.openpreservation.odf.fmt.Signatures
 
-
getSignatureCount() - Method in enum class org.openpreservation.odf.fmt.Formats
+
getSignatureCount() - Method in enum org.openpreservation.odf.fmt.Formats
Get the number of signatures for the format.
-
getSize() - Method in interface org.openpreservation.format.zip.ZipEntry
+
getSize() - Method in interface org.openpreservation.format.zip.ZipEntry
Get the size of the entry in bytes
-
getSize() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
getSize() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
getSize() - Method in interface org.openpreservation.odf.pkg.FileEntry
+
getSize() - Method in interface org.openpreservation.odf.pkg.FileEntry
The size of the file entry in bytes.
-
getStringValue(String) - Method in interface org.openpreservation.odf.xml.Metadata
+
getStringValue(String) - Method in interface org.openpreservation.odf.xml.Metadata
Get the String value for the supplied qualified name.
-
getStringValue(String, String) - Method in interface org.openpreservation.odf.xml.Metadata
+
getStringValue(String, String) - Method in interface org.openpreservation.odf.xml.Metadata
Look up the string value by prefix and local name.
-
getStringValueMap() - Method in interface org.openpreservation.odf.xml.Metadata
+
getStringValueMap() - Method in interface org.openpreservation.odf.xml.Metadata
The qualified Name value Map of all of the qualifiedName:string pairs found in the metadata block.
-
getSubDocument(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getSubDocument(String) - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get an OdfPackageDocument for a sub-document identified by the passed String path.
-
getSubDocuments() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getSubDocuments() - Method in interface org.openpreservation.odf.document.OpenDocument
For and ODF Package get the sub-documents, these will be the documents in the package other than the main document.
-
getText() - Method in interface org.openpreservation.odf.validation.messages.Message
+
getText() - Method in interface org.openpreservation.odf.validation.messages.Message
Get the sub-message
-
getTimestamp() - Method in interface org.openpreservation.odf.validation.messages.Message
+
getTimestamp() - Method in interface org.openpreservation.odf.validation.messages.Message
Get the message timestamp
-
getTitle() - Method in interface org.openpreservation.odf.validation.messages.Message
+
getTitle() - Method in interface org.openpreservation.odf.validation.messages.Message
Get the main message
-
getType() - Method in interface org.openpreservation.format.xml.Attribute
+
getType() - Method in interface org.openpreservation.format.xml.Attribute
Get the String type of the Attribute.
-
getTypeByBodyElement(String) - Static method in enum class org.openpreservation.odf.xml.DocumentType
+
getTypeByBodyElement(String) - Static method in enum org.openpreservation.odf.xml.DocumentType
Get the document type by the body element name.
-
getTypeByFormat(Formats) - Static method in enum class org.openpreservation.odf.xml.DocumentType
+
getTypeByFormat(Formats) - Static method in enum org.openpreservation.odf.xml.DocumentType
Get the document type by the format.
-
getTypeByMimeString(String) - Static method in enum class org.openpreservation.odf.xml.DocumentType
+
getTypeByMimeString(String) - Static method in enum org.openpreservation.odf.xml.DocumentType
Get the document type by the MIME type.
-
getURI() - Method in interface org.openpreservation.format.xml.Attribute
+
getURI() - Method in interface org.openpreservation.format.xml.Attribute
Get the String namespace URI of the Attribute.
-
getUsedNamespaces() - Method in interface org.openpreservation.format.xml.ParseResult
+
getUsedNamespaces() - Method in interface org.openpreservation.format.xml.ParseResult
Get all of the declared Namespaces in the document
-
getUserDefinedFields() - Method in interface org.openpreservation.odf.xml.Metadata
+
getUserDefinedFields() - Method in interface org.openpreservation.odf.xml.Metadata
Get the user defined fields from the metadata block
-
getValidatingParser() - Static method in class org.openpreservation.odf.validation.OdfValidators
+
getValidatingParser() - Static method in class org.openpreservation.odf.validation.OdfValidators
Get a non-extended validating parser instance.
-
getValidatingParser(boolean) - Static method in class org.openpreservation.odf.validation.OdfValidators
+
getValidatingParser(boolean) - Static method in class org.openpreservation.odf.validation.OdfValidators
Get either an extended or non-extended validating parser instance.
-
getValidationResults() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getValidationResults() - Method in interface org.openpreservation.odf.validation.ValidationReport
The Validation result for the ODF document.
-
getValue() - Method in interface org.openpreservation.format.xml.Attribute
+
getValue() - Method in interface org.openpreservation.format.xml.Attribute
Get the String value of the Attribute.
-
getValue() - Method in interface org.openpreservation.odf.validation.messages.Parameter
+
getValue() - Method in interface org.openpreservation.odf.validation.messages.Parameter
 
-
getValue() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
+
getValue() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
The String representation of the user defined field's value.
-
getValueType() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
+
getValueType() - Method in interface org.openpreservation.odf.xml.Metadata.UserDefinedField
The defined data type of the user defined field's value.
-
getVersion() - Method in class org.openpreservation.odf.apps.BuildVersionProvider
+
getVersion() - Method in class org.openpreservation.odf.apps.BuildVersionProvider
 
-
getVersion() - Method in interface org.openpreservation.odf.document.OdfDocument
+
getVersion() - Method in interface org.openpreservation.odf.document.OdfDocument
Gets the version of the ODF document
-
getVersion() - Method in interface org.openpreservation.odf.document.OpenDocument
+
getVersion() - Method in interface org.openpreservation.odf.document.OpenDocument
Get the version of the OpenDocument.
-
getVersion() - Method in interface org.openpreservation.odf.pkg.FileEntry
+
getVersion() - Method in interface org.openpreservation.odf.pkg.FileEntry
Get's the version of the file entry if it's declared.
-
getVersion() - Method in interface org.openpreservation.odf.pkg.Manifest
+
getVersion() - Method in interface org.openpreservation.odf.pkg.Manifest
Get the declared version of the Manifest from the root element.
-
getVersion() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getVersion() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get the detected format of the OpenDocument.
-
getVersion() - Method in interface org.openpreservation.odf.xml.Metadata
+
getVersion() - Method in interface org.openpreservation.odf.xml.Metadata
Return the office version of the Metadata data.
-
getVersion() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
getVersion() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Get the ODF version of the XML document, parsed from a root element attribute
-
getVersionString() - Static method in class org.openpreservation.odf.apps.BuildVersionProvider
+
getVersionString() - Static method in class org.openpreservation.odf.apps.BuildVersionProvider
Get a formatted string representing the application version.
-
getVersionString() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
getVersionString() - Method in interface org.openpreservation.odf.validation.ValidationReport
Get the detected format of the OpenDocument.
-
getWarning(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getWarning(String) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve warning Message by unique persistent id
-
getWarning(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
+
getWarning(String, Parameter.ParameterList) - Method in interface org.openpreservation.odf.validation.messages.MessageFactory
Retrieve warning Message by unique persistent id and format with the given arguments
-
getWarningCount() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getWarningCount() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get the number of warning messages in the log.
-
getWarnings() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
getWarnings() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get all warning messages in the log.
-
getXmlDocument() - Method in interface org.openpreservation.odf.document.OdfDocument
+
getXmlDocument() - Method in interface org.openpreservation.odf.document.OdfDocument
Returns the ODF Xml Document instance with the details of the parsed document.
-
getXmlDocument(String) - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
+
getXmlDocument(String) - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
Returns the XML document for the supplied path.
-
getXmlDocumentMap() - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
+
getXmlDocumentMap() - Method in interface org.openpreservation.odf.pkg.OdfPackageDocument
Returns the map of all XML documents in the package document.
-
getXmlEntries() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getXmlEntries() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get the Set of FileEntry to all of the identified ODF XML documents in the package.
-
getXmlEntryPaths() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getXmlEntryPaths() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Get a List paths of the package's identified ODF XML documents.
-
getXmlReport(ValidationReport) - Static method in class org.openpreservation.odf.validation.ValidationReports
+
getXmlReport(ValidationReport) - Static method in class org.openpreservation.odf.validation.ValidationReports
Convert a ValidationReport to an XML string.
-
getZipArchive() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
getZipArchive() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Returns the details of the underlying ZipArchive for the package.
-
getZipEntries() - Method in interface org.openpreservation.format.zip.ZipArchive
+
getZipEntries() - Method in interface org.openpreservation.format.zip.ZipArchive
Get a List of all of the zip entries in the archive
-
getZipEntries() - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
getZipEntries() - Method in class org.openpreservation.format.zip.ZipFileProcessor
 
-
getZipEntry(String) - Method in interface org.openpreservation.format.zip.ZipArchive
+
getZipEntry(String) - Method in interface org.openpreservation.format.zip.ZipArchive
Retrieve a ZipEntry by entry name, equivalent to the path.
-
getZipEntry(String) - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
getZipEntry(String) - Method in class org.openpreservation.format.zip.ZipFileProcessor
 
-
GRDDL - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
GRDDL - org.openpreservation.odf.xml.OdfNamespaces
 
-
GREATER_THAN_OR_EQUAL_TO - Static variable in class org.openpreservation.utils.Checks
+
GREATER_THAN_OR_EQUAL_TO - Static variable in class org.openpreservation.utils.Checks
 
-

H

-
-
hasDsigEntries() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+ + + +

H

+
+
hasDsigEntries() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Does the META-INF directory or sub-directories contain a ZipeEntry with the term "signatures" in its name.
-
hasErrors() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
hasErrors() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Does the log contain any error messages?
-
hasFatals() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
hasFatals() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Does the log contain any fatal error messages?
-
hasFormat() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
hasFormat() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Does the document declare a MIME type?
-
hashCode() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
hashCode() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
hashCode() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
hashCode() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
hashCode() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
-
 
-
hasInfos() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
hasInfos() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Does the log contain any info messages?
-
hasManifest() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
hasManifest() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Does the package have a manifest, that is a ZipEntry with the path META-INF/manifest.xml?
-
hasMimeEntry() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
hasMimeEntry() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Does the package have a mimetype ZipEntry?
-
hasRootMediaType() - Method in interface org.openpreservation.odf.pkg.Manifest
+
hasRootMediaType() - Method in interface org.openpreservation.odf.pkg.Manifest
Find out whether the manifest has a FileEntry with the full path attribute "/".
-
hasSeverity(Message.Severity) - Method in interface org.openpreservation.odf.validation.ValidationReport
+
hasSeverity(Message.Severity) - Method in interface org.openpreservation.odf.validation.ValidationReport
Do any of the contained results contain the specified severity?
-
hasText() - Method in interface org.openpreservation.odf.validation.messages.Message
+
hasText() - Method in interface org.openpreservation.odf.validation.messages.Message
Test whether the message has a sub-message
-
hasThumbnail() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
hasThumbnail() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Does the package have a ZipEntry with the path Thumbnails/thumbnail.png?
-
hasVersion() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
hasVersion() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Does the document declare a version?
-
hasWarnings() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
hasWarnings() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Does the log contain any warning messages?
-

I

-
-
identify(byte[]) - Static method in enum class org.openpreservation.odf.fmt.Formats
+ + + +

I

+
+
identify(byte[]) - Static method in enum org.openpreservation.odf.fmt.Formats
Identifies the format based on the provided byte array.
-
IMAGE - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
IMAGE - org.openpreservation.odf.xml.DocumentType
Image document type, e.g.
-
info(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
info(String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
INFO - Enum constant in enum class org.openpreservation.odf.validation.messages.Message.Severity
+
INFO - org.openpreservation.odf.validation.messages.Message.Severity
The message is informational, equivalent to MAY
-
INSTANCE - Enum constant in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
INSTANCE - org.openpreservation.odf.apps.ConsoleFormatter
 
-
INSTANCE - Enum constant in enum class org.openpreservation.odf.validation.messages.Messages
+
INSTANCE - org.openpreservation.odf.validation.messages.Messages
Ensure Messages is a singleton
-
isCompressionValid(ZipEntry) - Static method in class org.openpreservation.odf.validation.OdfValidators
+
isCompressionValid(ZipEntry) - Static method in class org.openpreservation.odf.validation.OdfValidators
Check if a zip entry has a valid compression method.
-
isDirectory() - Method in interface org.openpreservation.format.zip.ZipEntry
+
isDirectory() - Method in interface org.openpreservation.format.zip.ZipEntry
Is the entry a directory?
-
isDirectory() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
isDirectory() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
isDocument() - Method in interface org.openpreservation.odf.pkg.FileEntry
+
isDocument() - Method in interface org.openpreservation.odf.pkg.FileEntry
Is the file entry a document entry?
-
isDsig(String) - Static method in class org.openpreservation.odf.pkg.OdfPackages
+
isDsig(String) - Static method in class org.openpreservation.odf.pkg.OdfPackages
Check if the given String is an ODF spec compliant Digital Signature path.
-
isEmpty() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
isEmpty() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Is the log empty?
-
isEncrypted() - Method in interface org.openpreservation.odf.pkg.FileEntry
+
isEncrypted() - Method in interface org.openpreservation.odf.pkg.FileEntry
Is the file entry encrypted?
-
isEncrypted() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
isEncrypted() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Discover if the package had any encrypted entries.
-
isEncrypted() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
isEncrypted() - Method in interface org.openpreservation.odf.validation.ValidationReport
Determine if the OpenDocument is encrypted.
-
isError() - Method in interface org.openpreservation.odf.validation.messages.Message
+
isError() - Method in interface org.openpreservation.odf.validation.messages.Message
-
Test whether the message has Message.Severity ERROR.
+
Test whether the message has Message.Severity ERROR.
-
isExtended() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
isExtended() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Discover if the file uses any namespaces outside of the ODF specification.
-
isExtended() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
+
isExtended() - Method in interface org.openpreservation.odf.xml.OdfXmlDocument
Establish whether the document uses a namespace outside of the declared ODF namespaces.
-
isFatal() - Method in interface org.openpreservation.odf.validation.messages.Message
+
isFatal() - Method in interface org.openpreservation.odf.validation.messages.Message
-
Test whether the message has Message.Severity FATAL.
+
Test whether the message has Message.Severity FATAL.
-
isInfo() - Method in interface org.openpreservation.odf.validation.messages.Message
+
isInfo() - Method in interface org.openpreservation.odf.validation.messages.Message
-
Test whether the message has Message.Severity INFO.
+
Test whether the message has Message.Severity INFO.
-
isMatch(byte[]) - Method in enum class org.openpreservation.odf.fmt.Signatures
+
isMatch(byte[]) - Method in enum org.openpreservation.odf.fmt.Signatures
 
-
isMatch(byte[], int) - Method in enum class org.openpreservation.odf.fmt.Signatures
+
isMatch(byte[], int) - Method in enum org.openpreservation.odf.fmt.Signatures
 
-
isMimeFirst() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
isMimeFirst() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Is the mimetype ZipEntry the first ZipEntry in the package?
-
isOdf() - Method in enum class org.openpreservation.odf.fmt.Formats
+
isOdf() - Method in enum org.openpreservation.odf.fmt.Formats
Is the format a OpenDocument format?
-
isOdfXml(String) - Static method in class org.openpreservation.odf.pkg.OdfPackages
+
isOdfXml(String) - Static method in class org.openpreservation.odf.pkg.OdfPackages
Check if the passed String path is an ODF specified XML file name.
-
isPackage() - Method in interface org.openpreservation.odf.document.OpenDocument
+
isPackage() - Method in interface org.openpreservation.odf.document.OpenDocument
Is the OpenDocument an ODF package, i.e.
-
isPackage() - Method in enum class org.openpreservation.odf.fmt.Formats
+
isPackage() - Method in enum org.openpreservation.odf.fmt.Formats
Is the format a package format?
-
isPackage(File) - Static method in class org.openpreservation.odf.fmt.OdfFormats
-
 
-
isPackage(InputStream) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isPackage(File) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isPackage(String) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isPackage(InputStream) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isPackage(Path) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isPackage(String) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isPrerequisite() - Method in interface org.openpreservation.odf.validation.Rule
+
isPackage(Path) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isPrerequisite() - Method in class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
+
isPrerequisite() - Method in interface org.openpreservation.odf.validation.Rule
 
-
isRootName(String) - Method in interface org.openpreservation.format.xml.ParseResult
+
isRootName(String) - Method in interface org.openpreservation.format.xml.ParseResult
Establish whether the document's root element name matches the supplied name
-
isStored() - Method in interface org.openpreservation.format.zip.ZipEntry
+
isStored() - Method in interface org.openpreservation.format.zip.ZipEntry
Is the entry STORED, e.g.
-
isStored() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
isStored() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
isText() - Method in enum class org.openpreservation.odf.fmt.Formats
+
isText() - Method in enum org.openpreservation.odf.fmt.Formats
Is the format a text format?
-
isValid() - Method in interface org.openpreservation.format.xml.XmlValidationResult
+
isValid() - Method in interface org.openpreservation.format.xml.XmlValidationResult
Is the XML document valid according to the supplied schema?
-
isValid() - Method in interface org.openpreservation.odf.validation.ValidationReport
+
isValid() - Method in interface org.openpreservation.odf.validation.ValidationReport
Determine if the OpenDocument is valid.
-
isValid() - Method in interface org.openpreservation.odf.validation.ValidationResult
+
isValid() - Method in interface org.openpreservation.odf.validation.ValidationResult
Determine if the OpenDocument is valid.
-
isValid() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
isValid() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-
isValidZip(Path) - Static method in class org.openpreservation.odf.Source
+
isValidZip(Path) - Static method in class org.openpreservation.odf.Source
Check if the supplied Path resolves to a valid zip archive instance.
-
isWarning() - Method in interface org.openpreservation.odf.validation.messages.Message
+
isWarning() - Method in interface org.openpreservation.odf.validation.messages.Message
-
Test whether the message has Message.Severity WARNING.
+
Test whether the message has Message.Severity WARNING.
-
isWellFormed() - Method in interface org.openpreservation.format.xml.ParseResult
+
isWellFormed() - Method in interface org.openpreservation.format.xml.ParseResult
Is the XML document well formed?
-
isWellFormedZip() - Method in interface org.openpreservation.odf.pkg.OdfPackage
+
isWellFormedZip() - Method in interface org.openpreservation.odf.pkg.OdfPackage
Is the item parsed a well formed ZipArchive.
-
isXml(File) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isXml(File) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isXml(InputStream) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isXml(InputStream) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isXml(String) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isXml(String) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isXml(Path) - Static method in class org.openpreservation.odf.fmt.OdfFormats
+
isXml(Path) - Static method in class org.openpreservation.odf.fmt.OdfFormats
 
-
isXml(Path) - Static method in class org.openpreservation.odf.Source
+
isXml(Path) - Static method in class org.openpreservation.odf.Source
Determines whether the supplied path is an XML document or not.
-
isZip(Path) - Static method in class org.openpreservation.odf.Source
+
isZip(Path) - Static method in class org.openpreservation.odf.Source
Uses the FormatSniffer to see if the supplied path resolves to a ZIP instance.
-

J

-
-
JSON - Enum constant in enum class org.openpreservation.odf.validation.ValidationReports.FormatOption
+ + + +

J

+
+
JSON - org.openpreservation.odf.validation.ValidationReports.FormatOption
 
-

L

-
-
label - Variable in enum class org.openpreservation.odf.validation.messages.Message.Severity
+ + + +

L

+
+
label - Variable in enum org.openpreservation.odf.validation.messages.Message.Severity
The label for the severity, lower case
-

M

-
-
Manifest - Interface in org.openpreservation.odf.pkg
+ + + +

M

+
+
Manifest - Interface in org.openpreservation.odf.pkg
 
-
MANIFEST - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
MANIFEST - org.openpreservation.odf.xml.OdfNamespaces
 
-
match(byte[]) - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
match(byte[]) - Static method in enum org.openpreservation.odf.fmt.Signatures
Match a signature at the start of the given byte array.
-
match(byte[], int) - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
match(byte[], int) - Static method in enum org.openpreservation.odf.fmt.Signatures
Match a signature at the given offset in the byte array.
-
match(byte[], int, Collection<Signatures>) - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
match(byte[], int, Collection<Signatures>) - Static method in enum org.openpreservation.odf.fmt.Signatures
Match a signature at the given offset in the byte array, from a given collection of signatures.
-
matchAll(byte[]) - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
matchAll(byte[]) - Static method in enum org.openpreservation.odf.fmt.Signatures
Find all matching signatures in the given byte array.
-
matchAll(byte[], int) - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
matchAll(byte[], int) - Static method in enum org.openpreservation.odf.fmt.Signatures
Find all matching signatures in the given byte array, starting at the given offset.
-
MATH - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
MATH - org.openpreservation.odf.xml.OdfNamespaces
 
-
MAX_LENGTH - Static variable in enum class org.openpreservation.odf.fmt.Signatures
+
MAX_LENGTH - Static variable in enum org.openpreservation.odf.fmt.Signatures
The length of the longest signature.
-
Message - Interface in org.openpreservation.odf.validation.messages
+
Message - Interface in org.openpreservation.odf.validation.messages
Defines behaviour of validation messages.
-
Message.Severity - Enum Class in org.openpreservation.odf.validation.messages
+
Message.Severity - Enum in org.openpreservation.odf.validation.messages
An enum set that defines the severity of a message.
-
MessageFactory - Interface in org.openpreservation.odf.validation.messages
+
MessageFactory - Interface in org.openpreservation.odf.validation.messages
Factory interface for Message creation
-
MessageHandler - Class in org.openpreservation.format.xml
+
MessageHandler - Class in org.openpreservation.format.xml
 
-
MessageHandler() - Constructor for class org.openpreservation.format.xml.MessageHandler
+
MessageHandler() - Constructor for class org.openpreservation.format.xml.MessageHandler
 
-
MessageHandler(String) - Constructor for class org.openpreservation.format.xml.MessageHandler
+
MessageHandler(String) - Constructor for class org.openpreservation.format.xml.MessageHandler
 
-
MessageLog - Interface in org.openpreservation.odf.validation.messages
+
MessageLog - Interface in org.openpreservation.odf.validation.messages
Interface for a log of Message objects.
-
messageLogInstance() - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
messageLogInstance() - Static method in enum org.openpreservation.odf.validation.messages.Messages
Get the new MessageLog instance
-
messageLogInstance(String, List<Message>) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
messageLogInstance(String, List<Message>) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a new MessageLog instance with the given values
-
messages - Variable in class org.openpreservation.format.xml.MessageHandler
+
messages - Variable in class org.openpreservation.format.xml.MessageHandler
 
-
Messages - Enum Class in org.openpreservation.odf.validation.messages
+
Messages - Enum in org.openpreservation.odf.validation.messages
Utility class that handles creation of Message type instances, etc.
-
META - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
META - org.openpreservation.odf.xml.OdfNamespaces
 
-
Metadata - Interface in org.openpreservation.odf.xml
+
Metadata - Interface in org.openpreservation.odf.xml
Interface for retrieving any useful metadata from an ODF package meta.xml file.
-
Metadata.UserDefinedField - Interface in org.openpreservation.odf.xml
+
Metadata.UserDefinedField - Interface in org.openpreservation.odf.xml
Interface that handles basic user defined field information.
-
metadataFrom(InputStream) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
+
metadataFrom(InputStream) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
Instantiates a Metadata object from an InputStream.
-
metadataOf(String, Map<String, String>, List<Metadata.UserDefinedField>) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
+
metadataOf(String, Map<String, String>, List<Metadata.UserDefinedField>) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
Instantiates a Metadata object from a version string, a Map of string values, and a List of UserDefinedFields.
-
mime - Variable in enum class org.openpreservation.odf.fmt.Formats
+
mime - Variable in enum org.openpreservation.odf.fmt.Formats
The String MIME type identifier
-
MIME_UKNOWN - Static variable in class org.openpreservation.odf.fmt.OdfFormats
+
MIME_UKNOWN - Static variable in class org.openpreservation.odf.fmt.OdfFormats
 
-
MIMETYPE - Static variable in class org.openpreservation.odf.fmt.OdfFormats
+
MIMETYPE - Static variable in class org.openpreservation.odf.fmt.OdfFormats
 
-
MIMETYPE - Static variable in class org.openpreservation.odf.pkg.OdfPackages
+
MIMETYPE - Static variable in class org.openpreservation.odf.pkg.OdfPackages
The ODF specified name of the mimetype zip entry.
-

N

-
-
NAME_CONTENT - Static variable in class org.openpreservation.odf.pkg.Constants
+ + + +

N

+
+
NAME_CONTENT - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_MANIFEST - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_MANIFEST - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_MANIFEST_RDF - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_MANIFEST_RDF - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_META - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_META - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_META_INF - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_META_INF - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_META_INF - Static variable in class org.openpreservation.odf.pkg.OdfPackages
+
NAME_META_INF - Static variable in class org.openpreservation.odf.pkg.OdfPackages
The ODF specified name of the package META-INF directory.
-
NAME_SETTINGS - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_SETTINGS - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_STYLES - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_STYLES - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
NAME_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.Constants
+
NAME_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
Namespace - Interface in org.openpreservation.format.xml
+
Namespace - Interface in org.openpreservation.format.xml
An interface defining the properties of XML namespaces.
-
newline() - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
newline() - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
NO_ID - Static variable in enum class org.openpreservation.odf.validation.messages.Messages
+
NO_ID - Static variable in enum org.openpreservation.odf.validation.messages.Messages
 
-
NOMATCH - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
NOMATCH - org.openpreservation.odf.fmt.Signatures
No match found.
-
NONE - Enum constant in enum class org.openpreservation.format.xml.Encodings
+
NONE - org.openpreservation.format.xml.Encodings
Empty Byte String to match no encoding
-
NOT_EMPTY - Static variable in class org.openpreservation.utils.Checks
+
NOT_EMPTY - Static variable in class org.openpreservation.utils.Checks
 
-
NOT_NULL - Static variable in class org.openpreservation.utils.Checks
+
NOT_NULL - Static variable in class org.openpreservation.utils.Checks
 
-
NUMBER - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
NUMBER - org.openpreservation.odf.xml.OdfNamespaces
 
-

O

-
-
ODB - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+ + + +

O

+
+
ODB - org.openpreservation.odf.fmt.Formats
The ODF Database format.
-
ODB - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODB - org.openpreservation.odf.fmt.Signatures
ODF Database signature.
-
ODC - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODC - org.openpreservation.odf.fmt.Formats
The ODF Chart format.
-
ODC - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODC - org.openpreservation.odf.fmt.Signatures
ODF Chart signature.
-
ODF - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODF - org.openpreservation.odf.fmt.Formats
The ODF Formula format.
-
ODF - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODF - org.openpreservation.odf.fmt.Signatures
ODF Formula signature.
-
ODF - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
ODF - org.openpreservation.odf.xml.OdfNamespaces
 
-
ODF_10 - Enum constant in enum class org.openpreservation.odf.xml.Version
+
ODF_10 - org.openpreservation.odf.xml.Version
ODF version 1.0.
-
ODF_11 - Enum constant in enum class org.openpreservation.odf.xml.Version
+
ODF_11 - org.openpreservation.odf.xml.Version
ODF version 1.1.
-
ODF_12 - Enum constant in enum class org.openpreservation.odf.xml.Version
+
ODF_12 - org.openpreservation.odf.xml.Version
ODF version 1.2.
-
ODF_13 - Enum constant in enum class org.openpreservation.odf.xml.Version
+
ODF_13 - org.openpreservation.odf.xml.Version
ODF version 1.3.
-
ODF_14 - Enum constant in enum class org.openpreservation.odf.xml.Version
+
ODF_14 - org.openpreservation.odf.xml.Version
ODF version 1.4.
-
ODF_MIME - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODF_MIME - org.openpreservation.odf.fmt.Signatures
Base match of ODF `mimetype` file.
-
ODF_NAMESPACES_1_1 - Static variable in enum class org.openpreservation.odf.xml.OdfNamespaces
+
ODF_NAMESPACES_1_1 - Static variable in enum org.openpreservation.odf.xml.OdfNamespaces
 
-
ODF_NAMESPACES_1_2 - Static variable in enum class org.openpreservation.odf.xml.OdfNamespaces
+
ODF_NAMESPACES_1_2 - Static variable in enum org.openpreservation.odf.xml.OdfNamespaces
 
-
ODF_XML - Static variable in class org.openpreservation.odf.pkg.Constants
+
ODF_XML - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
odf1() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf1() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf10() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf10() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf2() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf2() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf3() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf3() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf4() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf4() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf5() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf5() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf6() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf6() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf7() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf7() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf8() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf8() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
odf9() - Static method in class org.openpreservation.odf.validation.rules.Rules
+
odf9() - Static method in class org.openpreservation.odf.validation.rules.Rules
 
-
OdfDocument - Interface in org.openpreservation.odf.document
+
OdfDocument - Interface in org.openpreservation.odf.document
 
-
odfDocumentFrom(InputStream) - Static method in class org.openpreservation.odf.document.Documents
+
odfDocumentFrom(InputStream) - Static method in class org.openpreservation.odf.document.Documents
 
-
odfDocumentFrom(Path) - Static method in class org.openpreservation.odf.document.Documents
+
odfDocumentFrom(Path) - Static method in class org.openpreservation.odf.document.Documents
 
-
odfDocumentOf(ParseResult) - Static method in class org.openpreservation.odf.document.Documents
+
odfDocumentOf(ParseResult) - Static method in class org.openpreservation.odf.document.Documents
 
-
odfDocumentOf(ParseResult, Metadata) - Static method in class org.openpreservation.odf.document.Documents
+
odfDocumentOf(ParseResult, Metadata) - Static method in class org.openpreservation.odf.document.Documents
 
-
odfDocumentOf(OdfXmlDocument, Metadata) - Static method in class org.openpreservation.odf.document.Documents
+
odfDocumentOf(OdfXmlDocument, Metadata) - Static method in class org.openpreservation.odf.document.Documents
 
-
OdfFormats - Class in org.openpreservation.odf.fmt
+
OdfFormats - Class in org.openpreservation.odf.fmt
 
-
OdfNamespaces - Enum Class in org.openpreservation.odf.xml
+
OdfNamespaces - Enum in org.openpreservation.odf.xml
Enum representing the XML namespaces used by ODF (OpenDocument Format).
-
OdfPackage - Interface in org.openpreservation.odf.pkg
+
OdfPackage - Interface in org.openpreservation.odf.pkg
An interface defining the behaviour of ODF packages.
-
OdfPackageDocument - Interface in org.openpreservation.odf.pkg
+
OdfPackageDocument - Interface in org.openpreservation.odf.pkg
 
-
OdfPackages - Class in org.openpreservation.odf.pkg
+
OdfPackages - Class in org.openpreservation.odf.pkg
A static utility class for general ODF package parsing.
-
OdfSchemaFactory - Class in org.openpreservation.odf.xml
+
OdfSchemaFactory - Class in org.openpreservation.odf.xml
 
-
OdfSchemaFactory() - Constructor for class org.openpreservation.odf.xml.OdfSchemaFactory
+
OdfSchemaFactory() - Constructor for class org.openpreservation.odf.xml.OdfSchemaFactory
 
-
OdfValidator - Interface in org.openpreservation.odf.validation
+
OdfValidator - Interface in org.openpreservation.odf.validation
 
-
OdfValidators - Class in org.openpreservation.odf.validation
+
OdfValidators - Class in org.openpreservation.odf.validation
 
-
OdfXmlDocument - Interface in org.openpreservation.odf.xml
+
OdfXmlDocument - Interface in org.openpreservation.odf.xml
 
-
odfXmlDocumentOf(ParseResult) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
+
odfXmlDocumentOf(ParseResult) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
Instantiates an OdfXmlDocument from an XML ParseResult
-
OdfXmlDocuments - Class in org.openpreservation.odf.xml
+
OdfXmlDocuments - Class in org.openpreservation.odf.xml
+
 
+
OdfXmlValidator - Class in org.openpreservation.odf.validation
 
-
ODG - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODG - org.openpreservation.odf.fmt.Formats
The ODF Graphics format.
-
ODG - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODG - org.openpreservation.odf.fmt.Signatures
ODF Graphics signature.
-
ODI - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODI - org.openpreservation.odf.fmt.Formats
The ODF Image format.
-
ODI - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODI - org.openpreservation.odf.fmt.Signatures
ODF Image signature.
-
ODM - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODM - org.openpreservation.odf.fmt.Formats
The ODF Master Document format.
-
ODM - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODM - org.openpreservation.odf.fmt.Signatures
ODF Master Document signature.
-
ODP - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODP - org.openpreservation.odf.fmt.Formats
The ODF Presentation format.
-
ODP - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODP - org.openpreservation.odf.fmt.Signatures
ODF Presentation signature.
-
ODS - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODS - org.openpreservation.odf.fmt.Formats
The ODF Spreadsheet format.
-
ODS - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODS - org.openpreservation.odf.fmt.Signatures
ODF Spreadsheet signature.
-
ODT - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
ODT - org.openpreservation.odf.fmt.Formats
The ODF Text Document format.
-
ODT - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ODT - org.openpreservation.odf.fmt.Signatures
ODF Text signature.
-
of(ParseResult, boolean, List<Message>) - Static method in class org.openpreservation.format.xml.XmlValidationResults
+
of(ParseResult, boolean, List<Message>) - Static method in class org.openpreservation.format.xml.XmlValidationResults
Creates a new XmlValidationResult object from the supplied values.
-
of(Message, String) - Static method in class org.openpreservation.odf.validation.CheckImpl
+
of(Message, String) - Static method in class org.openpreservation.odf.validation.CheckImpl
 
-
OFFICE - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
OFFICE - org.openpreservation.odf.xml.OdfNamespaces
 
-
offset - Variable in enum class org.openpreservation.odf.fmt.Signatures
+
offset - Variable in enum org.openpreservation.odf.fmt.Signatures
 
-
OpenDocument - Interface in org.openpreservation.odf.document
+
OpenDocument - Interface in org.openpreservation.odf.document
 
-
openDocumentFrom(Path) - Static method in class org.openpreservation.odf.document.Documents
+
openDocumentFrom(Path) - Static method in class org.openpreservation.odf.document.Documents
 
-
openDocumentOf(Path, OdfDocument) - Static method in class org.openpreservation.odf.document.Documents
+
openDocumentOf(Path, OdfDocument) - Static method in class org.openpreservation.odf.document.Documents
 
-
openDocumentOf(Path, OdfPackage) - Static method in class org.openpreservation.odf.document.Documents
+
openDocumentOf(Path, OdfPackage) - Static method in class org.openpreservation.odf.document.Documents
 
org.openpreservation.format.xml - package org.openpreservation.format.xml
 
@@ -1710,609 +1790,680 @@

O

 
org.openpreservation.utils - package org.openpreservation.utils
 
-
OTC - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTC - org.openpreservation.odf.fmt.Formats
The ODF Template Chart format.
-
OTC - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTC - org.openpreservation.odf.fmt.Signatures
ODF Chart Template signature.
-
OTF - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTF - org.openpreservation.odf.fmt.Formats
The ODF Template Formula format.
-
OTF - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTF - org.openpreservation.odf.fmt.Signatures
ODF Formula Template signature.
-
OTG - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTG - org.openpreservation.odf.fmt.Formats
The ODF Template Graphics format.
-
OTG - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTG - org.openpreservation.odf.fmt.Signatures
ODF Graphics Template signature.
-
OTH - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTH - org.openpreservation.odf.fmt.Formats
The ODF Template HTML format.
-
OTH - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTH - org.openpreservation.odf.fmt.Signatures
ODF Text Web signature.
-
OTI - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTI - org.openpreservation.odf.fmt.Formats
The ODF Template Image format.
-
OTI - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTI - org.openpreservation.odf.fmt.Signatures
ODF Image Template signature.
-
OTM - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTM - org.openpreservation.odf.fmt.Formats
The ODF Template Master Document format.
-
OTM - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTM - org.openpreservation.odf.fmt.Signatures
ODF Master Document Template signature.
-
OTP - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTP - org.openpreservation.odf.fmt.Formats
The ODF Template Presentation format.
-
OTP - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTP - org.openpreservation.odf.fmt.Signatures
ODF Presentation Template signature.
-
OTS - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTS - org.openpreservation.odf.fmt.Formats
The ODF Template Spreadsheet format.
-
OTS - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTS - org.openpreservation.odf.fmt.Signatures
ODF Spreadsheet Template signature.
-
OTT - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
OTT - org.openpreservation.odf.fmt.Formats
The ODF Template Text Document format.
-
OTT - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
OTT - org.openpreservation.odf.fmt.Signatures
ODF Text Template signature.
-
outputDebugInfo() - Method in class org.openpreservation.odf.apps.DebugInfo
+
outputDebugInfo() - Method in class org.openpreservation.odf.apps.DebugInfo
Output debug information to the console if debugFlag is set.
-

P

-
-
PACKAGE - Enum constant in enum class org.openpreservation.odf.document.FileType
+ + + +

P

+
+
PACKAGE - org.openpreservation.odf.document.FileType
OpenDocument package files.
-
PackageParser - Interface in org.openpreservation.odf.pkg
+
PackageParser - Interface in org.openpreservation.odf.pkg
An interface defining the behaviour of ODF package parsers.
-
PackageParser.ParseException - Exception in org.openpreservation.odf.pkg
+
PackageParser.ParseException - Exception in org.openpreservation.odf.pkg
 
-
Parameter - Interface in org.openpreservation.odf.validation.messages
+
Parameter - Interface in org.openpreservation.odf.validation.messages
 
-
Parameter.ParameterList - Interface in org.openpreservation.odf.validation.messages
+
Parameter.ParameterList - Interface in org.openpreservation.odf.validation.messages
 
-
parameterListInstance() - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
parameterListInstance() - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a new empty ParameterList instance
-
parameterOf(String, String) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
parameterOf(String, String) - Static method in enum org.openpreservation.odf.validation.messages.Messages
Create a new Parameter instance with the given name and value
-
parse(InputStream) - Method in interface org.openpreservation.format.xml.XmlParser
+
parse(InputStream) - Method in interface org.openpreservation.format.xml.XmlParser
 
-
parse(Path) - Method in interface org.openpreservation.format.xml.XmlParser
+
parse(Path) - Method in interface org.openpreservation.format.xml.XmlParser
 
-
ParseException(String) - Constructor for exception org.openpreservation.odf.pkg.PackageParser.ParseException
+
ParseException(String) - Constructor for exception org.openpreservation.odf.pkg.PackageParser.ParseException
 
-
ParseException(String, Throwable) - Constructor for exception org.openpreservation.odf.pkg.PackageParser.ParseException
+
ParseException(String, Throwable) - Constructor for exception org.openpreservation.odf.pkg.PackageParser.ParseException
 
-
ParseException(Map<String, String>) - Constructor for exception org.openpreservation.odf.pkg.PackageParser.ParseException
+
ParseException(Map<String, String>) - Constructor for exception org.openpreservation.odf.pkg.PackageParser.ParseException
 
-
parsePackage(InputStream, String) - Method in interface org.openpreservation.odf.pkg.PackageParser
+
parsePackage(InputStream, String) - Method in interface org.openpreservation.odf.pkg.PackageParser
Parse an InputStream and return an OdfPackage instance.
-
parsePackage(Path) - Method in interface org.openpreservation.odf.pkg.PackageParser
+
parsePackage(Path) - Method in interface org.openpreservation.odf.pkg.PackageParser
Resove and parse a system Path and return an OdfPackage instance.
-
ParseResult - Interface in org.openpreservation.format.xml
+
ParseResult - Interface in org.openpreservation.format.xml
An interface defining the properties of XML document parsing results.
-
parseResultOf(boolean, Namespace, List<Namespace>, List<Namespace>, String, String, List<Attribute>, List<Message>) - Static method in class org.openpreservation.format.xml.XmlValidationResults
+
parseResultOf(boolean, Namespace, List<Namespace>, List<Namespace>, String, String, List<Attribute>, List<Message>) - Static method in class org.openpreservation.format.xml.XmlValidationResults
Create a new ParseResult object from the supplied values.
-
ParsingHandler - Class in org.openpreservation.format.xml
+
ParsingHandler - Class in org.openpreservation.format.xml
 
-
ParsingHandler() - Constructor for class org.openpreservation.format.xml.ParsingHandler
+
ParsingHandler() - Constructor for class org.openpreservation.format.xml.ParsingHandler
 
-
path - Variable in class org.openpreservation.odf.Source
+
path - Variable in class org.openpreservation.odf.Source
 
-
PATH_MANIFEST - Static variable in class org.openpreservation.odf.pkg.Constants
+
PATH_MANIFEST - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
PATH_MANIFEST - Static variable in class org.openpreservation.odf.pkg.OdfPackages
+
PATH_MANIFEST - Static variable in class org.openpreservation.odf.pkg.OdfPackages
The ODF specified path to the package manifest.
-
PATH_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.Constants
+
PATH_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
PATH_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.OdfPackages
+
PATH_THUMBNAIL - Static variable in class org.openpreservation.odf.pkg.OdfPackages
The ODF specified path to a PNG thumbnail file.
-
PKG - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
PKG - org.openpreservation.odf.xml.OdfNamespaces
 
-
PRESENTATION - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
PRESENTATION - org.openpreservation.odf.xml.DocumentType
Presentation document type, e.g.
-
PRESENTATION - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
PRESENTATION - org.openpreservation.odf.xml.OdfNamespaces
 
-
process(InputStream) - Method in interface org.openpreservation.format.zip.ZipProcessor
+
process(InputStream) - Method in interface org.openpreservation.format.zip.ZipProcessor
Process the InputStream and return a ZipArchive containing parsed from the stream.
-
process(ZipEntry, InputStream) - Method in interface org.openpreservation.format.zip.ZipEntryProcessor
+
process(ZipEntry, InputStream) - Method in interface org.openpreservation.format.zip.ZipEntryProcessor
Process the ZipEntry and it's InputStream.
-
profile(Path, Profile) - Method in interface org.openpreservation.odf.validation.OdfValidator
+
profile(Path, Profile) - Method in interface org.openpreservation.odf.validation.OdfValidator
Profile check a document using a specific profile.
-
Profile - Interface in org.openpreservation.odf.validation
+
Profile - Interface in org.openpreservation.odf.validation
 
-

R

-
-
reportFromValues(String, OpenDocument, List<ValidationResult>) - Static method in class org.openpreservation.odf.validation.ValidationReports
+ + + +

R

+
+
reportFromValues(String, OpenDocument, List<ValidationResult>) - Static method in class org.openpreservation.odf.validation.ValidationReports
Create a new ValidationReport instance.
-
resultOf(String, MessageLog) - Static method in class org.openpreservation.odf.validation.OdfValidators
+
resultOf(String, MessageLog) - Static method in class org.openpreservation.odf.validation.OdfValidators
Create a mimimal validation report.
-
Rule - Interface in org.openpreservation.odf.validation
+
Rule - Interface in org.openpreservation.odf.validation
 
-
Rules - Class in org.openpreservation.odf.validation.rules
+
Rules - Class in org.openpreservation.odf.validation.rules
 
-

S

-
-
SCRIPT - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+ + + +

S

+
+
SCRIPT - org.openpreservation.odf.xml.OdfNamespaces
 
-
SIG_TERM - Static variable in class org.openpreservation.odf.pkg.Constants
+
SIG_TERM - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
Signatures - Enum Class in org.openpreservation.odf.fmt
+
Signatures - Enum in org.openpreservation.odf.fmt
 
-
size() - Method in interface org.openpreservation.format.zip.ZipArchive
+
size() - Method in interface org.openpreservation.format.zip.ZipArchive
Get the count of entries in the archive
-
size() - Method in class org.openpreservation.format.zip.ZipFileProcessor
+
size() - Method in class org.openpreservation.format.zip.ZipFileProcessor
 
-
size() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
+
size() - Method in interface org.openpreservation.odf.validation.messages.MessageLog
Get the number of messages in the log.
-
size() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
+
size() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
 
-
SMIL - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
SMIL - org.openpreservation.odf.xml.OdfNamespaces
 
-
sniff(BufferedInputStream) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(BufferedInputStream) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(BufferedInputStream, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(BufferedInputStream, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(File) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(File) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(File, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(File, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(String) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(String) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(String, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(String, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(Path) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(Path) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniff(Path, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniff(Path, int) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniffEncoding(File) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniffEncoding(File) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniffEncoding(InputStream) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniffEncoding(InputStream) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniffEncoding(String) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniffEncoding(String) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
sniffEncoding(Path) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
+
sniffEncoding(Path) - Static method in class org.openpreservation.odf.fmt.FormatSniffer
 
-
Source - Class in org.openpreservation.odf
+
Source - Class in org.openpreservation.odf
Represents a source file or stream to be processed.
-
SPREADSHEET - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
SPREADSHEET - org.openpreservation.odf.xml.DocumentType
Spreadsheet document type, e.g.
-
startElement(String, String, String, Attributes) - Method in class org.openpreservation.format.xml.ParsingHandler
+
startElement(String, String, String, Attributes) - Method in class org.openpreservation.format.xml.ParsingHandler
 
-
startElement(String, String, String, Attributes) - Method in class org.openpreservation.odf.xml.ExtendedConformanceFilter
+
startElement(String, String, String, Attributes) - Method in class org.openpreservation.odf.xml.ExtendedConformanceFilter
 
-
startPrefixMapping(String, String) - Method in class org.openpreservation.format.xml.ParsingHandler
+
startPrefixMapping(String, String) - Method in class org.openpreservation.format.xml.ParsingHandler
 
-
STYLE - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
STYLE - org.openpreservation.odf.xml.OdfNamespaces
 
-
supportedVersions() - Static method in enum class org.openpreservation.odf.xml.Version
+
supportedVersions() - Static method in enum org.openpreservation.odf.xml.Version
 
-
SVG - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
SVG - org.openpreservation.odf.xml.OdfNamespaces
 
-

T

-
-
TABLE - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+ + + +

T

+
+
TABLE - org.openpreservation.odf.xml.OdfNamespaces
 
-
TAG_MANIFEST - Static variable in class org.openpreservation.odf.pkg.Constants
+
TAG_MANIFEST - Static variable in class org.openpreservation.odf.pkg.Constants
 
-
TEXT - Enum constant in enum class org.openpreservation.odf.validation.ValidationReports.FormatOption
+
TEXT - org.openpreservation.odf.validation.ValidationReports.FormatOption
 
-
TEXT - Enum constant in enum class org.openpreservation.odf.xml.DocumentType
+
TEXT - org.openpreservation.odf.xml.DocumentType
Text document type, e.g.
-
TEXT - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
TEXT - org.openpreservation.odf.xml.OdfNamespaces
 
-
toArray() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
+
toArray() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
 
-
toList() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
+
toList() - Method in interface org.openpreservation.odf.validation.messages.Parameter.ParameterList
 
-
toString() - Method in class org.openpreservation.format.zip.ZipEntryImpl
+
toString() - Method in class org.openpreservation.format.zip.ZipEntryImpl
 
-
toString() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
+
toString() - Method in class org.openpreservation.odf.validation.ValidationResultImpl
 
-

U

-
-
UNKNOWN - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+ + + +

U

+
+
UNKNOWN - org.openpreservation.odf.fmt.Formats
Unknown format.
-
UNKNOWN - Enum constant in enum class org.openpreservation.odf.xml.Version
+
UNKNOWN - org.openpreservation.odf.xml.Version
Unknown version.
-
UTF_16_BE - Enum constant in enum class org.openpreservation.format.xml.Encodings
+
UTF_16_BE - org.openpreservation.format.xml.Encodings
UTF-16 Big Endian Byte Order Mark
-
UTF_16_LE - Enum constant in enum class org.openpreservation.format.xml.Encodings
+
UTF_16_LE - org.openpreservation.format.xml.Encodings
UTF-16 Little Endian Byte Order Mark
-
UTF_32_BE - Enum constant in enum class org.openpreservation.format.xml.Encodings
+
UTF_32_BE - org.openpreservation.format.xml.Encodings
UTF-32 Big Endian Byte Order Mark
-
UTF_32_LE - Enum constant in enum class org.openpreservation.format.xml.Encodings
+
UTF_32_LE - org.openpreservation.format.xml.Encodings
UTF-32 Little Endian Byte Order Mark
-
UTF_8 - Enum constant in enum class org.openpreservation.format.xml.Encodings
+
UTF_8 - org.openpreservation.format.xml.Encodings
UTF-8 Byte Order Mark
-
Utils - Class in org.openpreservation.odf.fmt
+
Utils - Class in org.openpreservation.odf.fmt
 
-

V

-
-
validate(Path) - Method in interface org.openpreservation.odf.validation.OdfValidator
+ + + +

V

+
+
validate(Path) - Method in interface org.openpreservation.odf.validation.OdfValidator
Validate an ODF document from a path.
-
validate(Path, Formats) - Method in interface org.openpreservation.odf.validation.OdfValidator
+
validate(Path, ParseResult) - Method in class org.openpreservation.odf.validation.OdfXmlValidator
+
 
+
validate(Path, Formats) - Method in interface org.openpreservation.odf.validation.OdfValidator
Validate a path, only files of a specific ODF format are allowed.
-
validate(ParseResult, InputStream, Schema) - Method in class org.openpreservation.format.xml.XmlValidator
+
validate(ParseResult, InputStream, Schema) - Method in class org.openpreservation.format.xml.XmlValidator
Validate the supplied InputStream against the supplied schema.
-
validate(ParseResult, InputStream, Schema, XMLFilter) - Method in class org.openpreservation.format.xml.XmlValidator
+
validate(ParseResult, InputStream, Schema, XMLFilter) - Method in class org.openpreservation.format.xml.XmlValidator
Validate the supplied InputStream against the supplied schema.
-
validate(OpenDocument) - Method in interface org.openpreservation.odf.validation.OdfValidator
+
validate(OpenDocument) - Method in interface org.openpreservation.odf.validation.OdfValidator
Validate an OpenDocument.
-
validatePackage(OdfPackage) - Method in interface org.openpreservation.odf.validation.ValidatingParser
+
validatePackage(OdfPackage) - Method in interface org.openpreservation.odf.validation.ValidatingParser
Validates the given ODF package.
-
ValidatingParser - Interface in org.openpreservation.odf.validation
+
ValidatingParser - Interface in org.openpreservation.odf.validation
 
-
ValidationReport - Interface in org.openpreservation.odf.validation
+
ValidationReport - Interface in org.openpreservation.odf.validation
 
-
ValidationReports - Class in org.openpreservation.odf.validation
+
ValidationReports - Class in org.openpreservation.odf.validation
 
-
ValidationReports.FormatOption - Enum Class in org.openpreservation.odf.validation
+
ValidationReports.FormatOption - Enum in org.openpreservation.odf.validation
Specifies the output format for validation reports.
-
ValidationResult - Interface in org.openpreservation.odf.validation
+
ValidationResult - Interface in org.openpreservation.odf.validation
 
-
ValidationResultImpl - Class in org.openpreservation.odf.validation
+
ValidationResultImpl - Class in org.openpreservation.odf.validation
 
-
valueOf(String) - Static method in enum class org.openpreservation.format.xml.Encodings
+
valueOf(String) - Static method in enum org.openpreservation.format.xml.Encodings
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
valueOf(String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.document.FileType
+
valueOf(String) - Static method in enum org.openpreservation.odf.document.FileType
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.fmt.Formats
+
valueOf(String) - Static method in enum org.openpreservation.odf.fmt.Formats
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
valueOf(String) - Static method in enum org.openpreservation.odf.fmt.Signatures
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.validation.messages.Message.Severity
+
valueOf(String) - Static method in enum org.openpreservation.odf.validation.messages.Message.Severity
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
valueOf(String) - Static method in enum org.openpreservation.odf.validation.messages.Messages
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.validation.ValidationReports.FormatOption
+
valueOf(String) - Static method in enum org.openpreservation.odf.validation.ValidationReports.FormatOption
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.xml.DocumentType
+
valueOf(String) - Static method in enum org.openpreservation.odf.xml.DocumentType
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
valueOf(String) - Static method in enum org.openpreservation.odf.xml.OdfNamespaces
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
valueOf(String) - Static method in enum class org.openpreservation.odf.xml.Version
+
valueOf(String) - Static method in enum org.openpreservation.odf.xml.Version
-
Returns the enum constant of this class with the specified name.
+
Returns the enum constant of this type with the specified name.
-
values() - Static method in enum class org.openpreservation.format.xml.Encodings
+
values() - Static method in enum org.openpreservation.format.xml.Encodings
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+
values() - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.document.FileType
+
values() - Static method in enum org.openpreservation.odf.document.FileType
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.fmt.Formats
+
values() - Static method in enum org.openpreservation.odf.fmt.Formats
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.fmt.Signatures
+
values() - Static method in enum org.openpreservation.odf.fmt.Signatures
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.validation.messages.Message.Severity
+
values() - Static method in enum org.openpreservation.odf.validation.messages.Message.Severity
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.validation.messages.Messages
+
values() - Static method in enum org.openpreservation.odf.validation.messages.Messages
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.validation.ValidationReports.FormatOption
+
values() - Static method in enum org.openpreservation.odf.validation.ValidationReports.FormatOption
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.xml.DocumentType
+
values() - Static method in enum org.openpreservation.odf.xml.DocumentType
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.xml.OdfNamespaces
+
values() - Static method in enum org.openpreservation.odf.xml.OdfNamespaces
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
values() - Static method in enum class org.openpreservation.odf.xml.Version
+
values() - Static method in enum org.openpreservation.odf.xml.Version
-
Returns an array containing the constants of this enum class, in +
Returns an array containing the constants of this enum type, in the order they are declared.
-
version - Variable in enum class org.openpreservation.odf.xml.Version
+
version - Variable in enum org.openpreservation.odf.xml.Version
The version string.
-
Version - Enum Class in org.openpreservation.odf.xml
+
Version - Enum in org.openpreservation.odf.xml
The Version enum represents the different versions of the ODF specification.
-

W

-
-
warn(String) - Static method in enum class org.openpreservation.odf.apps.ConsoleFormatter
+ + + +

W

+
+
warn(String) - Static method in enum org.openpreservation.odf.apps.ConsoleFormatter
 
-
warning(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
+
warning(SAXParseException) - Method in class org.openpreservation.format.xml.MessageHandler
 
-
WARNING - Enum constant in enum class org.openpreservation.odf.validation.messages.Message.Severity
+
WARNING - org.openpreservation.odf.validation.messages.Message.Severity
The message is a warning, equivalent to SHOULD
-

X

-
-
XFORMS - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+ + + +

X

+
+
XFORMS - org.openpreservation.odf.xml.OdfNamespaces
 
-
XHTML - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
XHTML - org.openpreservation.odf.xml.OdfNamespaces
 
-
XLINK - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
XLINK - org.openpreservation.odf.xml.OdfNamespaces
 
-
XML - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+
XML - org.openpreservation.odf.fmt.Formats
The XML format, used for ODF documents and metadata.
-
XML - Enum constant in enum class org.openpreservation.odf.validation.ValidationReports.FormatOption
+
XML - org.openpreservation.odf.validation.ValidationReports.FormatOption
 
-
XML_UTF_16_BE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
XML_UTF_16_BE - org.openpreservation.odf.fmt.Signatures
XML UTF-16 Big Endian signature.
-
XML_UTF_16_LE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
XML_UTF_16_LE - org.openpreservation.odf.fmt.Signatures
XML UTF-16 Little Endian signature.
-
XML_UTF_32_BE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
XML_UTF_32_BE - org.openpreservation.odf.fmt.Signatures
XML UTF-32 Big Endian signature.
-
XML_UTF_32_LE - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
XML_UTF_32_LE - org.openpreservation.odf.fmt.Signatures
XML UTF-32 Little Endian signature.
-
XML_UTF_8 - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
XML_UTF_8 - org.openpreservation.odf.fmt.Signatures
XML UTF-8 signature.
-
xmlDocumentFrom(InputStream) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
+
xmlDocumentFrom(InputStream) - Static method in class org.openpreservation.odf.xml.OdfXmlDocuments
Instatiates an OdfXmlDocument from an InputStream.
-
XMLNS - Enum constant in enum class org.openpreservation.odf.xml.OdfNamespaces
+
XMLNS - org.openpreservation.odf.xml.OdfNamespaces
 
-
XmlParser - Interface in org.openpreservation.format.xml
+
XmlParser - Interface in org.openpreservation.format.xml
 
-
XmlParsers - Class in org.openpreservation.format.xml
+
XmlParsers - Class in org.openpreservation.format.xml
 
-
XmlValidationResult - Interface in org.openpreservation.format.xml
+
XmlValidationResult - Interface in org.openpreservation.format.xml
Simple extension of ParseResult to indicate whether the result of XML validation is valid or not.
-
XmlValidationResults - Class in org.openpreservation.format.xml
+
XmlValidationResults - Class in org.openpreservation.format.xml
A factory for creating ParseResult and XmlValidationResult objects.
-
XmlValidator - Class in org.openpreservation.format.xml
+
XmlValidator - Class in org.openpreservation.format.xml
Simple class to wrap XML schema validation.
-
XmlValidator() - Constructor for class org.openpreservation.format.xml.XmlValidator
+
XmlValidator() - Constructor for class org.openpreservation.format.xml.XmlValidator
 
-

Z

-
-
ZIP - Enum constant in enum class org.openpreservation.odf.fmt.Formats
+ + + +

Z

+
+
ZIP - org.openpreservation.odf.fmt.Formats
The ZIP format, used for ODF packages.
-
ZIP - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ZIP - org.openpreservation.odf.fmt.Signatures
ZIP file signature, all ODF packages are ZIP files.
-
ZIP_EMPTY - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ZIP_EMPTY - org.openpreservation.odf.fmt.Signatures
Signature of an empty zip.
-
ZIP_SPANNED - Enum constant in enum class org.openpreservation.odf.fmt.Signatures
+
ZIP_SPANNED - org.openpreservation.odf.fmt.Signatures
Signature of a spanned, i.e.
-
ZipArchive - Interface in org.openpreservation.format.zip
+
ZipArchive - Interface in org.openpreservation.format.zip
An interface for accessing the contents of a Zip archive.
-
ZipArchiveCache - Interface in org.openpreservation.format.zip
+
ZipArchiveCache - Interface in org.openpreservation.format.zip
An extension of ZipArchive that caches the contents of the archive and provides access to the InputStreams.
-
zipArchiveCacheInstance(File) - Static method in class org.openpreservation.format.zip.Zips
+
zipArchiveCacheInstance(File) - Static method in class org.openpreservation.format.zip.Zips
Create a ZipArchiveCache instance that caches the contents of the archive and provides access to the InputStreams.
-
zipArchiveCacheInstance(Path) - Static method in class org.openpreservation.format.zip.Zips
+
zipArchiveCacheInstance(Path) - Static method in class org.openpreservation.format.zip.Zips
Create a ZipArchiveCache instance that caches the contents of the archive and provides access to the Paths.
-
ZipEntry - Interface in org.openpreservation.format.zip
+
ZipEntry - Interface in org.openpreservation.format.zip
An interface for recording and accessing the properties of an entry from a ZipArchive.
-
ZipEntryImpl - Class in org.openpreservation.format.zip
+
ZipEntryImpl - Class in org.openpreservation.format.zip
 
-
zipEntryInstance(String, int, int, int, int, boolean, byte[]) - Static method in class org.openpreservation.format.zip.Zips
+
zipEntryInstance(String, int, int, int, int, boolean, byte[]) - Static method in class org.openpreservation.format.zip.Zips
 
-
ZipEntryProcessor - Interface in org.openpreservation.format.zip
+
ZipEntryProcessor - Interface in org.openpreservation.format.zip
-
Interface for processing ZipEntry objects from a ZipArchive
+
Interface for processing ZipEntry objects from a ZipArchive
-
ZipFileProcessor - Class in org.openpreservation.format.zip
+
ZipFileProcessor - Class in org.openpreservation.format.zip
An implementation of ZipArchiveCache that caches the contents of the archive and provides access to the InputStreams.
-
ZipProcessor - Interface in org.openpreservation.format.zip
+
ZipProcessor - Interface in org.openpreservation.format.zip
-
Interface for a processor that processes an InputStream and a factory +
Interface for a processor that processes an InputStream and a factory for the processor.
-
ZipProcessor.Factory - Interface in org.openpreservation.format.zip
+
ZipProcessor.Factory - Interface in org.openpreservation.format.zip
Factory for creating a ZipProcessor.
-
Zips - Class in org.openpreservation.format.zip
+
Zips - Class in org.openpreservation.format.zip
Utility class for working with ZipArchives.
-A B C D E F G H I J L M N O P R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
+A B C D E F G H I J L M N O P R S T U V W X Z 
All Classes All Packages
+ + +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/index.html b/docs/site/apidocs/index.html index 23b6f4b7..a4249958 100644 --- a/docs/site/apidocs/index.html +++ b/docs/site/apidocs/index.html @@ -1,95 +1,212 @@ + - -Overview (ODF spreadsheet validator. 0.18.5 API) - + +Overview (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -
-

ODF spreadsheet validator. 0.18.5 API

-
-
+ +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/jquery-ui.overrides.css b/docs/site/apidocs/jquery-ui.overrides.css index f89acb63..facf852c 100644 --- a/docs/site/apidocs/jquery-ui.overrides.css +++ b/docs/site/apidocs/jquery-ui.overrides.css @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2020, 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 @@ -31,4 +31,5 @@ a.ui-button:active, .ui-button.ui-state-active:hover { /* Overrides the color of selection used in jQuery UI */ background: #F8981D; + border: 1px solid #F8981D; } diff --git a/docs/site/apidocs/jquery/external/jquery/jquery.js b/docs/site/apidocs/jquery/external/jquery/jquery.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/docs/site/apidocs/jquery/external/jquery/jquery.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, _key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/docs/site/apidocs/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/docs/site/apidocs/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 00000000..93d8bc8e --- /dev/null +++ b/docs/site/apidocs/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/docs/site/apidocs/jquery/jszip-utils/dist/jszip-utils.js b/docs/site/apidocs/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 00000000..775895ec --- /dev/null +++ b/docs/site/apidocs/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a - - + + + + + - - -
-
+
 
+ + -
-
+
-
Package org.openpreservation.format.xml
-

Interface Attribute

+
Package org.openpreservation.format.xml
+

Interface Attribute

-
+
+
+
    +
  • -
    public interface Attribute
    +
    public interface Attribute
    An interface defining the behaviour of XML attributes.
    -
-
-
    + +
+
+
+
    +
  • -
  • -
    -

    Method Summary

    -
    -
    -
    -
    -
    Modifier and Type
    -
    Method
    -
    Description
    -
    int
    -
    getIndex()
    -
    +
    +
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Details

      -
        -
      • -
        -

        getIndex

        -
        int getIndex()
        +
        +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            getIndex

            +
            int getIndex()
            Get the index of the Attribute in the element Array.
            -
            -
            Returns:
            +
            +
            Returns:
            the int index of the Attribute
            -
        • -
      • -
        -

        getQualifiedName

        -
        String getQualifiedName()
        +
      + + + +
        +
      • +

        getQualifiedName

        +
        String getQualifiedName()
        Get the qualified name of the Attribute.
        -
        -
        Returns:
        +
        +
        Returns:
        the String qualified name of the Attribute
        -
      • -
    • -
      -

      getValue

      -
      String getValue()
      +
    + + + +
      +
    • +

      getValue

      +
      String getValue()
      Get the String value of the Attribute.
      -
      -
      Returns:
      +
      +
      Returns:
      the String value of the Attribute
      -
    • -
  • -
    -

    getLocalName

    -
    String getLocalName()
    +
+ + + +
    +
  • +

    getLocalName

    +
    String getLocalName()
    Get the String local name of the Attribute.
    -
    -
    Returns:
    +
    +
    Returns:
    the String local name of the Attribute
    -
    • -
  • -
    -

    getPrefix

    -
    String getPrefix()
    +
+ + + +
    +
  • +

    getPrefix

    +
    String getPrefix()
    Get the String namespace prefix of the Attribute.
    -
    -
    Returns:
    +
    +
    Returns:
    the String namespace prefix of the Attribute
    -
    • -
  • -
    -

    getURI

    -
    URI getURI()
    +
+ + + +
    +
  • +

    getURI

    +
    URI getURI()
    Get the String namespace URI of the Attribute.
    -
    -
    Returns:
    +
    +
    Returns:
    the String namespace URI of the Attribute
    -
    • -
  • -
    -

    getType

    -
    String getType()
    +
+ + + +
    +
  • +

    getType

    +
    String getType()
    Get the String type of the Attribute.
    -
    -
    Returns:
    +
    +
    Returns:
    the String type of the Attribute
    -
- - + + +
+ + + +

Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

+ diff --git a/docs/site/apidocs/org/openpreservation/format/xml/Encodings.html b/docs/site/apidocs/org/openpreservation/format/xml/Encodings.html index a911d1cc..bd375076 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/Encodings.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/Encodings.html @@ -1,363 +1,569 @@ + - -Encodings (ODF spreadsheet validator. 0.18.5 API) - + +Encodings (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
-
+
 
+ + -
-
+
-
Package org.openpreservation.format.xml
-

Enum Class Encodings

+
Package org.openpreservation.format.xml
+

Enum Encodings

-
java.lang.Object -
java.lang.Enum<Encodings> -
org.openpreservation.format.xml.Encodings
-
-
-
-
+
+ +
+
-
-
    - -
  • -
    -

    Nested Class Summary

    -
    -

    Nested classes/interfaces inherited from class java.lang.Enum

    -Enum.EnumDesc<E extends Enum<E>>
    -
    • +
+
+
+ + + + +
    +
  • +

    UTF_16_LE

    +
    public static final Encodings UTF_16_LE
    UTF-16 Little Endian Byte Order Mark
    -
    • -
  • -
    -

    UTF_32_BE

    -
    public static final Encodings UTF_32_BE
    +
+ + + +
    +
  • +

    UTF_32_BE

    +
    public static final Encodings UTF_32_BE
    UTF-32 Big Endian Byte Order Mark
    -
    • -
  • -
    -

    UTF_32_LE

    -
    public static final Encodings UTF_32_LE
    +
+ + + +
    +
  • +

    UTF_32_LE

    +
    public static final Encodings UTF_32_LE
    UTF-32 Little Endian Byte Order Mark
    -
- + + -
  • -
    -

    Field Details

    -
      -
    • -
      -

      encoding

      -
      public final String encoding
      +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          encoding

          +
          public final String encoding
          The String encoding name for the Byte Order Mark
          -
    -
    • + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Encodings[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Encodings[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Encodings c : Encodings.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static Encodings valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static Encodings valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    fromEncoding

    -
    public static Encodings fromEncoding(String encoding)
    + + + + +
      +
    • +

      fromEncoding

      +
      public static Encodings fromEncoding​(String encoding)
      Get an Encodings instance from the String name or NONE if no match
      -
      -
      Parameters:
      +
      +
      Parameters:
      encoding - the name of the encoding to retrieve
      -
      Returns:
      +
      Returns:
      the Endcoding with the given name, or Encoding.NONE if no match
      -
      Throws:
      -
      NullPointerException - if encoding is null
      +
      Throws:
      +
      NullPointerException - if encoding is null
      -
    • -
  • -
    -

    fromRepresentation

    -
    public static Encodings fromRepresentation(byte[] bytes)
    + + + + +
      +
    • +

      fromRepresentation

      +
      public static Encodings fromRepresentation​(byte[] bytes)
      Get an Encodings instance from the byte array representation, or NONE if no match.
      -
      -
      Parameters:
      +
      +
      Parameters:
      bytes - the byte[] representation of the encoding to retrieve
      -
      Returns:
      +
      Returns:
      the Endcodings instance with the given representation, or Encoding.NONE if no match
      -
      Throws:
      -
      NullPointerException - if bytes is null.
      +
      Throws:
      +
      NullPointerException - if bytes is null.
      -
    • -
  • -
    -

    getLength

    -
    public int getLength()
    + + + + +
      +
    • +

      getLength

      +
      public int getLength()
      Returns the length of the Byte Order Mark in bytes
      -
      -
      Returns:
      +
      +
      Returns:
      the int length of the Byte Order Mark in bytes
      -
    • - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/MessageHandler.html b/docs/site/apidocs/org/openpreservation/format/xml/MessageHandler.html index 86e1f029..329443e4 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/MessageHandler.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/MessageHandler.html @@ -1,235 +1,408 @@ + - -MessageHandler (ODF spreadsheet validator. 0.18.5 API) - + +MessageHandler (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Class MessageHandler

    -
    -
    java.lang.Object -
    org.openpreservation.format.xml.MessageHandler
    +
    Package org.openpreservation.format.xml
    +

    Class MessageHandler

    -
    -
    +
    + +
    +
    -
    -
    +
    +
    +
    + + + + + - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/Namespace.html b/docs/site/apidocs/org/openpreservation/format/xml/Namespace.html index 376e9987..b091044e 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/Namespace.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/Namespace.html @@ -1,173 +1,306 @@ + - -Namespace (ODF spreadsheet validator. 0.18.5 API) - + +Namespace (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Interface Namespace

    +
    Package org.openpreservation.format.xml
    +

    Interface Namespace

    -
    -
    +
    +
    +
      +
    • +
      All Known Implementing Classes:
      -
      OdfNamespaces
      +
      OdfNamespaces
      -
      public interface Namespace
      +
      public interface Namespace
      An interface defining the properties of XML namespaces.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      URI
      -
      getId()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getId

          -
          URI getId()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getId

              +
              URI getId()
              Get the URI id of the Namespace.
              -
              -
              Returns:
              +
              +
              Returns:
              the URI id of the Namespace
              -
          • -
        • -
          -

          getPrefix

          -
          String getPrefix()
          +
        + + + +
          +
        • +

          getPrefix

          +
          String getPrefix()
          Get the String prefix of the Namespace.
          -
          -
          Returns:
          +
          +
          Returns:
          the String prefix of the Namespace
          -
        • -
      • -
        -

        getSchemalocation

        -
        URL getSchemalocation()
        +
      + + + +
        +
      • +

        getSchemalocation

        +
        URL getSchemalocation()
        Get the String location of the Namespace.
        -
        -
        Returns:
        +
        +
        Returns:
        the String location of the Namespace
        -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/ParseResult.html b/docs/site/apidocs/org/openpreservation/format/xml/ParseResult.html index 747cab36..ea3a0ee6 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/ParseResult.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/ParseResult.html @@ -1,304 +1,472 @@ + - -ParseResult (ODF spreadsheet validator. 0.18.5 API) - + +ParseResult (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Interface ParseResult

    +
    Package org.openpreservation.format.xml
    +

    Interface ParseResult

    -
    -
    +
    +
    +
      +
    • +
      All Known Subinterfaces:
      XmlValidationResult
      -
      public interface ParseResult
      +
      public interface ParseResult
      An interface defining the properties of XML document parsing results. A ParseResult comprises various high level properties of the parsed XML document, such as the root element name, namespace, etc.
      -
    -
    -
      + +
    +
    +
    + + + + +
      +
    • +

      getUsedNamespaces

      +
      Set<Namespace> getUsedNamespaces()
      Get all of the declared Namespaces in the document
      -
      -
      Returns:
      +
      +
      Returns:
      the Set of the document's namespaces
      -
      • -
    • -
      -

      getRootPrefix

      -
      String getRootPrefix()
      +
    + + + +
      +
    • +

      getRootPrefix

      +
      String getRootPrefix()
      Get the root element namespace prefix
      -
      -
      Returns:
      +
      +
      Returns:
      The String namesapce prefix of the document's root element, or an empty String if there is no root element NS prefix
      -
      • -
    • -
      -

      getRootName

      -
      String getRootName()
      +
    + + + +
      +
    • +

      getRootName

      +
      String getRootName()
      Get the unqualified name of the document's root element
      -
      -
      Returns:
      +
      +
      Returns:
      The String unqualified name of the document's root element, or an empty String if there is no root element name
      -
      • -
    • -
      -

      isRootName

      -
      boolean isRootName(String name)
      +
    + + + +
      +
    • +

      isRootName

      +
      boolean isRootName​(String name)
      Establish whether the document's root element name matches the supplied name
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the String name to compare with the document's root element name
      -
      Returns:
      +
      Returns:
      true if the document's root element name matches the supplied name, otherwise false
      -
      • -
    • -
      -

      getRootAttributes

      -
      List<Attribute> getRootAttributes()
      +
    + + + +
      +
    • +

      getRootAttributes

      +
      List<Attribute> getRootAttributes()
      Get the root element Attributes
      -
      -
      Returns:
      +
      +
      Returns:
      the List root element Attributes
      -
      • -
    • -
      -

      getRootAttributeValue

      -
      String getRootAttributeValue(String qName)
      +
    + + + +
      +
    • +

      getRootAttributeValue

      +
      String getRootAttributeValue​(String qName)
      Get the value of the root element attribute with the supplied qualified name.
      -
      -
      Parameters:
      +
      +
      Parameters:
      qName - the String qualified name of the Attribute that the value is required of.
      -
      Returns:
      +
      Returns:
      the value of the Attribute, or null if the Attribute does not exist
      -
      • -
    • -
      -

      getMessages

      -
      List<Message> getMessages()
      +
    + + + +
      +
    • +

      getMessages

      +
      List<Message> getMessages()
      The List of Message instances generated when parsing the document, which may be empty
      -
      -
      Returns:
      +
      +
      Returns:
      the List of document parsing messages
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/ParsingHandler.html b/docs/site/apidocs/org/openpreservation/format/xml/ParsingHandler.html index b13ac8e6..a58b94dc 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/ParsingHandler.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/ParsingHandler.html @@ -1,215 +1,374 @@ + - -ParsingHandler (ODF spreadsheet validator. 0.18.5 API) - + +ParsingHandler (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Class ParsingHandler

    -
    -
    java.lang.Object -
    org.xml.sax.helpers.DefaultHandler -
    org.openpreservation.format.xml.ParsingHandler
    +
    Package org.openpreservation.format.xml
    +

    Class ParsingHandler

    -
    -
    -
    +
    + +
    +
    -
    -
    -
    -

    Methods inherited from class org.xml.sax.helpers.DefaultHandler

    -characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, unparsedEntityDecl, warning
    -
    -

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.xml.sax.ContentHandler

    -declaration
    +
    +
    +
    + - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/ValidationResult.html b/docs/site/apidocs/org/openpreservation/format/xml/ValidationResult.html deleted file mode 100644 index 54e05ac6..00000000 --- a/docs/site/apidocs/org/openpreservation/format/xml/ValidationResult.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - -ValidationResult (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.format.xml
    -

    Interface ValidationResult

    -
    -
    -
    -
    All Superinterfaces:
    -
    ParseResult
    -
    -
    -
    public interface ValidationResult -extends ParseResult
    -
    Simple extension of ParseResult to indicate whether the result of XML - validation is valid or not.
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        isValid

        -
        boolean isValid()
        -
        Is the XML document valid according to the supplied schema?
        -
        -
        Returns:
        -
        true if the result is for a valid XML document, - otherwise false
        -
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/format/xml/ValidationResults.html b/docs/site/apidocs/org/openpreservation/format/xml/ValidationResults.html deleted file mode 100644 index 0d930e5a..00000000 --- a/docs/site/apidocs/org/openpreservation/format/xml/ValidationResults.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - -ValidationResults (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.format.xml
    -

    Class ValidationResults

    -
    -
    java.lang.Object -
    org.openpreservation.format.xml.ValidationResults
    -
    -
    -
    -
    public final class ValidationResults -extends Object
    -
    A factory for creating ParseResult and ValidationResult - objects.
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        parseResultOf

        -
        public static final ParseResult parseResultOf(boolean valid, - Namespace namespace, - List<Namespace> declareNamespaces, - List<Namespace> usedNamespaces, - String prefix, - String name, - List<Attribute> attributes, - List<Message> messages)
        -
        Create a new ParseResult object from the supplied values.
        -
        -
        Parameters:
        -
        valid - true if the result is for a valid XML document, - otherwise false
        -
        messages - the List of Messages to be used for - the ValidationResult
        -
        Returns:
        -
        a new ParseResult object created from the supplied - values
        -
        -
        -
        • -
      • -
        -

        of

        -
        public static final ValidationResult of(ParseResult parseResult, - boolean valid, - List<Message> messages)
        -
        Creates a new ValidationResult object from the supplied values.
        -
        -
        Parameters:
        -
        parseResult - the ParseResult to be used for the - ValidationResult
        -
        valid - true if the result is for a valid XML - document, otherwise false
        -
        messages - the List of Messages to be used - for the ValidationResult
        -
        Returns:
        -
        a new ValidationResult object created from the supplied - values
        -
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/format/xml/XmlParser.html b/docs/site/apidocs/org/openpreservation/format/xml/XmlParser.html index 487db0a8..7237e088 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/XmlParser.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/XmlParser.html @@ -1,148 +1,276 @@ + - -XmlParser (ODF spreadsheet validator. 0.18.5 API) - + +XmlParser (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Interface XmlParser

    +
    Package org.openpreservation.format.xml
    +

    Interface XmlParser

    -
    +
    +
    +
      +
    • -
      public interface XmlParser
      -
    -
    -
    - +
    +
    +
    + - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/XmlParsers.html b/docs/site/apidocs/org/openpreservation/format/xml/XmlParsers.html index 72dc6920..f92f1220 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/XmlParsers.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/XmlParsers.html @@ -1,184 +1,317 @@ + - -XmlParsers (ODF spreadsheet validator. 0.18.5 API) - + +XmlParsers (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Class XmlParsers

    -
    -
    java.lang.Object -
    org.openpreservation.format.xml.XmlParsers
    +
    Package org.openpreservation.format.xml
    +

    Class XmlParsers

    -
    +
    + +
    +
      +
    • -
      public final class XmlParsers -extends Object
      -
    -
    -
      +
      public final class XmlParsers
+extends Object
      + +
    +
    +
    + - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResult.html b/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResult.html index eb1e2b74..2c187bed 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResult.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResult.html @@ -1,147 +1,274 @@ + - -XmlValidationResult (ODF spreadsheet validator. 0.18.5 API) - + +XmlValidationResult (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Interface XmlValidationResult

    +
    Package org.openpreservation.format.xml
    +

    Interface XmlValidationResult

    -
    -
    +
    +
    +
      +
    • +
      All Superinterfaces:
      ParseResult
      -
      public interface XmlValidationResult -extends ParseResult
      +
      public interface XmlValidationResult
+extends ParseResult
      Simple extension of ParseResult to indicate whether the result of XML validation is valid or not.
      -
    -
    -
      + +
    +
    +
    + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResults.html b/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResults.html index 16ce7b0f..7888f78d 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResults.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/XmlValidationResults.html @@ -1,193 +1,330 @@ + - -XmlValidationResults (ODF spreadsheet validator. 0.18.5 API) - + +XmlValidationResults (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Class XmlValidationResults

    -
    -
    java.lang.Object -
    org.openpreservation.format.xml.XmlValidationResults
    +
    Package org.openpreservation.format.xml
    +

    Class XmlValidationResults

    -
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.openpreservation.format.xml.XmlValidationResults
        • +
      +
      • +
    +
    +
    -
    -
      + +
    +
    +
    + - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/XmlValidator.html b/docs/site/apidocs/org/openpreservation/format/xml/XmlValidator.html index 5e6e8605..ef2e82b1 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/XmlValidator.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/XmlValidator.html @@ -1,219 +1,369 @@ + - -XmlValidator (ODF spreadsheet validator. 0.18.5 API) - + +XmlValidator (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.xml
    -

    Class XmlValidator

    -
    -
    java.lang.Object -
    org.openpreservation.format.xml.XmlValidator
    +
    Package org.openpreservation.format.xml
    +

    Class XmlValidator

    -
    +
    + +
    +
      +
    • -
      public final class XmlValidator -extends Object
      +
      public final class XmlValidator
+extends Object
      Simple class to wrap XML schema validation.
      -
    -
    -
      - -
    • -
      -

      Constructor Summary

      -
      Constructors
      -
      -
      Constructor
      -
      Description
      -
      XmlValidator()
      -
       
      +
      • +
    - +
    + - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/Attribute.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/Attribute.html index 411e7899..6e26e875 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/Attribute.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/Attribute.html @@ -1,89 +1,196 @@ + - -Uses of Interface org.openpreservation.format.xml.Attribute (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.xml.Attribute (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.xml.Attribute

    +

    Uses of Interface
    org.openpreservation.format.xml.Attribute

    -
    Packages that use Attribute
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/Encodings.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/Encodings.html index 81c73562..093e30df 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/Encodings.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/Encodings.html @@ -1,130 +1,259 @@ + - -Uses of Enum Class org.openpreservation.format.xml.Encodings (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.xml.Encodings (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.format.xml.Encodings

    +

    Uses of Class
    org.openpreservation.format.xml.Encodings

    -
    Packages that use Encodings
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.odf.fmt
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/MessageHandler.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/MessageHandler.html index 14b9ab2a..acb3478a 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/MessageHandler.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/MessageHandler.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.xml.MessageHandler (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.xml.MessageHandler (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.xml.MessageHandler

    +

    Uses of Class
    org.openpreservation.format.xml.MessageHandler

    -No usage of org.openpreservation.format.xml.MessageHandler
    +
    No usage of org.openpreservation.format.xml.MessageHandler
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/Namespace.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/Namespace.html index 8e716516..689213a5 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/Namespace.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/Namespace.html @@ -1,181 +1,330 @@ + - -Uses of Interface org.openpreservation.format.xml.Namespace (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.xml.Namespace (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.xml.Namespace

    -
    -
    Packages that use Namespace
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    +

    Uses of Interface
    org.openpreservation.format.xml.Namespace

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParseResult.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParseResult.html index b089923d..a328e936 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParseResult.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParseResult.html @@ -1,227 +1,427 @@ + - -Uses of Interface org.openpreservation.format.xml.ParseResult (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.xml.ParseResult (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.xml.ParseResult

    -
    -
    Packages that use ParseResult
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    +

    Uses of Interface
    org.openpreservation.format.xml.ParseResult

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParsingHandler.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParsingHandler.html index 944dff95..d688d80b 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParsingHandler.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/ParsingHandler.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.xml.ParsingHandler (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.xml.ParsingHandler (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.xml.ParsingHandler

    +

    Uses of Class
    org.openpreservation.format.xml.ParsingHandler

    -No usage of org.openpreservation.format.xml.ParsingHandler
    +
    No usage of org.openpreservation.format.xml.ParsingHandler
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ValidationResult.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/ValidationResult.html deleted file mode 100644 index 303438b6..00000000 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ValidationResult.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - -Uses of Interface org.openpreservation.format.xml.ValidationResult (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Interface
    org.openpreservation.format.xml.ValidationResult

    -
    -
    Packages that use ValidationResult
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ValidationResults.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/ValidationResults.html deleted file mode 100644 index 5646d0a6..00000000 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/ValidationResults.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - -Uses of Class org.openpreservation.format.xml.ValidationResults (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Class
    org.openpreservation.format.xml.ValidationResults

    -
    -No usage of org.openpreservation.format.xml.ValidationResults
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParser.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParser.html index 2f6766b1..775b071b 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParser.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParser.html @@ -1,89 +1,196 @@ + - -Uses of Interface org.openpreservation.format.xml.XmlParser (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.xml.XmlParser (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.xml.XmlParser

    +

    Uses of Interface
    org.openpreservation.format.xml.XmlParser

    -
    Packages that use XmlParser
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParsers.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParsers.html index 8c4aee81..036f7b2b 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParsers.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlParsers.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.xml.XmlParsers (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.xml.XmlParsers (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.xml.XmlParsers

    +

    Uses of Class
    org.openpreservation.format.xml.XmlParsers

    -No usage of org.openpreservation.format.xml.XmlParsers
    +
    No usage of org.openpreservation.format.xml.XmlParsers
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResult.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResult.html index bc474b62..89710453 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResult.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResult.html @@ -1,106 +1,217 @@ + - -Uses of Interface org.openpreservation.format.xml.XmlValidationResult (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.xml.XmlValidationResult (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.xml.XmlValidationResult

    +

    Uses of Interface
    org.openpreservation.format.xml.XmlValidationResult

    -
    Packages that use XmlValidationResult
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResults.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResults.html index 5a143113..2b5b6ecb 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResults.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidationResults.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.xml.XmlValidationResults (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.xml.XmlValidationResults (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.xml.XmlValidationResults

    +

    Uses of Class
    org.openpreservation.format.xml.XmlValidationResults

    -No usage of org.openpreservation.format.xml.XmlValidationResults
    +
    No usage of org.openpreservation.format.xml.XmlValidationResults
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidator.html b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidator.html index ec48408a..fe0cf45a 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidator.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/class-use/XmlValidator.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.xml.XmlValidator (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.xml.XmlValidator (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.xml.XmlValidator

    +

    Uses of Class
    org.openpreservation.format.xml.XmlValidator

    -No usage of org.openpreservation.format.xml.XmlValidator
    +
    No usage of org.openpreservation.format.xml.XmlValidator
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/package-summary.html b/docs/site/apidocs/org/openpreservation/format/xml/package-summary.html index cadbfe12..5abc6e39 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/package-summary.html @@ -1,129 +1,246 @@ + - -org.openpreservation.format.xml (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.format.xml (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.format.xml

    -
    -
    -
    package org.openpreservation.format.xml
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/package-tree.html b/docs/site/apidocs/org/openpreservation/format/xml/package-tree.html index 712fcc22..9827462c 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/package-tree.html @@ -1,111 +1,200 @@ + - -org.openpreservation.format.xml Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.format.xml Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.format.xml

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/xml/package-use.html b/docs/site/apidocs/org/openpreservation/format/xml/package-use.html index 437b8012..3d4b987e 100644 --- a/docs/site/apidocs/org/openpreservation/format/xml/package-use.html +++ b/docs/site/apidocs/org/openpreservation/format/xml/package-use.html @@ -1,169 +1,337 @@ + - -Uses of Package org.openpreservation.format.xml (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.format.xml (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.format.xml

    -
    Packages that use org.openpreservation.format.xml
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.fmt
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipArchive.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipArchive.html index 833981af..e76ba8d8 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipArchive.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipArchive.html @@ -1,213 +1,356 @@ + - -ZipArchive (ODF spreadsheet validator. 0.18.5 API) - + +ZipArchive (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Interface ZipArchive

    +
    Package org.openpreservation.format.zip
    +

    Interface ZipArchive

    -
    -
    +
    +
    +
      +
    • +
      All Known Subinterfaces:
      ZipArchiveCache
      -
      +
      All Known Implementing Classes:
      ZipFileProcessor
      -
      public interface ZipArchive
      +
      public interface ZipArchive
      An interface for accessing the contents of a Zip archive.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      ZipEntry
      -
      getFirstEntry()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getPath

          -
          Path getPath()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getPath

              +
              Path getPath()
              Get the path to the archive
              -
              -
              Returns:
              +
              +
              Returns:
              the Path to the archive
              -
          • -
        • -
          -

          getFirstEntry

          -
          ZipEntry getFirstEntry()
          +
        + + + +
          +
        • +

          getFirstEntry

          +
          ZipEntry getFirstEntry()
          Returns the first physical ZipEntry in the archive. Used to ensure that the MIMETYPE entry is the first in the archive.
          -
          -
          Returns:
          +
          +
          Returns:
          the first physical ZipEntry in the archive
          -
        • -
      • -
        -

        getZipEntries

        -
        List<ZipEntry> getZipEntries()
        +
      + + + +
        +
      • +

        getZipEntries

        +
        List<ZipEntry> getZipEntries()
        Get a List of all of the zip entries in the archive
        -
        -
        Returns:
        +
        +
        Returns:
        a List of all of the zip entries in the archive
        -
      • -
    • -
      -

      getZipEntry

      -
      ZipEntry getZipEntry(String entryName)
      +
    + + + +
      +
    • +

      getZipEntry

      +
      ZipEntry getZipEntry​(String entryName)
      Retrieve a ZipEntry by entry name, equivalent to the path.
      -
      -
      Parameters:
      +
      +
      Parameters:
      entryName - the name of the ZipEntry to retrieve
      -
      Returns:
      +
      Returns:
      the ZipEntry with the given entryName, or null if no match
      -
      • -
    • -
      -

      size

      -
      int size()
      +
    + + + +
      +
    • +

      size

      +
      int size()
      Get the count of entries in the archive
      -
      -
      Returns:
      +
      +
      Returns:
      int number of ZipEntries in the archive
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipArchiveCache.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipArchiveCache.html index 24bf6b6b..d24d60f3 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipArchiveCache.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipArchiveCache.html @@ -1,156 +1,283 @@ + - -ZipArchiveCache (ODF spreadsheet validator. 0.18.5 API) - + +ZipArchiveCache (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Interface ZipArchiveCache

    +
    Package org.openpreservation.format.zip
    +

    Interface ZipArchiveCache

    -
    -
    +
    +
    +
      +
    • +
      All Superinterfaces:
      ZipArchive
      -
      +
      All Known Implementing Classes:
      ZipFileProcessor
      -
      public interface ZipArchiveCache -extends ZipArchive
      +
      public interface ZipArchiveCache
+extends ZipArchive
      An extension of ZipArchive that caches the contents of the archive and provides access to the InputStreams.
      -
    -
    -
      + +
    +
    +
    + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipEntry.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipEntry.html index da5558ac..41b51931 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipEntry.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipEntry.html @@ -1,254 +1,412 @@ + - -ZipEntry (ODF spreadsheet validator. 0.18.5 API) - + +ZipEntry (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Interface ZipEntry

    +
    Package org.openpreservation.format.zip
    +

    Interface ZipEntry

    -
    -
    +
    +
    +
      +
    • +
      All Known Implementing Classes:
      ZipEntryImpl
      -
      public interface ZipEntry
      +
      public interface ZipEntry
      An interface for recording and accessing the properties of an entry from a ZipArchive.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      long
      -
      getCompressedSize()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getName

          -
          String getName()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getName

              +
              String getName()
              Get the name of the entry
              -
              -
              Returns:
              +
              +
              Returns:
              the String name of the entry
              -
          • -
        • -
          -

          getSize

          -
          long getSize()
          +
        + + + +
          +
        • +

          getSize

          +
          long getSize()
          Get the size of the entry in bytes
          -
          -
          Returns:
          +
          +
          Returns:
          the long size of the entry in bytes
          -
        • -
      • -
        -

        getCompressedSize

        -
        long getCompressedSize()
        +
      + + + +
        +
      • +

        getCompressedSize

        +
        long getCompressedSize()
        Get the compressed size of the entry in bytes
        -
        -
        Returns:
        +
        +
        Returns:
        the long compressed size of the entry in bytes
        -
      • -
    • -
      -

      getCrc

      -
      long getCrc()
      +
    + + + +
      +
    • +

      getCrc

      +
      long getCrc()
      Get the CRC of the entry
      -
      -
      Returns:
      +
      +
      Returns:
      the long CRC of the entry
      -
      • -
    • -
      -

      isStored

      -
      boolean isStored()
      +
    + + + +
      +
    • +

      isStored

      +
      boolean isStored()
      Is the entry STORED, e.g. not compressed?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the entry is uncompressed, false otherwise
      -
      • -
    • -
      -

      getMethod

      -
      int getMethod()
      +
    + + + +
      +
    • +

      getMethod

      +
      int getMethod()
      Get the integer code for the compression method used for the entry.
      -
      -
      Returns:
      +
      +
      Returns:
      the int compression method code
      -
      • -
    • -
      -

      isDirectory

      -
      boolean isDirectory()
      +
    + + + +
      +
    • +

      isDirectory

      +
      boolean isDirectory()
      Is the entry a directory?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the entry is a directory, false otherwise
      -
      • -
    • -
      -

      getExtra

      -
      byte[] getExtra()
      +
    + + + +
      +
    • +

      getExtra

      +
      byte[] getExtra()
      Get the extra field data for the entry
      -
      -
      Returns:
      +
      +
      Returns:
      the byte[] extra field data for the entry.
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryImpl.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryImpl.html index fb843cf7..e84fa098 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryImpl.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryImpl.html @@ -1,323 +1,505 @@ + - -ZipEntryImpl (ODF spreadsheet validator. 0.18.5 API) - + +ZipEntryImpl (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Class ZipEntryImpl

    -
    -
    java.lang.Object -
    org.openpreservation.format.zip.ZipEntryImpl
    +
    Package org.openpreservation.format.zip
    +

    Class ZipEntryImpl

    -
    -
    +
    + +
    +
      +
    • +
      All Implemented Interfaces:
      ZipEntry
      -
      public final class ZipEntryImpl -extends Object -implements ZipEntry
      -
    -
    -
      +
      public final class ZipEntryImpl
+extends Object
+implements ZipEntry
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      boolean
      -
      equals(Object obj)
      -
       
      -
      long
      -
      getCompressedSize()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getName

          -
          public String getName()
          -
          Description copied from interface: ZipEntry
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getName

              +
              public String getName()
              +
              Description copied from interface: ZipEntry
              Get the name of the entry
              -
              -
              Specified by:
              +
              +
              Specified by:
              getName in interface ZipEntry
              -
              Returns:
              +
              Returns:
              the String name of the entry
              -
          • -
        • -
          -

          getSize

          -
          public long getSize()
          -
          Description copied from interface: ZipEntry
          +
        + + + +
          +
        • +

          getSize

          +
          public long getSize()
          +
          Description copied from interface: ZipEntry
          Get the size of the entry in bytes
          -
          -
          Specified by:
          +
          +
          Specified by:
          getSize in interface ZipEntry
          -
          Returns:
          +
          Returns:
          the long size of the entry in bytes
          -
        • -
      • -
        -

        getCompressedSize

        -
        public long getCompressedSize()
        -
        Description copied from interface: ZipEntry
        +
      + + + +
        +
      • +

        getCompressedSize

        +
        public long getCompressedSize()
        +
        Description copied from interface: ZipEntry
        Get the compressed size of the entry in bytes
        -
        -
        Specified by:
        +
        +
        Specified by:
        getCompressedSize in interface ZipEntry
        -
        Returns:
        +
        Returns:
        the long compressed size of the entry in bytes
        -
      • -
    • -
      -

      getCrc

      -
      public long getCrc()
      -
      Description copied from interface: ZipEntry
      +
    + + + +
      +
    • +

      getCrc

      +
      public long getCrc()
      +
      Description copied from interface: ZipEntry
      Get the CRC of the entry
      -
      -
      Specified by:
      +
      +
      Specified by:
      getCrc in interface ZipEntry
      -
      Returns:
      +
      Returns:
      the long CRC of the entry
      -
      • -
    • -
      -

      isStored

      -
      public boolean isStored()
      -
      Description copied from interface: ZipEntry
      +
    + + + +
      +
    • +

      isStored

      +
      public boolean isStored()
      +
      Description copied from interface: ZipEntry
      Is the entry STORED, e.g. not compressed?
      -
      -
      Specified by:
      +
      +
      Specified by:
      isStored in interface ZipEntry
      -
      Returns:
      +
      Returns:
      true if the entry is uncompressed, false otherwise
      -
      • -
    • -
      -

      getMethod

      -
      public int getMethod()
      -
      Description copied from interface: ZipEntry
      +
    + + + +
      +
    • +

      getMethod

      +
      public int getMethod()
      +
      Description copied from interface: ZipEntry
      Get the integer code for the compression method used for the entry.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getMethod in interface ZipEntry
      -
      Returns:
      +
      Returns:
      the int compression method code
      -
      • -
    • -
      -

      isDirectory

      -
      public boolean isDirectory()
      -
      Description copied from interface: ZipEntry
      +
    + + + +
      +
    • +

      isDirectory

      +
      public boolean isDirectory()
      +
      Description copied from interface: ZipEntry
      Is the entry a directory?
      -
      -
      Specified by:
      +
      +
      Specified by:
      isDirectory in interface ZipEntry
      -
      Returns:
      +
      Returns:
      true if the entry is a directory, false otherwise
      -
      • -
    • -
      -

      getExtra

      -
      public byte[] getExtra()
      -
      Description copied from interface: ZipEntry
      +
    + + + +
      +
    • +

      getExtra

      +
      public byte[] getExtra()
      +
      Description copied from interface: ZipEntry
      Get the extra field data for the entry
      -
      -
      Specified by:
      +
      +
      Specified by:
      getExtra in interface ZipEntry
      -
      Returns:
      +
      Returns:
      the byte[] extra field data for the entry.
      -
      • -
    • -
      -

      hashCode

      -
      public int hashCode()
      -
      -
      Overrides:
      -
      hashCode in class Object
      +
    + + + +
      +
    • +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      -
      • -
    • -
      -

      equals

      -
      public boolean equals(Object obj)
      -
      -
      Overrides:
      -
      equals in class Object
      +
    + + + + + + + + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryProcessor.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryProcessor.html index 806d486a..84e49218 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryProcessor.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipEntryProcessor.html @@ -1,164 +1,292 @@ + - -ZipEntryProcessor (ODF spreadsheet validator. 0.18.5 API) - + +ZipEntryProcessor (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Interface ZipEntryProcessor

    +
    Package org.openpreservation.format.zip
    +

    Interface ZipEntryProcessor

    -
    +
    +
    +
      +
    • -
      public interface ZipEntryProcessor
      -
      Interface for processing ZipEntry objects from a ZipArchive
      -
    -
    -
      +
      public interface ZipEntryProcessor
      +
      Interface for processing ZipEntry objects from a ZipArchive
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      boolean
      -
      accepts(ZipEntry entry)
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          accepts

          -
          boolean accepts(ZipEntry entry)
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              accepts

              +
              boolean accepts​(ZipEntry entry)
              Returns true if the processor accepts the supplied ZipEntry for processing.
              -
              -
              Parameters:
              +
              +
              Parameters:
              entry - The ZipEntry to evaluate.
              -
              Returns:
              +
              Returns:
              true if the processor accepts the entry, otherwise false.
              -
          • -
        • -
          -

          process

          -
          void process(ZipEntry entry, - InputStream is) - throws IOException
          +
        + + + +
          +
        • +

          process

          +
          void process​(ZipEntry entry,
+             InputStream is)
+      throws IOException
          Process the ZipEntry and it's InputStream.
          -
          -
          Parameters:
          +
          +
          Parameters:
          entry - The ZipEntry to process.
          is - The InputStream for the ZipEntry entry.
          -
          Throws:
          -
          IOException - when an IO error occurs reading the +
          Throws:
          +
          IOException - when an IO error occurs reading the InputStream.
          -
      -
    - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipFileProcessor.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipFileProcessor.html index 0e4fa637..e6e63021 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipFileProcessor.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipFileProcessor.html @@ -1,275 +1,437 @@ + - -ZipFileProcessor (ODF spreadsheet validator. 0.18.5 API) - + +ZipFileProcessor (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Class ZipFileProcessor

    -
    -
    java.lang.Object -
    org.openpreservation.format.zip.ZipFileProcessor
    +
    Package org.openpreservation.format.zip
    +

    Class ZipFileProcessor

    -
    -
    +
    + +
    +
    -
    -
      + +
    +
    +
    + + + + +
      +
    • +

      getZipEntry

      +
      public ZipEntry getZipEntry​(String entryName)
      +
      Description copied from interface: ZipArchive
      Retrieve a ZipEntry by entry name, equivalent to the path.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getZipEntry in interface ZipArchive
      -
      Parameters:
      +
      Parameters:
      entryName - the name of the ZipEntry to retrieve
      -
      Returns:
      +
      Returns:
      the ZipEntry with the given entryName, or null if no match
      -
      • -
    • -
      -

      size

      -
      public int size()
      -
      Description copied from interface: ZipArchive
      +
    + + + + + + + + + + + + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.Factory.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.Factory.html index 5e49346e..9ea72131 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.Factory.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.Factory.html @@ -1,144 +1,267 @@ + - -ZipProcessor.Factory (ODF spreadsheet validator. 0.18.5 API) - + +ZipProcessor.Factory (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Interface ZipProcessor.Factory

    +
    Package org.openpreservation.format.zip
    +

    Interface ZipProcessor.Factory

    -
    -
    +
    +
    +
      +
    • +
      Enclosing interface:
      ZipProcessor
      -
      public static interface ZipProcessor.Factory
      +
      public static interface ZipProcessor.Factory
      Factory for creating a ZipProcessor.
      -
    -
    -
      + +
    +
    +
    + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.html b/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.html index 76e4a3df..ef978a0c 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/ZipProcessor.html @@ -1,163 +1,294 @@ + - -ZipProcessor (ODF spreadsheet validator. 0.18.5 API) - + +ZipProcessor (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Interface ZipProcessor

    +
    Package org.openpreservation.format.zip
    +

    Interface ZipProcessor

    -
    +
    +
    +
      +
    • -
      public interface ZipProcessor
      -
      Interface for a processor that processes an InputStream and a factory +
      public interface ZipProcessor
      +
      Interface for a processor that processes an InputStream and a factory for the processor.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Nested Class Summary

      -
      Nested Classes
      -
      -
      Modifier and Type
      -
      Interface
      -
      Description
      -
      static interface 
      -
      ZipProcessor.Factory
      -
      +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeInterfaceDescription
        static interface ZipProcessor.Factory
        Factory for creating a ZipProcessor.
        - - - +
        • +
      +
      -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      ZipArchive
      -
      process(InputStream toProcess)
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          process

          -
          ZipArchive process(InputStream toProcess) - throws IOException
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              process

              +
              ZipArchive process​(InputStream toProcess)
+            throws IOException
              Process the InputStream and return a ZipArchive containing parsed from the stream.
              -
              -
              Parameters:
              +
              +
              Parameters:
              toProcess - the InputStream to process
              -
              Returns:
              +
              Returns:
              a ZipArchive parsed from the stream
              -
              Throws:
              -
              IOException - when an IO error occurs reading the +
              Throws:
              +
              IOException - when an IO error occurs reading the InputStream
              -
        -
      - +
      • +
    +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/Zips.html b/docs/site/apidocs/org/openpreservation/format/zip/Zips.html index 3f500481..d2488925 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/Zips.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/Zips.html @@ -1,241 +1,393 @@ + - -Zips (ODF spreadsheet validator. 0.18.5 API) - + +Zips (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.format.zip
    -

    Class Zips

    -
    -
    java.lang.Object -
    org.openpreservation.format.zip.Zips
    +
    Package org.openpreservation.format.zip
    +

    Class Zips

    -
    +
    + +
    +
      +
    • -
      public final class Zips -extends Object
      +
      public final class Zips
+extends Object
      Utility class for working with ZipArchives.
      -
    -
    -
      + +
    +
    +
    + + + + +
      +
    • +

      zipArchiveCacheInstance

      +
      public static final ZipArchiveCache zipArchiveCacheInstance​(Path path)
+                                                     throws IOException
      Create a ZipArchiveCache instance that caches the contents of the archive and provides access to the Paths.
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the Path to cache
      -
      Returns:
      +
      Returns:
      a ZipArchiveCache instance that caches the contents of the archive and provides access to the InputStreams
      -
      Throws:
      -
      IOException
      +
      Throws:
      +
      IOException
      -
      • -
    • -
      -

      zipEntryInstance

      -
      public static final ZipEntry zipEntryInstance(String name, - int size, - int compressedSize, - int crc32, - int method, - boolean isDirectory, - byte[] extra)
      -
      +
    + + + +
      +
    • +

      zipEntryInstance

      +
      public static final ZipEntry zipEntryInstance​(String name,
+                                              int size,
+                                              int compressedSize,
+                                              int crc32,
+                                              int method,
+                                              boolean isDirectory,
+                                              byte[] extra)
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchive.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchive.html index 5144b54c..1370415e 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchive.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchive.html @@ -1,132 +1,261 @@ + - -Uses of Interface org.openpreservation.format.zip.ZipArchive (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.zip.ZipArchive (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.zip.ZipArchive

    -
    -
    Packages that use ZipArchive
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    +

    Uses of Interface
    org.openpreservation.format.zip.ZipArchive

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchiveCache.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchiveCache.html index 227bde89..9941c8d8 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchiveCache.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipArchiveCache.html @@ -1,108 +1,223 @@ + - -Uses of Interface org.openpreservation.format.zip.ZipArchiveCache (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.zip.ZipArchiveCache (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.zip.ZipArchiveCache

    +

    Uses of Interface
    org.openpreservation.format.zip.ZipArchiveCache

    -
    Packages that use ZipArchiveCache
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntry.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntry.html index 50518849..f5f626ab 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntry.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntry.html @@ -1,152 +1,291 @@ + - -Uses of Interface org.openpreservation.format.zip.ZipEntry (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.zip.ZipEntry (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.zip.ZipEntry

    -
    -
    Packages that use ZipEntry
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    +

    Uses of Interface
    org.openpreservation.format.zip.ZipEntry

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryImpl.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryImpl.html index 24710775..3d093fb4 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryImpl.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryImpl.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.zip.ZipEntryImpl (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.zip.ZipEntryImpl (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.zip.ZipEntryImpl

    +

    Uses of Class
    org.openpreservation.format.zip.ZipEntryImpl

    -No usage of org.openpreservation.format.zip.ZipEntryImpl
    +
    No usage of org.openpreservation.format.zip.ZipEntryImpl
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryProcessor.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryProcessor.html index 0394c9c3..3aeabf6f 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryProcessor.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipEntryProcessor.html @@ -1,102 +1,215 @@ + - -Uses of Interface org.openpreservation.format.zip.ZipEntryProcessor (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.zip.ZipEntryProcessor (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.zip.ZipEntryProcessor

    +

    Uses of Interface
    org.openpreservation.format.zip.ZipEntryProcessor

    -
    Packages that use ZipEntryProcessor
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipFileProcessor.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipFileProcessor.html index c018de48..b9333c9a 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipFileProcessor.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipFileProcessor.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.zip.ZipFileProcessor (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.zip.ZipFileProcessor (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.zip.ZipFileProcessor

    +

    Uses of Class
    org.openpreservation.format.zip.ZipFileProcessor

    -No usage of org.openpreservation.format.zip.ZipFileProcessor
    +
    No usage of org.openpreservation.format.zip.ZipFileProcessor
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.Factory.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.Factory.html index c4f62da8..e5e39670 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.Factory.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.Factory.html @@ -1,90 +1,197 @@ + - -Uses of Interface org.openpreservation.format.zip.ZipProcessor.Factory (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.zip.ZipProcessor.Factory (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.zip.ZipProcessor.Factory

    +

    Uses of Interface
    org.openpreservation.format.zip.ZipProcessor.Factory

    -
    Packages that use ZipProcessor.Factory
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.html index 86aa1c54..2b8dc228 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/ZipProcessor.html @@ -1,89 +1,196 @@ + - -Uses of Interface org.openpreservation.format.zip.ZipProcessor (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.format.zip.ZipProcessor (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.format.zip.ZipProcessor

    +

    Uses of Interface
    org.openpreservation.format.zip.ZipProcessor

    -
    Packages that use ZipProcessor
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/class-use/Zips.html b/docs/site/apidocs/org/openpreservation/format/zip/class-use/Zips.html index 00f81c4b..91e696be 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/class-use/Zips.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/class-use/Zips.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.format.zip.Zips (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.format.zip.Zips (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.format.zip.Zips

    +

    Uses of Class
    org.openpreservation.format.zip.Zips

    -No usage of org.openpreservation.format.zip.Zips
    +
    No usage of org.openpreservation.format.zip.Zips
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/package-summary.html b/docs/site/apidocs/org/openpreservation/format/zip/package-summary.html index 87bf81cc..8118ae24 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/package-summary.html @@ -1,129 +1,231 @@ + - -org.openpreservation.format.zip (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.format.zip (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.format.zip

    -
    -
    -
    package org.openpreservation.format.zip
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/package-tree.html b/docs/site/apidocs/org/openpreservation/format/zip/package-tree.html index 08530ed9..70ab9d4a 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/package-tree.html @@ -1,92 +1,181 @@ + - -org.openpreservation.format.zip Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.format.zip Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.format.zip

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/format/zip/package-use.html b/docs/site/apidocs/org/openpreservation/format/zip/package-use.html index a8025412..b0ed2e00 100644 --- a/docs/site/apidocs/org/openpreservation/format/zip/package-use.html +++ b/docs/site/apidocs/org/openpreservation/format/zip/package-use.html @@ -1,140 +1,267 @@ + - -Uses of Package org.openpreservation.format.zip (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.format.zip (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.format.zip

    -
    Packages that use org.openpreservation.format.zip
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.zip
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/messages/Message.Severity.html b/docs/site/apidocs/org/openpreservation/messages/Message.Severity.html deleted file mode 100644 index 65ea257d..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/Message.Severity.html +++ /dev/null @@ -1,287 +0,0 @@ - - - - -Message.Severity (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.messages
    -

    Enum Class Message.Severity

    -
    -
    java.lang.Object -
    java.lang.Enum<Message.Severity> -
    org.openpreservation.messages.Message.Severity
    -
    -
    -
    -
    -
    All Implemented Interfaces:
    -
    Serializable, Comparable<Message.Severity>, java.lang.constant.Constable
    -
    -
    -
    Enclosing interface:
    -
    Message
    -
    -
    -
    public static enum Message.Severity -extends Enum<Message.Severity>
    -
    An enum set that defines the severity of a message.
    -
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      -
      • - -
    • -
      -

      Enum Constant Summary

      -
      Enum Constants
      -
      -
      Enum Constant
      -
      Description
      -
      ERROR
      -
      -
      The message is an error, equivalent to MUST
      -
      -
      FATAL
      -
      -
      The message is a fatal error, usually an system issue
      -
      -
      INFO
      -
      -
      The message is informational, equivalent to MAY
      -
      -
      WARNING
      -
      -
      The message is a warning, equivalent to SHOULD
      -
      -
      -
      -
      • - -
    • -
      -

      Field Summary

      -
      Fields
      -
      -
      Modifier and Type
      -
      Field
      -
      Description
      -
      final String
      -
      label
      -
      -
      The label for the severity, lower case
      -
      -
      -
      -
      • - -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      static Message.Severity
      -
      valueOf(String name)
      -
      -
      Returns the enum constant of this class with the specified name.
      -
      -
      static Message.Severity[]
      -
      values()
      -
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      -
      -
      -
      -

      Methods inherited from class java.lang.Enum

      -clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      -
      -

      Methods inherited from class java.lang.Object

      -getClass, notify, notifyAll, wait, wait, wait
      -
      -
      • -
    -
    -
    -
      - -
    • -
      -

      Enum Constant Details

      -
        -
      • -
        -

        INFO

        -
        public static final Message.Severity INFO
        -
        The message is informational, equivalent to MAY
        -
        -
        • -
      • -
        -

        WARNING

        -
        public static final Message.Severity WARNING
        -
        The message is a warning, equivalent to SHOULD
        -
        -
        • -
      • -
        -

        ERROR

        -
        public static final Message.Severity ERROR
        -
        The message is an error, equivalent to MUST
        -
        -
        • -
      • -
        -

        FATAL

        -
        public static final Message.Severity FATAL
        -
        The message is a fatal error, usually an system issue
        -
        -
        • -
      -
      -
      • - -
    • -
      -

      Field Details

      -
        -
      • -
        -

        label

        -
        public final String label
        -
        The label for the severity, lower case
        -
        -
        • -
      -
      -
      • - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        values

        -
        public static Message.Severity[] values()
        -
        Returns an array containing the constants of this enum class, in -the order they are declared.
        -
        -
        Returns:
        -
        an array containing the constants of this enum class, in the order they are declared
        -
        -
        -
        • -
      • -
        -

        valueOf

        -
        public static Message.Severity valueOf(String name)
        -
        Returns the enum constant of this class with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum class has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/Message.html b/docs/site/apidocs/org/openpreservation/messages/Message.html deleted file mode 100644 index 3d6cd43e..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/Message.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - -Message (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.messages
    -

    Interface Message

    -
    -
    -
    -
    public interface Message
    -
    Defines behaviour of validation messages. - - These messages have a unique string identifier as well as - the previous message and sub-message strings.
    -
    -
    Author:
    -
    Carl Wilson - carlwilson AT github
    -
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        getId

        -
        String getId()
        -
        Get the unique, persistent message identifier.
        -
        -
        Returns:
        -
        the String message id.
        -
        -
        -
        • -
      • -
        -

        getTimestamp

        -
        Date getTimestamp()
        -
        Get the message timestamp
        -
        -
        Returns:
        -
        the Date timestamp of the message, or null if not set
        -
        -
        -
        • -
      • -
        -

        getSeverity

        -
        Message.Severity getSeverity()
        -
        Get the message severity
        -
        -
        Returns:
        -
        the Message.Severity of the message
        -
        -
        -
        • -
      • -
        -

        getMessage

        -
        String getMessage()
        -
        Get the main message
        -
        -
        Returns:
        -
        the String message
        -
        -
        -
        • -
      • -
        -

        hasSubMessage

        -
        boolean hasSubMessage()
        -
        Test whether the message has a sub-message
        -
        -
        Returns:
        -
        true if the message has a sub-message, - false otherwise
        -
        -
        -
        • -
      • -
        -

        getSubMessage

        -
        String getSubMessage()
        -
        Get the sub-message
        -
        -
        Returns:
        -
        the String sub-message
        -
        -
        -
        • -
      • -
        -

        isError

        -
        boolean isError()
        -
        Test whether the message has Message.Severity ERROR.
        -
        -
        Returns:
        -
        true if the message has Severity.ERROR, - false otherwise
        -
        -
        -
        • -
      • -
        -

        isFatal

        -
        boolean isFatal()
        -
        Test whether the message has Message.Severity FATAL.
        -
        -
        Returns:
        -
        true if the message has Severity.FATAL, - false otherwise
        -
        -
        -
        • -
      • -
        -

        isInfo

        -
        boolean isInfo()
        -
        Test whether the message has Message.Severity INFO.
        -
        -
        Returns:
        -
        true if the message has Severity.INFO, - false otherwise
        -
        -
        -
        • -
      • -
        -

        isWarning

        -
        boolean isWarning()
        -
        Test whether the message has Message.Severity WARNING.
        -
        -
        Returns:
        -
        true if the message has Severity.WARNING, - false otherwise
        -
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/MessageFactory.html b/docs/site/apidocs/org/openpreservation/messages/MessageFactory.html deleted file mode 100644 index a741fb42..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/MessageFactory.html +++ /dev/null @@ -1,367 +0,0 @@ - - - - -MessageFactory (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.messages
    -

    Interface MessageFactory

    -
    -
    -
    -
    public interface MessageFactory
    -
    Factory interface for Message creation
    -
    -
    Author:
    -
    Carl Wilson - carlwilson AT github
    -
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        getMessage

        -
        Message getMessage(String id, - Message.Severity severity) - throws NoSuchElementException
        -
        Retrieve Message by unique persistent id and Severity
        -
        -
        Parameters:
        -
        id - the String id of the Message to be retrieved
        -
        severity - the the Message.Severity of the message
        -
        Returns:
        -
        the Message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no Message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getError

        -
        Message getError(String id) - throws NoSuchElementException
        -
        Retrieve error Message by unique persistent id
        -
        -
        Parameters:
        -
        id - the String id of the message to be retrieved
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no Message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getFatal

        -
        Message getFatal(String id) - throws NoSuchElementException
        -
        Retrieve fatal Message by unique persistent id
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getInfo

        -
        Message getInfo(String id) - throws NoSuchElementException
        -
        Retrieve info Message by unique persistent id
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getWarning

        -
        Message getWarning(String id) - throws NoSuchElementException
        -
        Retrieve warning Message by unique persistent id
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getMessage

        -
        Message getMessage(String id, - Message.Severity severity, - Object... args) - throws NoSuchElementException
        -
        Retrieve Message by unique persistent id and format with the given - arguments
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        severity - the the severity of the message
        -
        args - the arguments to be used in formatting the message
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getError

        -
        Message getError(String id, - Object... args) - throws NoSuchElementException
        -
        Retrieve error Message by unique persistent id and format with the given - arguments
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        args - the arguments to be used in formatting the message
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getFatal

        -
        Message getFatal(String id, - Object... args) - throws NoSuchElementException
        -
        Retrieve error Message by unique persistent id and format with the given - arguments
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        args - the arguments to be used in formatting the message
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getInfo

        -
        Message getInfo(String id, - Object... args) - throws NoSuchElementException
        -
        Retrieve info Message by unique persistent id and format with the given - arguments
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        args - the arguments to be used in formatting the message
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      • -
        -

        getWarning

        -
        Message getWarning(String id, - Object... args) - throws NoSuchElementException
        -
        Retrieve warning Message by unique persistent id and format with the given - arguments
        -
        -
        Parameters:
        -
        id - the id of the message to be retrieved
        -
        args - the arguments to be used in formatting the message
        -
        Returns:
        -
        the message with persistent id equal to id
        -
        Throws:
        -
        NoSuchElementException - if no message with id can be retrieved
        -
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/MessageLog.html b/docs/site/apidocs/org/openpreservation/messages/MessageLog.html deleted file mode 100644 index cb82d6f0..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/MessageLog.html +++ /dev/null @@ -1,321 +0,0 @@ - - - - -MessageLog (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.messages
    -

    Interface MessageLog

    -
    -
    -
    -
    public interface MessageLog
    -
    Interface for a log of Message objects.
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        size

        -
        int size()
        -
        Get the number of messages in the log.
        -
        -
        Returns:
        -
        the int number of messages in the log
        -
        -
        -
        • -
      • -
        -

        isEmpty

        -
        boolean isEmpty()
        -
        Is the log empty?
        -
        -
        Returns:
        -
        true if the log is empty, false otherwise
        -
        -
        -
        • -
      • -
        -

        add

        -
        int add(String path, - Message message)
        -
        Add a Message to the log for a particular path.
        -
        -
        Parameters:
        -
        path - the String path for the message
        -
        message - the Message to be added
        -
        Returns:
        -
        the int number of messages in the log
        -
        -
        -
        • -
      • -
        -

        add

        -
        int add(String path, - Collection<? extends Message> messages)
        -
        Add a Collection of Messages to the log for a particular path.
        -
        -
        Parameters:
        -
        path - the String path for the message
        -
        messages - the Collection of Messages to be added
        -
        Returns:
        -
        the int number of messages in the log
        -
        -
        -
        • -
      • -
        -

        add

        -
        int add(Map<String,List<Message>> messages)
        -
        -
        • -
      • -
        -

        getErrors

        -
        Map<String,List<Message>> getErrors()
        -
        -
        • -
      • -
        -

        getWarnings

        -
        Map<String,List<Message>> getWarnings()
        -
        -
        • -
      • -
        -

        getInfos

        -
        Map<String,List<Message>> getInfos()
        -
        -
        • -
      • -
        -

        getMessages

        -
        Map<String,List<Message>> getMessages()
        -
        -
        • -
      • -
        -

        getMessagesBySeverity

        -
        Map<String,List<Message>> getMessagesBySeverity(Message.Severity severity)
        -
        -
        • -
      • -
        -

        getMessagesById

        -
        Map<String,List<Message>> getMessagesById(String id)
        -
        -
        • -
      • -
        -

        getMessagesForPath

        -
        List<Message> getMessagesForPath(String path)
        -
        -
        • -
      • -
        -

        hasErrors

        -
        boolean hasErrors()
        -
        -
        • -
      • -
        -

        hasWarnings

        -
        boolean hasWarnings()
        -
        -
        • -
      • -
        -

        hasInfos

        -
        boolean hasInfos()
        -
        -
        • -
      • -
        -

        getErrorCount

        -
        int getErrorCount()
        -
        -
        • -
      • -
        -

        getWarningCount

        -
        int getWarningCount()
        -
        -
        • -
      • -
        -

        getInfoCount

        -
        int getInfoCount()
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/Messages.html b/docs/site/apidocs/org/openpreservation/messages/Messages.html deleted file mode 100644 index 471bb6e4..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/Messages.html +++ /dev/null @@ -1,465 +0,0 @@ - - - - -Messages (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.messages
    -

    Enum Class Messages

    -
    -
    java.lang.Object -
    java.lang.Enum<Messages> -
    org.openpreservation.messages.Messages
    -
    -
    -
    -
    -
    All Implemented Interfaces:
    -
    Serializable, Comparable<Messages>, java.lang.constant.Constable
    -
    -
    -
    public enum Messages -extends Enum<Messages>
    -
    Utility class that handles creation of Message type instances, etc.
    -
    -
    Author:
    -
    Carl Wilson - carlwilson AT github
    -
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Enum Constant Details

      -
        -
      • -
        -

        INSTANCE

        -
        public static final Messages INSTANCE
        -
        Ensure Messages is a singleton
        -
        -
        • -
      -
      -
      • - -
    • -
      -

      Field Details

      - -
      -
      • - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        values

        -
        public static Messages[] values()
        -
        Returns an array containing the constants of this enum class, in -the order they are declared.
        -
        -
        Returns:
        -
        an array containing the constants of this enum class, in the order they are declared
        -
        -
        -
        • -
      • -
        -

        valueOf

        -
        public static Messages valueOf(String name)
        -
        Returns the enum constant of this class with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum class has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        -
        • -
      • -
        -

        getMessageInstance

        -
        public static Message getMessageInstance(String message) - throws IllegalArgumentException
        -
        Create a new message instance with a DEFAULT_ID
        -
        -
        Parameters:
        -
        message - the message of the new message
        -
        Returns:
        -
        the new message instance
        -
        Throws:
        -
        IllegalArgumentException - if the id or message is null or empty
        -
        -
        -
        • -
      • -
        -

        getMessageInstance

        -
        public static Message getMessageInstance(String id, - Message.Severity severity, - String message) - throws IllegalArgumentException
        -
        Create a Message instance with the give id and message value
        -
        -
        Parameters:
        -
        id - the id of the new message
        -
        message - the message of the new message
        -
        Returns:
        -
        the new message instance
        -
        Throws:
        -
        IllegalArgumentException - if the id or message is null or empty
        -
        -
        -
        • -
      • -
        -

        getMessageInstance

        -
        public static Message getMessageInstance(String id, - Message.Severity severity, - String message, - String subMessage) - throws IllegalArgumentException
        -
        Create a new Message instance with the given id, message and - sub-message
        -
        -
        Parameters:
        -
        id - the id of the new message
        -
        message - the message of the new message
        -
        subMessage - the sub-message of the new message
        -
        Returns:
        -
        the new message instance
        -
        Throws:
        -
        IllegalArgumentException - if the id or message is null or empty
        -
        -
        -
        • -
      • -
        -

        getInstance

        -
        public static MessageFactory getInstance() - throws IllegalArgumentException
        -
        Get a MessageFactory instance with the default property based - bundle name and the default user locale
        -
        -
        Returns:
        -
        a new MessageFactory instance backed by the bundle property - file.
        -
        Throws:
        -
        IllegalArgumentException - if the bundle name is empty or the message - bundle can't be - located
        -
        -
        -
        • -
      • -
        -

        getInstance

        -
        public static MessageFactory getInstance(String bundleName) - throws IllegalArgumentException
        -
        Get a MessageFactory instance with the requested property based - bundle name and the default user locale
        -
        -
        Parameters:
        -
        bundleName - the fully qualified resource path for the message bundle - property file
        -
        Returns:
        -
        a new MessageFactory instance backed by the bundle property - file.
        -
        Throws:
        -
        IllegalArgumentException - if the bundle name is empty or the message - bundle can't be - located
        -
        -
        -
        • -
      • -
        -

        getInstance

        -
        public static MessageFactory getInstance(String bundleName, - Locale locale) - throws IllegalArgumentException
        -
        Get a MessageFactory instance with the requested property based - bundle name and a specific locale
        -
        -
        Parameters:
        -
        bundleName - the fully qualified resource path for the message bundle - property file
        -
        locale - the locale for the message bundle
        -
        Returns:
        -
        a new MessageFactory instance backed by the bundle property - file.
        -
        Throws:
        -
        IllegalArgumentException - if the bundle name is empty or the message - bundle can't be - located
        -
        -
        -
        • -
      • -
        -

        messageLogInstance

        -
        public static MessageLog messageLogInstance()
        -
        -
        • -
      • -
        -

        messageLogInstance

        -
        public static MessageLog messageLogInstance(String path, - List<Message> messages)
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/class-use/Message.Severity.html b/docs/site/apidocs/org/openpreservation/messages/class-use/Message.Severity.html deleted file mode 100644 index 308e6aae..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/class-use/Message.Severity.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - -Uses of Enum Class org.openpreservation.messages.Message.Severity (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Enum Class
    org.openpreservation.messages.Message.Severity

    -
    -
    Packages that use Message.Severity
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.messages
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/class-use/Message.html b/docs/site/apidocs/org/openpreservation/messages/class-use/Message.html deleted file mode 100644 index 277f7991..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/class-use/Message.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - -Uses of Interface org.openpreservation.messages.Message (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Interface
    org.openpreservation.messages.Message

    -
    -
    Packages that use Message
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.messages
    -
     
    -
    org.openpreservation.odf.apps
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/class-use/MessageFactory.html b/docs/site/apidocs/org/openpreservation/messages/class-use/MessageFactory.html deleted file mode 100644 index 82dff06c..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/class-use/MessageFactory.html +++ /dev/null @@ -1,103 +0,0 @@ - - - - -Uses of Interface org.openpreservation.messages.MessageFactory (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Interface
    org.openpreservation.messages.MessageFactory

    -
    -
    Packages that use MessageFactory
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.messages
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/class-use/MessageLog.html b/docs/site/apidocs/org/openpreservation/messages/class-use/MessageLog.html deleted file mode 100644 index f288534d..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/class-use/MessageLog.html +++ /dev/null @@ -1,138 +0,0 @@ - - - - -Uses of Interface org.openpreservation.messages.MessageLog (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Interface
    org.openpreservation.messages.MessageLog

    -
    -
    Packages that use MessageLog
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.messages
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/class-use/Messages.html b/docs/site/apidocs/org/openpreservation/messages/class-use/Messages.html deleted file mode 100644 index 37e67937..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/class-use/Messages.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - -Uses of Enum Class org.openpreservation.messages.Messages (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Enum Class
    org.openpreservation.messages.Messages

    -
    -
    Packages that use Messages
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.messages
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/package-summary.html b/docs/site/apidocs/org/openpreservation/messages/package-summary.html deleted file mode 100644 index f366259c..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/package-summary.html +++ /dev/null @@ -1,111 +0,0 @@ - - - - -org.openpreservation.messages (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Package org.openpreservation.messages

    -
    -
    -
    package org.openpreservation.messages
    -
    -
      -
    • -
      -
      -
      -
      -
      Class
      -
      Description
      -
      Message
      -
      -
      Defines behaviour of validation messages.
      -
      -
      Message.Severity
      -
      -
      An enum set that defines the severity of a message.
      -
      -
      MessageFactory
      -
      -
      Factory interface for Message creation
      -
      -
      MessageLog
      -
      -
      Interface for a log of Message objects.
      -
      -
      Messages
      -
      -
      Utility class that handles creation of Message type instances, etc.
      -
      -
      -
      -
      -
      • -
    -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/package-tree.html b/docs/site/apidocs/org/openpreservation/messages/package-tree.html deleted file mode 100644 index 30055c8f..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/package-tree.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - -org.openpreservation.messages Class Hierarchy (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Hierarchy For Package org.openpreservation.messages

    -Package Hierarchies: - -
    -
    -

    Interface Hierarchy

    - -
    -
    -

    Enum Class Hierarchy

    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/messages/package-use.html b/docs/site/apidocs/org/openpreservation/messages/package-use.html deleted file mode 100644 index 56d4137c..00000000 --- a/docs/site/apidocs/org/openpreservation/messages/package-use.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - -Uses of Package org.openpreservation.messages (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Package
    org.openpreservation.messages

    -
    -
    Packages that use org.openpreservation.messages
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.messages
    -
     
    -
    org.openpreservation.odf.apps
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/Source.html b/docs/site/apidocs/org/openpreservation/odf/Source.html index 914654a7..28685592 100644 --- a/docs/site/apidocs/org/openpreservation/odf/Source.html +++ b/docs/site/apidocs/org/openpreservation/odf/Source.html @@ -1,272 +1,442 @@ + - -Source (ODF spreadsheet validator. 0.18.5 API) - + +Source (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf
    -

    Class Source

    -
    -
    java.lang.Object -
    org.openpreservation.odf.Source
    +
    Package org.openpreservation.odf
    +

    Class Source

    -
    +
    + +
    +
      +
    • -
      public class Source -extends Object
      +
      public class Source
+extends Object
      Represents a source file or stream to be processed.
      -
    -
    -
    - +
    +
      +
    • + +
      + +
      -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      static Source
      -
      from(Path path)
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Field Details

        -
          -
        • -
          -

          path

          -
          public final Path path
          -
          +
          +
            +
          • + + +

            Field Detail

            + + + +
              +
            • +

              path

              +
              public final Path path
              • -
            • -
              -

              detectedFormat

              -
              public final Formats detectedFormat
              -
              +
            + + + +
              +
            • +

              detectedFormat

              +
              public final Formats detectedFormat
            -
          • +
        +
        -
      • -
        -

        Method Details

        -
          -
        • -
          -

          from

          -
          public static Source from(Path path) - throws IOException
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              from

              +
              public static Source from​(Path path)
+                   throws IOException
              Create a new source from a Path
              -
              -
              Parameters:
              +
              +
              Parameters:
              path - the path to open as a source
              -
              Returns:
              +
              Returns:
              a new Source instance created from the path
              -
              Throws:
              -
              IOException - when there is an issue reading the path
              +
              Throws:
              +
              IOException - when there is an issue reading the path
              -
          • -
        • -
          -

          isZip

          -
          public static final boolean isZip(Path toCheck) - throws IOException
          +
        + + + +
          +
        • +

          isZip

          +
          public static final boolean isZip​(Path toCheck)
+                           throws IOException
          Uses the FormatSniffer to see if the supplied path resolves to a ZIP instance. This check only tests the file header bytes and doesn't parse the resolved path to ensure the zip is valid. See isValidZip(Path) for that.
          -
          -
          Parameters:
          +
          +
          Parameters:
          toCheck - a Path to sniff as a zip file
          -
          Returns:
          +
          Returns:
          true if the supplied path has a zip signature, false otherwise.
          -
          Throws:
          -
          IOException - if there's an issue reading the resolved +
          Throws:
          +
          IOException - if there's an issue reading the resolved Path
          -
        • -
      • -
        -

        isValidZip

        -
        public static final boolean isValidZip(Path toCheck) - throws IOException
        +
      + + + +
        +
      • +

        isValidZip

        +
        public static final boolean isValidZip​(Path toCheck)
+                                throws IOException
        Check if the supplied Path resolves to a valid zip archive instance. This is a full library parse of the resolved Path.
        -
        -
        Parameters:
        +
        +
        Parameters:
        toCheck - a Path to resolve and test
        -
        Returns:
        +
        Returns:
        true if the supplied path resolves to a valid zip file, else false.
        -
        Throws:
        -
        IOException - if there's an issue reading the resolved Path
        +
        Throws:
        +
        IOException - if there's an issue reading the resolved Path
        -
      • -
    • -
      -

      isXml

      -
      public static final boolean isXml(Path toCheck) - throws IOException
      +
    + + + +
      +
    • +

      isXml

      +
      public static final boolean isXml​(Path toCheck)
+                           throws IOException
      Determines whether the supplied path is an XML document or not.
      -
      -
      Parameters:
      +
      +
      Parameters:
      toCheck - a Java Path for the file to check
      -
      Returns:
      +
      Returns:
      true if the supplied path is an XML document, false otherwise.
      -
      Throws:
      -
      IOException - when there is an error reading the file.
      +
      Throws:
      +
      IOException - when there is an error reading the file.
      -
      • -
    • -
      -

      getOpenDocument

      -
      public OpenDocument getOpenDocument()
      -
      +
    + + + +
      +
    • +

      getOpenDocument

      +
      public OpenDocument getOpenDocument()
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/BuildVersionProvider.html b/docs/site/apidocs/org/openpreservation/odf/apps/BuildVersionProvider.html index 99fe5a01..d8945e6e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/BuildVersionProvider.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/BuildVersionProvider.html @@ -1,194 +1,344 @@ + - -BuildVersionProvider (ODF spreadsheet validator. 0.18.5 API) - + +BuildVersionProvider (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.apps
    -

    Class BuildVersionProvider

    +
    Package org.openpreservation.odf.apps
    +

    Class BuildVersionProvider

    -
    java.lang.Object -
    org.openpreservation.odf.apps.BuildVersionProvider
    -
    -
    -
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.openpreservation.odf.apps.BuildVersionProvider
        • +
      +
      • +
    +
    +
      +
    • +
      All Implemented Interfaces:
      picocli.CommandLine.IVersionProvider
      -
      public class BuildVersionProvider -extends Object -implements picocli.CommandLine.IVersionProvider
      +
      public class BuildVersionProvider
+extends Object
+implements picocli.CommandLine.IVersionProvider
      A version provider that reads build version information from a properties resource. This resource file is generated during the build process. If the resource cannot be found or read, an IllegalStateException is thrown.
      -
    -
    -
      - -
    • -
      -

      Constructor Summary

      -
      Constructors
      -
      -
      Constructor
      -
      Description
      -
      BuildVersionProvider()
      -
       
      +
      • +
    - +
    + - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/ConsoleFormatter.html b/docs/site/apidocs/org/openpreservation/odf/apps/ConsoleFormatter.html index f6a34352..98a5bc2b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/ConsoleFormatter.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/ConsoleFormatter.html @@ -1,427 +1,639 @@ + - -ConsoleFormatter (ODF spreadsheet validator. 0.18.5 API) - + +ConsoleFormatter (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.apps
    -

    Enum Class ConsoleFormatter

    -
    -
    java.lang.Object -
    java.lang.Enum<ConsoleFormatter> -
    org.openpreservation.odf.apps.ConsoleFormatter
    +
    Package org.openpreservation.odf.apps
    +

    Enum ConsoleFormatter

    -
    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      +
      public enum ConsoleFormatter
+extends Enum<ConsoleFormatter>
      • - -
    • -
      -

      Enum Constant Summary

      -
      Enum Constants
      -
      -
      Enum Constant
      -
      Description
      -
      INSTANCE
      -
       
      +
    - +
    + + + + + + + + + + + + + - + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static ConsoleFormatter[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ConsoleFormatter[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ConsoleFormatter c : ConsoleFormatter.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static ConsoleFormatter valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static ConsoleFormatter valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    error

    -
    public static final void error(String message)
    -
    + + + + +
      +
    • +

      error

      +
      public static final void error​(String message)
      • -
    • -
      -

      info

      -
      public static final void info(String message)
      -
      +
    + + + +
      +
    • +

      info

      +
      public static final void info​(String message)
      • -
    • -
      -

      warn

      -
      public static final void warn(String message)
      -
      +
    + + + +
      +
    • +

      warn

      +
      public static final void warn​(String message)
      • -
    • -
      -

      colourise

      -
      public static final void colourise(String message, - String colour)
      -
      +
    + + + +
      +
    • +

      colourise

      +
      public static final void colourise​(String message,
+                                   String colour)
      • -
    • -
      -

      newline

      -
      public static final void newline()
      -
      +
    + + + +
      +
    • +

      newline

      +
      public static final void newline()
      • -
    • -
      -

      colourise

      -
      public static final void colourise(Message message)
      -
      +
    + + + +
      +
    • +

      colourise

      +
      public static final void colourise​(Message message)
      • -
    • -
      -

      colourise

      -
      public static final void colourise(Path path, - Message message)
      -
      +
    + + + +
      +
    • +

      colourise

      +
      public static final void colourise​(Path path,
+                                   Message message)
      • -
    • -
      -

      colourise

      -
      public static final void colourise(Message message, - String colour)
      -
      +
    + + + +
      +
    • +

      colourise

      +
      public static final void colourise​(Message message,
+                                   String colour)
      • -
    • -
      -

      colourise

      -
      public static final void colourise(Path path, - Message message, - String colour)
      -
      +
    + + + +
      +
    • +

      colourise

      +
      public static final void colourise​(Path path,
+                                   Message message,
+                                   String colour)
    -
    • - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/DebugInfo.html b/docs/site/apidocs/org/openpreservation/odf/apps/DebugInfo.html index 10f8b815..9f2951e1 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/DebugInfo.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/DebugInfo.html @@ -1,160 +1,297 @@ + - -DebugInfo (ODF spreadsheet validator. 0.18.5 API) - + +DebugInfo (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.apps
    -

    Class DebugInfo

    -
    -
    java.lang.Object -
    org.openpreservation.odf.apps.DebugInfo
    +
    Package org.openpreservation.odf.apps
    +

    Class DebugInfo

    -
    +
    + +
    +
      +
    • -
      public final class DebugInfo -extends Object
      -
    -
    -
      +
      public final class DebugInfo
+extends Object
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      static final DebugInfo
      -
      create(boolean debugFlag, - boolean[] verbosity)
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          create

          -
          public static final DebugInfo create(boolean debugFlag, - boolean[] verbosity)
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              create

              +
              public static final DebugInfo create​(boolean debugFlag,
+                                     boolean[] verbosity)
              Static factory method to create a DebugInfo instance.
              -
              -
              Parameters:
              +
              +
              Parameters:
              debugFlag - whether debug output is enabled or not, set true to enable
              verbosity - a boolean array representing verbosity levels, the greater the length the more verbose
              -
              Returns:
              +
              Returns:
              a new DebugInfo instance
              -
          • -
        • -
          -

          outputDebugInfo

          -
          public void outputDebugInfo()
          +
        + + + +
          +
        • +

          outputDebugInfo

          +
          public void outputDebugInfo()
          Output debug information to the console if debugFlag is set.
          -
      -
    - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/FormatsConverter.html b/docs/site/apidocs/org/openpreservation/odf/apps/FormatsConverter.html new file mode 100644 index 00000000..75596515 --- /dev/null +++ b/docs/site/apidocs/org/openpreservation/odf/apps/FormatsConverter.html @@ -0,0 +1,320 @@ + + + + + +FormatsConverter (ODF Document validator. 0.20-alpha-2 API) + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package org.openpreservation.odf.apps
    +

    Class FormatsConverter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      picocli.CommandLine.ITypeConverter<Formats>
      +
      +
      +
      public class FormatsConverter
+extends Object
+implements picocli.CommandLine.ITypeConverter<Formats>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FormatsConverter

          +
          public FormatsConverter()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/BuildVersionProvider.html b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/BuildVersionProvider.html index 5af80498..8149abf3 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/BuildVersionProvider.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/BuildVersionProvider.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.apps.BuildVersionProvider (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.apps.BuildVersionProvider (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.apps.BuildVersionProvider

    +

    Uses of Class
    org.openpreservation.odf.apps.BuildVersionProvider

    -No usage of org.openpreservation.odf.apps.BuildVersionProvider
    +
    No usage of org.openpreservation.odf.apps.BuildVersionProvider
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/ConsoleFormatter.html b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/ConsoleFormatter.html index c88f8065..812680a2 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/ConsoleFormatter.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/ConsoleFormatter.html @@ -1,95 +1,204 @@ + - -Uses of Enum Class org.openpreservation.odf.apps.ConsoleFormatter (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.apps.ConsoleFormatter (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.apps.ConsoleFormatter

    +

    Uses of Class
    org.openpreservation.odf.apps.ConsoleFormatter

    -
    Packages that use ConsoleFormatter
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.apps
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/DebugInfo.html b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/DebugInfo.html index 7e9606ee..54a8f61c 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/DebugInfo.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/DebugInfo.html @@ -1,90 +1,197 @@ + - -Uses of Class org.openpreservation.odf.apps.DebugInfo (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.apps.DebugInfo (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.apps.DebugInfo

    +

    Uses of Class
    org.openpreservation.odf.apps.DebugInfo

    -
    Packages that use DebugInfo
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.apps
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/class-use/FormatsConverter.html b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/FormatsConverter.html new file mode 100644 index 00000000..70fd7f25 --- /dev/null +++ b/docs/site/apidocs/org/openpreservation/odf/apps/class-use/FormatsConverter.html @@ -0,0 +1,150 @@ + + + + + +Uses of Class org.openpreservation.odf.apps.FormatsConverter (ODF Document validator. 0.20-alpha-2 API) + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.openpreservation.odf.apps.FormatsConverter

    +
    +
    No usage of org.openpreservation.odf.apps.FormatsConverter
    +
    + + + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/apps/package-summary.html index 146cdf90..cd49ef84 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/package-summary.html @@ -1,123 +1,194 @@ + - -org.openpreservation.odf.apps (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.apps (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.apps

    -
    -
    -
    package org.openpreservation.odf.apps
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/apps/package-tree.html index 157cd20d..e28e7f24 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/package-tree.html @@ -1,91 +1,181 @@ + - -org.openpreservation.odf.apps Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.apps Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.apps

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/package-use.html b/docs/site/apidocs/org/openpreservation/odf/apps/package-use.html index 94314959..3a4aeefb 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/package-use.html @@ -1,86 +1,189 @@ + - -Uses of Package org.openpreservation.odf.apps (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.apps (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.apps

    -
    Packages that use org.openpreservation.odf.apps
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.apps
    -
     
    -
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-summary.html index 3d2ba54c..d55389b2 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-summary.html @@ -1,87 +1,149 @@ + - -org.openpreservation.odf.apps.pkg (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.apps.pkg (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.apps.pkg

    -
    -
    -
    package org.openpreservation.odf.apps.pkg
    -
    - -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-tree.html index 1ce9ecaf..c8a0e4f0 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-tree.html @@ -1,66 +1,153 @@ + - -org.openpreservation.odf.apps.pkg Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.apps.pkg Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.apps.pkg

    -Package Hierarchies: +Package Hierarchies:
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-use.html b/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-use.html index fa6925c6..8dc51a8c 100644 --- a/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/apps/pkg/package-use.html @@ -1,62 +1,150 @@ + - -Uses of Package org.openpreservation.odf.apps.pkg (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.apps.pkg (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.apps.pkg

    -No usage of org.openpreservation.odf.apps.pkg
    +
    No usage of org.openpreservation.odf.apps.pkg
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/class-use/Source.html b/docs/site/apidocs/org/openpreservation/odf/class-use/Source.html index 4b8baf3f..32b4e78a 100644 --- a/docs/site/apidocs/org/openpreservation/odf/class-use/Source.html +++ b/docs/site/apidocs/org/openpreservation/odf/class-use/Source.html @@ -1,89 +1,196 @@ + - -Uses of Class org.openpreservation.odf.Source (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.Source (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.Source

    +

    Uses of Class
    org.openpreservation.odf.Source

    -
    Packages that use Source
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/Documents.html b/docs/site/apidocs/org/openpreservation/odf/document/Documents.html index 48fb054b..7c4b6a97 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/Documents.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/Documents.html @@ -1,222 +1,389 @@ + - -Documents (ODF spreadsheet validator. 0.18.5 API) - + +Documents (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.document
    -

    Class Documents

    -
    -
    java.lang.Object -
    org.openpreservation.odf.document.Documents
    +
    Package org.openpreservation.odf.document
    +

    Class Documents

    -
    -
    -
    public class Documents -extends Object
    -
    -
    -
    +
    +
    +
    + + + + + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/FileType.html b/docs/site/apidocs/org/openpreservation/odf/document/FileType.html index c6aa0fb9..e905d529 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/FileType.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/FileType.html @@ -1,229 +1,387 @@ + - -FileType (ODF spreadsheet validator. 0.18.5 API) - + +FileType (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.document
    -

    Enum Class FileType

    -
    -
    java.lang.Object -
    java.lang.Enum<FileType> -
    org.openpreservation.odf.document.FileType
    -
    +
    Package org.openpreservation.odf.document
    +

    Enum FileType

    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • +
    +
    +
    + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static FileType[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static FileType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (FileType c : FileType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static FileType valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static FileType valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/OdfDocument.html b/docs/site/apidocs/org/openpreservation/odf/document/OdfDocument.html index a285f561..763e540b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/OdfDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/OdfDocument.html @@ -1,193 +1,331 @@ + - -OdfDocument (ODF spreadsheet validator. 0.18.5 API) - + +OdfDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.document
    -

    Interface OdfDocument

    +
    Package org.openpreservation.odf.document
    +

    Interface OdfDocument

    -
    -
    +
    +
    +
    -
    -
      +
      public interface OdfDocument
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      DocumentType
      -
      getDocumentType()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getVersion

          -
          Version getVersion()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getVersion

              +
              Version getVersion()
              Gets the version of the ODF document
              -
              -
              Returns:
              +
              +
              Returns:
              the ODF document version
              -
          • -
        • -
          -

          getDocumentType

          -
          DocumentType getDocumentType()
          +
        + + + +
          +
        • +

          getDocumentType

          +
          DocumentType getDocumentType()
          Gets the parsed type of the ODF document.
          -
          -
          Returns:
          +
          +
          Returns:
          -
        • -
      • -
        -

        getXmlDocument

        -
        OdfXmlDocument getXmlDocument()
        +
      + + + +
        +
      • +

        getXmlDocument

        +
        OdfXmlDocument getXmlDocument()
        Returns the ODF Xml Document instance with the details of the parsed document.
        -
        -
        Returns:
        +
        +
        Returns:
        the ODF Xml Document instance
        -
      • -
    • -
      -

      getMetadata

      -
      Metadata getMetadata()
      +
    + + + +
      +
    • +

      getMetadata

      +
      Metadata getMetadata()
      Gets the Metadata object parsed from the main ODF XML document for single file XML documents or from the meta.xml file for documents parsed from a package.
      -
      -
      Returns:
      +
      +
      Returns:
      the ODF document metadata.
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/OpenDocument.html b/docs/site/apidocs/org/openpreservation/odf/document/OpenDocument.html index 61d211bd..7a5a81d9 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/OpenDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/OpenDocument.html @@ -1,261 +1,419 @@ + - -OpenDocument (ODF spreadsheet validator. 0.18.5 API) - + +OpenDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.document
    -

    Interface OpenDocument

    +
    Package org.openpreservation.odf.document
    +

    Interface OpenDocument

    -
    +
    +
    +
      +
    • -
      public interface OpenDocument
      -
    -
    -
      +
      public interface OpenDocument
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      OdfDocument
      -
      getDocument()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getPath

          -
          Path getPath()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getPath

              +
              Path getPath()
              Get the path to the OpenDocument file.
              -
              -
              Returns:
              +
              +
              Returns:
              the path to the OpenDocument file
              -
          • -
        • -
          -

          getFileType

          -
          FileType getFileType()
          +
        + + + +
          +
        • +

          getFileType

          +
          FileType getFileType()
          Indicates the type of OpenDocument, a zip archive package or a single XML file
          -
          -
          Returns:
          +
          +
          Returns:
          an enumerated FileType valued indicating the type of OpenDocument
          -
        • -
      • -
        -

        isPackage

        -
        boolean isPackage()
        +
      + + + +
        +
      • +

        isPackage

        +
        boolean isPackage()
        Is the OpenDocument an ODF package, i.e. a zip archive
        -
        -
        Returns:
        +
        +
        Returns:
        true if the OpenDocument is a package
        -
      • -
    • -
      -

      getDocument

      -
      OdfDocument getDocument()
      +
    + + + +
      +
    • +

      getDocument

      +
      OdfDocument getDocument()
      Get the main ODF Document details, this will be the only document for a single XML file, a package may have sub-documents
      -
      -
      Returns:
      +
      +
      Returns:
      the main ODF Document for the OpenDocument file
      -
      • -
    • -
      -

      getSubDocuments

      -
      Collection<OdfDocument> getSubDocuments()
      +
    + + + +
      +
    • +

      getSubDocuments

      +
      Collection<OdfDocument> getSubDocuments()
      For and ODF Package get the sub-documents, these will be the documents in the package other than the main document. Single file OpenDocuments return an empty collection.
      -
      -
      Returns:
      +
      +
      Returns:
      the Collection of OdfDocument sub-documents.
      -
      • -
    • -
      -

      getPackage

      -
      OdfPackage getPackage()
      +
    + + + +
      +
    • +

      getPackage

      +
      OdfPackage getPackage()
      Get the ODF Package for the OpenDocument, this will be null for a single XML file.
      -
      -
      Returns:
      +
      +
      Returns:
      the ODF Package for the OpenDocument
      -
      • -
    • -
      -

      getFormat

      -
      Formats getFormat()
      +
    + + + +
      +
    • +

      getFormat

      +
      Formats getFormat()
      Get the format of the OpenDocument, this will be the declared format of the package or the parsed format of a single document.
      -
      -
      Returns:
      +
      +
      Returns:
      the format of the OpenDocument
      -
      • -
    • -
      -

      getVersion

      -
      Version getVersion()
      +
    + + + +
      +
    • +

      getVersion

      +
      Version getVersion()
      Get the version of the OpenDocument.
      -
      -
      Returns:
      +
      +
      Returns:
      the version of the OpenDocument
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/class-use/Documents.html b/docs/site/apidocs/org/openpreservation/odf/document/class-use/Documents.html index d1bc515b..05203e55 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/class-use/Documents.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/class-use/Documents.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.document.Documents (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.document.Documents (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.document.Documents

    +

    Uses of Class
    org.openpreservation.odf.document.Documents

    -No usage of org.openpreservation.odf.document.Documents
    +
    No usage of org.openpreservation.odf.document.Documents
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/class-use/FileType.html b/docs/site/apidocs/org/openpreservation/odf/document/class-use/FileType.html index 29d1fb91..c34ec691 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/class-use/FileType.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/class-use/FileType.html @@ -1,101 +1,212 @@ + - -Uses of Enum Class org.openpreservation.odf.document.FileType (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.document.FileType (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.document.FileType

    +

    Uses of Class
    org.openpreservation.odf.document.FileType

    -
    Packages that use FileType
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/class-use/OdfDocument.html b/docs/site/apidocs/org/openpreservation/odf/document/class-use/OdfDocument.html index 598edb38..a61a1502 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/class-use/OdfDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/class-use/OdfDocument.html @@ -1,145 +1,284 @@ + - -Uses of Interface org.openpreservation.odf.document.OdfDocument (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.document.OdfDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.document.OdfDocument

    -
    -
    Packages that use OdfDocument
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    +

    Uses of Interface
    org.openpreservation.odf.document.OdfDocument

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/class-use/OpenDocument.html b/docs/site/apidocs/org/openpreservation/odf/document/class-use/OpenDocument.html index 4ff522a9..0f3e0a32 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/class-use/OpenDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/class-use/OpenDocument.html @@ -1,160 +1,307 @@ + - -Uses of Interface org.openpreservation.odf.document.OpenDocument (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.document.OpenDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.document.OpenDocument

    -
    -
    Packages that use OpenDocument
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf
    -
     
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/document/package-summary.html index 4b736c1f..87e13780 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/package-summary.html @@ -1,122 +1,204 @@ + - -org.openpreservation.odf.document (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.document (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.document

    -
    -
    -
    package org.openpreservation.odf.document
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/document/package-tree.html index 8fadf6b7..8c067efd 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/package-tree.html @@ -1,97 +1,186 @@ + - -org.openpreservation.odf.document Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.document Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.document

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/document/package-use.html b/docs/site/apidocs/org/openpreservation/odf/document/package-use.html index 269a9232..a5a251d1 100644 --- a/docs/site/apidocs/org/openpreservation/odf/document/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/document/package-use.html @@ -1,142 +1,279 @@ + - -Uses of Package org.openpreservation.odf.document (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.document (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.document

    -
    Packages that use org.openpreservation.odf.document
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf
    -
     
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/Constants.html b/docs/site/apidocs/org/openpreservation/odf/fmt/Constants.html index e5e85a52..b6308ccd 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/Constants.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/Constants.html @@ -1,101 +1,224 @@ + - -Constants (ODF spreadsheet validator. 0.18.5 API) - + +Constants (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.fmt
    -

    Class Constants

    -
    -
    java.lang.Object -
    org.openpreservation.odf.fmt.Constants
    +
    Package org.openpreservation.odf.fmt
    +

    Class Constants

    -
    +
    + +
    +
      +
    • -
      public final class Constants -extends Object
      -
    -
    -
      +
      public final class Constants
+extends Object
      + +
    +
    +
    + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/FormatSniffer.html b/docs/site/apidocs/org/openpreservation/odf/fmt/FormatSniffer.html index 97cdb9c4..dc3b1c46 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/FormatSniffer.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/FormatSniffer.html @@ -1,303 +1,490 @@ + - -FormatSniffer (ODF spreadsheet validator. 0.18.5 API) - + +FormatSniffer (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.fmt
    -

    Class FormatSniffer

    +
    Package org.openpreservation.odf.fmt
    +

    Class FormatSniffer

    -
    java.lang.Object -
    org.openpreservation.odf.fmt.FormatSniffer
    -
    -
    -
    -
    public final class FormatSniffer -extends Object
    -
    -
    -
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/Formats.html b/docs/site/apidocs/org/openpreservation/odf/fmt/Formats.html index cf69fac2..724e4a1f 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/Formats.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/Formats.html @@ -1,640 +1,956 @@ + - -Formats (ODF spreadsheet validator. 0.18.5 API) - + +Formats (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.fmt
    -

    Enum Class Formats

    -
    -
    java.lang.Object -
    java.lang.Enum<Formats> -
    org.openpreservation.odf.fmt.Formats
    +
    Package org.openpreservation.odf.fmt
    +

    Enum Formats

    -
    -
    -
    +
    + +
    +
      +
    • +
      All Implemented Interfaces:
      -
      Serializable, Comparable<Formats>, java.lang.constant.Constable
      +
      Serializable, Comparable<Formats>
      -
      public enum Formats -extends Enum<Formats>
      +
      public enum Formats
+extends Enum<Formats>
      The Formats enum represents the different formats supported by the ODF validator. Each enum constant corresponds to a specific format, defined by its MIME type, file extension, and a set of signatures, for identification.
      -
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • +
    +
    +
    + + + + +
      +
    • +

      ODG

      +
      public static final Formats ODG
      The ODF Graphics format.
      -
      • -
    • -
      -

      ZIP

      -
      public static final Formats ZIP
      +
    + + + +
      +
    • +

      ZIP

      +
      public static final Formats ZIP
      The ZIP format, used for ODF packages.
      -
      • -
    • -
      -

      XML

      -
      public static final Formats XML
      +
    + + + +
      +
    • +

      XML

      +
      public static final Formats XML
      The XML format, used for ODF documents and metadata.
      -
      • -
    • -
      -

      ODB

      -
      public static final Formats ODB
      +
    + + + +
      +
    • +

      ODB

      +
      public static final Formats ODB
      The ODF Database format.
      -
      • -
    • -
      -

      ODC

      -
      public static final Formats ODC
      +
    + + + +
      +
    • +

      ODC

      +
      public static final Formats ODC
      The ODF Chart format.
      -
      • -
    • -
      -

      ODF

      -
      public static final Formats ODF
      +
    + + + +
      +
    • +

      ODF

      +
      public static final Formats ODF
      The ODF Formula format.
      -
      • -
    • -
      -

      ODI

      -
      public static final Formats ODI
      +
    + + + +
      +
    • +

      ODI

      +
      public static final Formats ODI
      The ODF Image format.
      -
      • -
    • -
      -

      ODM

      -
      public static final Formats ODM
      +
    + + + +
      +
    • +

      ODM

      +
      public static final Formats ODM
      The ODF Master Document format.
      -
      • -
    • -
      -

      OTC

      -
      public static final Formats OTC
      +
    + + + +
      +
    • +

      OTC

      +
      public static final Formats OTC
      The ODF Template Chart format.
      -
      • -
    • -
      -

      OTF

      -
      public static final Formats OTF
      +
    + + + +
      +
    • +

      OTF

      +
      public static final Formats OTF
      The ODF Template Formula format.
      -
      • -
    • -
      -

      OTG

      -
      public static final Formats OTG
      +
    + + + +
      +
    • +

      OTG

      +
      public static final Formats OTG
      The ODF Template Graphics format.
      -
      • -
    • -
      -

      OTH

      -
      public static final Formats OTH
      +
    + + + +
      +
    • +

      OTH

      +
      public static final Formats OTH
      The ODF Template HTML format.
      -
      • -
    • -
      -

      OTI

      -
      public static final Formats OTI
      +
    + + + +
      +
    • +

      OTI

      +
      public static final Formats OTI
      The ODF Template Image format.
      -
      • -
    • -
      -

      OTM

      -
      public static final Formats OTM
      +
    + + + +
      +
    • +

      OTM

      +
      public static final Formats OTM
      The ODF Template Master Document format.
      -
      • -
    • -
      -

      OTP

      -
      public static final Formats OTP
      +
    + + + +
      +
    • +

      OTP

      +
      public static final Formats OTP
      The ODF Template Presentation format.
      -
      • -
    • -
      -

      OTS

      -
      public static final Formats OTS
      +
    + + + +
      +
    • +

      OTS

      +
      public static final Formats OTS
      The ODF Template Spreadsheet format.
      -
      • -
    • -
      -

      OTT

      -
      public static final Formats OTT
      +
    + + + +
      +
    • +

      OTT

      +
      public static final Formats OTT
      The ODF Template Text Document format.
      -
      • -
    • -
      -

      UNKNOWN

      -
      public static final Formats UNKNOWN
      +
    + + + +
      +
    • +

      UNKNOWN

      +
      public static final Formats UNKNOWN
      Unknown format.
      -
    - + + -
  • -
    -

    Field Details

    -
      -
    • -
      -

      mime

      -
      public final String mime
      +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          mime

          +
          public final String mime
          The String MIME type identifier
          -
      • -
    • -
      -

      extension

      -
      public final String extension
      +
    + + + +
      +
    • +

      extension

      +
      public final String extension
      The String extension associated with the MIME type
      -
    • - + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Formats[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Formats[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Formats c : Formats.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static Formats valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static Formats valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    identify

    -
    public static Formats identify(byte[] bytes)
    + + + + +
      +
    • +

      identify

      +
      public static Formats identify​(byte[] bytes)
      Identifies the format based on the provided byte array.
      -
      -
      Parameters:
      +
      +
      Parameters:
      bytes - the byte array to identify
      -
      Returns:
      +
      Returns:
      the identified format, or UNKNOWN if no match is found
      -
      Throws:
      -
      NullPointerException - if bytes is null
      +
      Throws:
      +
      NullPointerException - if bytes is null
      -
    • -
  • -
    -

    fromMime

    -
    public static Formats fromMime(String mime)
    + + + + +
      +
    • +

      fromMime

      +
      public static Formats fromMime​(String mime)
      Identifies the format based on the provided MIME type.
      -
      -
      Parameters:
      +
      +
      Parameters:
      mime - the MIME type to identify
      -
      Returns:
      +
      Returns:
      the identified format, or UNKNOWN if no match is found
      -
      Throws:
      -
      NullPointerException - if mime is null
      +
      Throws:
      +
      NullPointerException - if mime is null
      -
    • -
  • -
    -

    fromExtension

    -
    public static Formats fromExtension(String ext)
    + + + + +
      +
    • +

      fromExtension

      +
      public static Formats fromExtension​(String ext)
      Identifies the format based on the provided file extension.
      -
      -
      Parameters:
      +
      +
      Parameters:
      ext - the file extension to identify
      -
      Returns:
      +
      Returns:
      the identified format, or UNKNOWN if no match is found
      -
      Throws:
      -
      NullPointerException - if ext is null
      +
      Throws:
      +
      NullPointerException - if ext is null
      -
    • -
  • -
    -

    isText

    -
    public boolean isText()
    + + + + +
      +
    • +

      isText

      +
      public boolean isText()
      Is the format a text format?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the format is a text format, false otherwise
      -
    • -
  • -
    -

    isPackage

    -
    public boolean isPackage()
    + + + + +
      +
    • +

      isPackage

      +
      public boolean isPackage()
      Is the format a package format?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the format is a package format, false otherwise
      -
    • -
  • -
    -

    isOdf

    -
    public boolean isOdf()
    + + + + +
      +
    • +

      isOdf

      +
      public boolean isOdf()
      Is the format a OpenDocument format?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the format is an OpenDocument format, false otherwise
      -
    • -
  • -
    -

    getSignatureCount

    -
    public int getSignatureCount()
    + + + + +
      +
    • +

      getSignatureCount

      +
      public int getSignatureCount()
      Get the number of signatures for the format.
      -
      -
      Returns:
      +
      +
      Returns:
      the number of signatures for the format
      -
    • -
  • -
    -

    getMaxSignatureLength

    -
    public int getMaxSignatureLength()
    + + + + +
      +
    • +

      getMaxSignatureLength

      +
      public int getMaxSignatureLength()
      Get the maximum length of a signature for the format.
      -
      -
      Returns:
      +
      +
      Returns:
      the maximum length of a signature for the format
      -
    • -
  • -
    -

    getBytes

    -
    public byte[] getBytes()
    + + + + +
      +
    • +

      getBytes

      +
      public byte[] getBytes()
      Get the MIME type as an ASCII encoded byte array.
      -
      -
      Returns:
      +
      +
      Returns:
      the ASCII encoded MIME type id as a byte array
      -
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/OdfFormats.html b/docs/site/apidocs/org/openpreservation/odf/fmt/OdfFormats.html index 4da469e8..a6e2288b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/OdfFormats.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/OdfFormats.html @@ -1,285 +1,466 @@ + - -OdfFormats (ODF spreadsheet validator. 0.18.5 API) - + +OdfFormats (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.fmt
    -

    Class OdfFormats

    +
    Package org.openpreservation.odf.fmt
    +

    Class OdfFormats

    -
    java.lang.Object -
    org.openpreservation.odf.fmt.OdfFormats
    -
    -
    -
    -
    public final class OdfFormats -extends Object
    -
    -
    -
    -
  • -
    -

    isPackage

    -
    public static boolean isPackage(InputStream toTest) - throws IOException
    -
    -
    Throws:
    -
    IOException
    + + + + +
    • -
  • -
    -

    isXml

    -
    public static boolean isXml(String toTest) - throws IOException
    -
    -
    Throws:
    -
    IOException
    + + + + +
    • -
  • -
    -

    isXml

    -
    public static boolean isXml(Path toTest) - throws IOException
    -
    -
    Throws:
    -
    IOException
    + + + + +
    • -
  • -
    -

    isXml

    -
    public static boolean isXml(File toTest) - throws IOException
    -
    -
    Throws:
    -
    IOException
    + + + + +
    • -
  • -
    -

    isXml

    -
    public static boolean isXml(InputStream toTest) - throws IOException
    -
    -
    Throws:
    -
    IOException
    + + + + +
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/Signatures.html b/docs/site/apidocs/org/openpreservation/odf/fmt/Signatures.html index 2007805f..93362cea 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/Signatures.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/Signatures.html @@ -1,695 +1,1046 @@ + - -Signatures (ODF spreadsheet validator. 0.18.5 API) - + +Signatures (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.fmt
    -

    Enum Class Signatures

    -
    -
    java.lang.Object -
    java.lang.Enum<Signatures> -
    org.openpreservation.odf.fmt.Signatures
    +
    Package org.openpreservation.odf.fmt
    +

    Enum Signatures

    -
    -
    -
    +
    + +
    +
    -
    - +
    +
    + + + + +
      +
    • +

      ZIP_SPANNED

      +
      public static final Signatures ZIP_SPANNED
      Signature of a spanned, i.e. multi -file zip.
      -
      • -
    • -
      -

      XML_UTF_8

      -
      public static final Signatures XML_UTF_8
      +
    + + + +
      +
    • +

      XML_UTF_8

      +
      public static final Signatures XML_UTF_8
      XML UTF-8 signature.
      -
      • -
    • -
      -

      XML_UTF_16_LE

      -
      public static final Signatures XML_UTF_16_LE
      +
    + + + +
      +
    • +

      XML_UTF_16_LE

      +
      public static final Signatures XML_UTF_16_LE
      XML UTF-16 Little Endian signature.
      -
      • -
    • -
      -

      XML_UTF_16_BE

      -
      public static final Signatures XML_UTF_16_BE
      +
    + + + +
      +
    • +

      XML_UTF_16_BE

      +
      public static final Signatures XML_UTF_16_BE
      XML UTF-16 Big Endian signature.
      -
      • -
    • -
      -

      XML_UTF_32_LE

      -
      public static final Signatures XML_UTF_32_LE
      +
    + + + +
      +
    • +

      XML_UTF_32_LE

      +
      public static final Signatures XML_UTF_32_LE
      XML UTF-32 Little Endian signature.
      -
      • -
    • -
      -

      XML_UTF_32_BE

      -
      public static final Signatures XML_UTF_32_BE
      +
    + + + +
      +
    • +

      XML_UTF_32_BE

      +
      public static final Signatures XML_UTF_32_BE
      XML UTF-32 Big Endian signature.
      -
      • -
    • -
      -

      ODF_MIME

      -
      public static final Signatures ODF_MIME
      +
    + + + +
      +
    • +

      ODF_MIME

      +
      public static final Signatures ODF_MIME
      Base match of ODF `mimetype` file.
      -
      • -
    • -
      -

      ODB

      -
      public static final Signatures ODB
      +
    + + + +
      +
    • +

      ODB

      +
      public static final Signatures ODB
      ODF Database signature.
      -
      • -
    • -
      -

      ODC

      -
      public static final Signatures ODC
      +
    + + + +
      +
    • +

      ODC

      +
      public static final Signatures ODC
      ODF Chart signature.
      -
      • -
    • -
      -

      ODF

      -
      public static final Signatures ODF
      +
    + + + +
      +
    • +

      ODF

      +
      public static final Signatures ODF
      ODF Formula signature.
      -
      • -
    • -
      -

      ODG

      -
      public static final Signatures ODG
      +
    + + + +
      +
    • +

      ODG

      +
      public static final Signatures ODG
      ODF Graphics signature.
      -
      • -
    • -
      -

      ODI

      -
      public static final Signatures ODI
      +
    + + + +
      +
    • +

      ODI

      +
      public static final Signatures ODI
      ODF Image signature.
      -
      • -
    • -
      -

      ODM

      -
      public static final Signatures ODM
      +
    + + + +
      +
    • +

      ODM

      +
      public static final Signatures ODM
      ODF Master Document signature.
      -
      • -
    • -
      -

      ODP

      -
      public static final Signatures ODP
      +
    + + + +
      +
    • +

      ODP

      +
      public static final Signatures ODP
      ODF Presentation signature.
      -
      • -
    • -
      -

      ODS

      -
      public static final Signatures ODS
      +
    + + + +
      +
    • +

      ODS

      +
      public static final Signatures ODS
      ODF Spreadsheet signature.
      -
      • -
    • -
      -

      ODT

      -
      public static final Signatures ODT
      +
    + + + +
      +
    • +

      ODT

      +
      public static final Signatures ODT
      ODF Text signature.
      -
      • -
    • -
      -

      OTC

      -
      public static final Signatures OTC
      +
    + + + +
      +
    • +

      OTC

      +
      public static final Signatures OTC
      ODF Chart Template signature.
      -
      • -
    • -
      -

      OTF

      -
      public static final Signatures OTF
      +
    + + + +
      +
    • +

      OTF

      +
      public static final Signatures OTF
      ODF Formula Template signature.
      -
      • -
    • -
      -

      OTG

      -
      public static final Signatures OTG
      +
    + + + +
      +
    • +

      OTG

      +
      public static final Signatures OTG
      ODF Graphics Template signature.
      -
      • -
    • -
      -

      OTH

      -
      public static final Signatures OTH
      +
    + + + +
      +
    • +

      OTH

      +
      public static final Signatures OTH
      ODF Text Web signature.
      -
      • -
    • -
      -

      OTI

      -
      public static final Signatures OTI
      +
    + + + +
      +
    • +

      OTI

      +
      public static final Signatures OTI
      ODF Image Template signature.
      -
      • -
    • -
      -

      OTM

      -
      public static final Signatures OTM
      +
    + + + +
      +
    • +

      OTM

      +
      public static final Signatures OTM
      ODF Master Document Template signature.
      -
      • -
    • -
      -

      OTP

      -
      public static final Signatures OTP
      +
    + + + +
      +
    • +

      OTP

      +
      public static final Signatures OTP
      ODF Presentation Template signature.
      -
      • -
    • -
      -

      OTS

      -
      public static final Signatures OTS
      +
    + + + +
      +
    • +

      OTS

      +
      public static final Signatures OTS
      ODF Spreadsheet Template signature.
      -
      • -
    • -
      -

      OTT

      -
      public static final Signatures OTT
      +
    + + + +
      +
    • +

      OTT

      +
      public static final Signatures OTT
      ODF Text Template signature.
      -
    - + + -
  • -
    -

    Field Details

    -
      -
    • -
      -

      MAX_LENGTH

      -
      public static final int MAX_LENGTH
      +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          MAX_LENGTH

          +
          public static final int MAX_LENGTH
          The length of the longest signature.
          -
      • -
    • -
      -

      offset

      -
      public final int offset
      -
      +
    + + + +
      +
    • +

      offset

      +
      public final int offset
    -
    • + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Signatures[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Signatures[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Signatures c : Signatures.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static Signatures valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static Signatures valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    match

    -
    public static Signatures match(byte[] signature)
    + + + + +
      +
    • +

      match

      +
      public static Signatures match​(byte[] signature)
      Match a signature at the start of the given byte array.
      -
      -
      Parameters:
      +
      +
      Parameters:
      signature - the signature to match
      -
      Returns:
      +
      Returns:
      the matching signature, or NOMATCH if no match
      -
    • -
  • -
    -

    match

    -
    public static Signatures match(byte[] bytes, - int offset)
    + + + + +
      +
    • +

      match

      +
      public static Signatures match​(byte[] bytes,
+                               int offset)
      Match a signature at the given offset in the byte array.
      -
      -
      Parameters:
      +
      +
      Parameters:
      bytes - the byte array to match
      offset - the offset in the byte array to start matching
      -
      Returns:
      +
      Returns:
      the matching signature, or NOMATCH if no match
      -
    • -
  • -
    -

    match

    -
    public static Signatures match(byte[] bytes, - int offset, - Collection<Signatures> sigs)
    + + + + +
      +
    • +

      match

      +
      public static Signatures match​(byte[] bytes,
+                               int offset,
+                               Collection<Signatures> sigs)
      Match a signature at the given offset in the byte array, from a given collection of signatures.
      -
      -
      Parameters:
      +
      +
      Parameters:
      bytes - the byte array to search for the signature
      offset - the offset in the byte array to start matching
      sigs - the collection of signatures to match
      -
      Returns:
      +
      Returns:
      the matching signature, or NOMATCH if no match
      -
    • -
  • -
    -

    matchAll

    -
    public static Set<Signatures> matchAll(byte[] signature)
    + + + + +
      +
    • +

      matchAll

      +
      public static Set<Signatures> matchAll​(byte[] signature)
      Find all matching signatures in the given byte array. For example an ODF package will match both ZIP and an ODF signature.
      -
      -
      Parameters:
      +
      +
      Parameters:
      signature - the byte array to search for signatures
      -
      Returns:
      +
      Returns:
      a set of all matching signatures
      -
    • -
  • -
    -

    matchAll

    -
    public static Set<Signatures> matchAll(byte[] bytes, - int offset)
    + + + + +
      +
    • +

      matchAll

      +
      public static Set<Signatures> matchAll​(byte[] bytes,
+                                       int offset)
      Find all matching signatures in the given byte array, starting at the given offset.
      -
      -
      Parameters:
      +
      +
      Parameters:
      bytes - the byte array to search for signatures
      offset - the offset in the byte array to start matching
      -
      Returns:
      +
      Returns:
      a set of all matching signatures
      -
    • -
  • -
    -

    getLength

    -
    public int getLength()
    -
    + + + + +
      +
    • +

      getLength

      +
      public int getLength()
      • -
    • -
      -

      getSignature

      -
      public byte[] getSignature()
      -
      +
    + + + +
      +
    • +

      getSignature

      +
      public byte[] getSignature()
      • -
    • -
      -

      isMatch

      -
      public boolean isMatch(byte[] bytes)
      -
      +
    + + + +
      +
    • +

      isMatch

      +
      public boolean isMatch​(byte[] bytes)
      • -
    • -
      -

      isMatch

      -
      public boolean isMatch(byte[] bytes, - int offset)
      -
      +
    + + + +
      +
    • +

      isMatch

      +
      public boolean isMatch​(byte[] bytes,
+                       int offset)
    -
    • - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/Utils.html b/docs/site/apidocs/org/openpreservation/odf/fmt/Utils.html index 9fe7244f..49cebe7e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/Utils.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/Utils.html @@ -1,101 +1,224 @@ + - -Utils (ODF spreadsheet validator. 0.18.5 API) - + +Utils (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.fmt
    -

    Class Utils

    -
    -
    java.lang.Object -
    org.openpreservation.odf.fmt.Utils
    +
    Package org.openpreservation.odf.fmt
    +

    Class Utils

    -
    +
    + +
    +
      +
    • -
      public final class Utils -extends Object
      -
    -
    -
      +
      public final class Utils
+extends Object
      + +
    +
    +
    + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Constants.html b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Constants.html index 7433a124..4bd045f3 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Constants.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Constants.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.fmt.Constants (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.fmt.Constants (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.fmt.Constants

    +

    Uses of Class
    org.openpreservation.odf.fmt.Constants

    -No usage of org.openpreservation.odf.fmt.Constants
    +
    No usage of org.openpreservation.odf.fmt.Constants
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/FormatSniffer.html b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/FormatSniffer.html index 0e991c71..c6d5e9ce 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/FormatSniffer.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/FormatSniffer.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.fmt.FormatSniffer (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.fmt.FormatSniffer (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.fmt.FormatSniffer

    +

    Uses of Class
    org.openpreservation.odf.fmt.FormatSniffer

    -No usage of org.openpreservation.odf.fmt.FormatSniffer
    +
    No usage of org.openpreservation.odf.fmt.FormatSniffer
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Formats.html b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Formats.html index a755f3cd..ce702c29 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Formats.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Formats.html @@ -1,263 +1,488 @@ + - -Uses of Enum Class org.openpreservation.odf.fmt.Formats (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.fmt.Formats (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.fmt.Formats

    -
    -
    Packages that use Formats
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf
    -
     
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.fmt
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/OdfFormats.html b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/OdfFormats.html index 168c7f94..40240c21 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/OdfFormats.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/OdfFormats.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.fmt.OdfFormats (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.fmt.OdfFormats (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.fmt.OdfFormats

    +

    Uses of Class
    org.openpreservation.odf.fmt.OdfFormats

    -No usage of org.openpreservation.odf.fmt.OdfFormats
    +
    No usage of org.openpreservation.odf.fmt.OdfFormats
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Signatures.html b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Signatures.html index 64380191..c7742f31 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Signatures.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Signatures.html @@ -1,143 +1,272 @@ + - -Uses of Enum Class org.openpreservation.odf.fmt.Signatures (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.fmt.Signatures (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.fmt.Signatures

    +

    Uses of Class
    org.openpreservation.odf.fmt.Signatures

    -
    Packages that use Signatures
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.fmt
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Utils.html b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Utils.html index fa21ba1f..d2f933e5 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Utils.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/class-use/Utils.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.fmt.Utils (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.fmt.Utils (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.fmt.Utils

    +

    Uses of Class
    org.openpreservation.odf.fmt.Utils

    -No usage of org.openpreservation.odf.fmt.Utils
    +
    No usage of org.openpreservation.odf.fmt.Utils
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/fmt/package-summary.html index ea3ed37a..f9311af6 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/package-summary.html @@ -1,126 +1,201 @@ + - -org.openpreservation.odf.fmt (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.fmt (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.fmt

    -
    -
    -
    package org.openpreservation.odf.fmt
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/fmt/package-tree.html index 8fce7ba4..6e291ea7 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/package-tree.html @@ -1,94 +1,183 @@ + - -org.openpreservation.odf.fmt Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.fmt Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.fmt

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/fmt/package-use.html b/docs/site/apidocs/org/openpreservation/odf/fmt/package-use.html index 53fc66f0..661a3b44 100644 --- a/docs/site/apidocs/org/openpreservation/odf/fmt/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/fmt/package-use.html @@ -1,163 +1,329 @@ + - -Uses of Package org.openpreservation.odf.fmt (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.fmt (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.fmt

    -
    Packages that use org.openpreservation.odf.fmt
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf
    -
     
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.fmt
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/package-summary.html index fef6b660..3b134910 100644 --- a/docs/site/apidocs/org/openpreservation/odf/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/package-summary.html @@ -1,110 +1,170 @@ + - -org.openpreservation.odf (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf

    -
    -
    -
    package org.openpreservation.odf
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/package-tree.html index c692b7a6..37591d11 100644 --- a/docs/site/apidocs/org/openpreservation/odf/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/package-tree.html @@ -1,76 +1,165 @@ + - -org.openpreservation.odf Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/package-use.html b/docs/site/apidocs/org/openpreservation/odf/package-use.html index dbbfa26e..746ba108 100644 --- a/docs/site/apidocs/org/openpreservation/odf/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/package-use.html @@ -1,86 +1,187 @@ + - -Uses of Package org.openpreservation.odf (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf

    -
    Packages that use org.openpreservation.odf
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/Constants.html b/docs/site/apidocs/org/openpreservation/odf/pkg/Constants.html index 461192fa..6d122dfa 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/Constants.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/Constants.html @@ -1,338 +1,488 @@ + - -Constants (ODF spreadsheet validator. 0.18.5 API) - + +Constants (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Class Constants

    -
    -
    java.lang.Object -
    org.openpreservation.odf.pkg.Constants
    +
    Package org.openpreservation.odf.pkg
    +

    Class Constants

    -
    -
    -
    public final class Constants -extends Object
    -
    -
    -
    +
    +
    +
    + + + + +
      +
    • +

      ODF_XML

      +
      public static final Set<String> ODF_XML
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/FileEntry.html b/docs/site/apidocs/org/openpreservation/odf/pkg/FileEntry.html index e9a2c03c..ad1b3d98 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/FileEntry.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/FileEntry.html @@ -1,217 +1,365 @@ + - -FileEntry (ODF spreadsheet validator. 0.18.5 API) - + +FileEntry (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Interface FileEntry

    +
    Package org.openpreservation.odf.pkg
    +

    Interface FileEntry

    -
    +
    +
    +
      +
    • -
      public interface FileEntry
      -
    -
    -
      +
      public interface FileEntry
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      String
      -
      getFullPath()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getFullPath

          -
          String getFullPath()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getFullPath

              +
              String getFullPath()
              Get the full internal path of the file entry.
              -
              -
              Returns:
              +
              +
              Returns:
              the entry internal path
              -
          • -
        • -
          -

          getMediaType

          -
          String getMediaType()
          +
        + + + +
          +
        • +

          getMediaType

          +
          String getMediaType()
          Get the declared media type of the file entry.
          -
          -
          Returns:
          +
          +
          Returns:
          the declared media type of the file entry, this may not be a legal MIME identifier
          -
        • -
      • -
        -

        getSize

        -
        long getSize()
        +
      + + + +
        +
      • +

        getSize

        +
        long getSize()
        The size of the file entry in bytes.
        -
        -
        Returns:
        +
        +
        Returns:
        the size of the file entry.
        -
      • -
    • -
      -

      getVersion

      -
      String getVersion()
      +
    + + + +
      +
    • +

      getVersion

      +
      String getVersion()
      Get's the version of the file entry if it's declared.
      -
      -
      Returns:
      +
      +
      Returns:
      the version of the file entry or null if not declared.
      -
      • -
    • -
      -

      isDocument

      -
      boolean isDocument()
      +
    + + + +
      +
    • +

      isDocument

      +
      boolean isDocument()
      Is the file entry a document entry?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the file entry is a document entry, otherwise false.
      -
      • -
    • -
      -

      isEncrypted

      -
      boolean isEncrypted()
      +
    + + + +
      +
    • +

      isEncrypted

      +
      boolean isEncrypted()
      Is the file entry encrypted?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the file entry is encrypted, otherwise false.
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/Manifest.html b/docs/site/apidocs/org/openpreservation/odf/pkg/Manifest.html index 2b56565e..bb51f516 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/Manifest.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/Manifest.html @@ -1,338 +1,491 @@ + - -Manifest (ODF spreadsheet validator. 0.18.5 API) - + +Manifest (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Interface Manifest

    +
    Package org.openpreservation.odf.pkg
    +

    Interface Manifest

    -
    +
    +
    +
      +
    • -
      public interface Manifest
      -
    -
    -
      +
      public interface Manifest
      + +
    +
    +
    + + + + +
      +
    • +

      getRootVersion

      +
      String getRootVersion()
      Get the declared version of the ODF package from the root "/" element.
      -
      -
      Returns:
      +
      +
      Returns:
      the declared version of the ODF package.
      -
      • -
    • -
      -

      getEntryCount

      -
      int getEntryCount()
      +
    + + + +
      +
    • +

      getEntryCount

      +
      int getEntryCount()
      Get the number of entries in the Manifest.
      -
      -
      Returns:
      +
      +
      Returns:
      the numbner of manifest entries.
      -
      • -
    • -
      -

      getEntries

      -
      Set<FileEntry> getEntries()
      +
    + + + +
      +
    • +

      getEntries

      +
      Set<FileEntry> getEntries()
      Get the Set of FileEntry objects in the Manifest.
      -
      -
      Returns:
      +
      +
      Returns:
      the set of file entries.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      FileEntry
      -
      • -
    • -
      -

      getEntriesByMediaType

      -
      Set<FileEntry> getEntriesByMediaType(String mediaType)
      +
    + + + +
      +
    • +

      getEntriesByMediaType

      +
      Set<FileEntry> getEntriesByMediaType​(String mediaType)
      Get the Set of FileEntry objects in the Manifest that have the supplied media type.
      -
      -
      Parameters:
      +
      +
      Parameters:
      mediaType - the media type to filter the entries by.
      -
      Returns:
      +
      Returns:
      the Set of FileEntry objects that have the supplied media type.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      FileEntry
      -
      • -
    • -
      -

      getEncryptedEntries

      -
      Set<FileEntry> getEncryptedEntries()
      +
    + + + +
      +
    • +

      getEncryptedEntries

      +
      Set<FileEntry> getEncryptedEntries()
      Get the Set of FileEntry objects fior all manifest entries with encryption XML data.
      -
      -
      Returns:
      +
      +
      Returns:
      the Set of FileEntry objects that have encryption XML data.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      FileEntry
      -
      • -
    • -
      -

      getEntry

      -
      FileEntry getEntry(String entryName)
      +
    + + + +
      +
    • +

      getEntry

      +
      FileEntry getEntry​(String entryName)
      Get a manifest entry by name
      -
      -
      Parameters:
      +
      +
      Parameters:
      entryName - the name to find the entry by.
      -
      Returns:
      +
      Returns:
      the FileEntry object for the supplied name, or null if not found.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      FileEntry
      -
      • -
    • -
      -

      getEntryMediaType

      -
      String getEntryMediaType(String entryName)
      +
    + + + +
      +
    • +

      getEntryMediaType

      +
      String getEntryMediaType​(String entryName)
      Get a manifest entry media type by name
      -
      -
      Parameters:
      +
      +
      Parameters:
      entryName - the name to find the entry by.
      -
      Returns:
      +
      Returns:
      the FileEntry media type for the supplied name, or null if not found.
      -
      • -
    • -
      -

      getDocumentEntries

      -
      Set<FileEntry> getDocumentEntries()
      +
    + + + +
      +
    • +

      getDocumentEntries

      +
      Set<FileEntry> getDocumentEntries()
      Get the set of FileEntry objects that are documents, i.e. have a media type that is an ODF document.
      -
      -
      Returns:
      +
      +
      Returns:
      the set of FileEntry objects that are documents.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      FileEntry
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackage.html b/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackage.html index 78be96ad..cb09feb7 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackage.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackage.html @@ -1,421 +1,569 @@ + - -OdfPackage (ODF spreadsheet validator. 0.18.5 API) - + +OdfPackage (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Interface OdfPackage

    +
    Package org.openpreservation.odf.pkg
    +

    Interface OdfPackage

    -
    +
    +
    +
      +
    • -
      public interface OdfPackage
      +
      public interface OdfPackage
      An interface defining the behaviour of ODF packages. Most of the methods in this interface concern themselves with the properties of the package needed for validation.
      -
    -
    -
    -
    OdfPackageDocument
    -
    getDocument()
    -
    +
    +
    +
    +
      +
    • -
    • -
      -

      Method Details

      -
        -
      • -
        -

        getName

        -
        String getName()
        +
        +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            getName

            +
            String getName()
            Get the name or identifier of the package, often the path to the file parsed.
            -
            -
            Returns:
            +
            +
            Returns:
            the String name of the package
            -
        • -
      • -
        -

        getDetectedFormat

        -
        Formats getDetectedFormat()
        -
        Get the detected Formats of the package. +
      + + + +
        +
      • +

        getDetectedFormat

        +
        Formats getDetectedFormat()
        +
        Get the detected Formats of the package. This is the format detected by format sniffing and may not be the actual ODF type depending on any mimetype zip entry in the package.
        -
        -
        Returns:
        +
        +
        Returns:
        the detected Formats of the package
        -
      • -
    • -
      -

      getDetectedVersion

      -
      Version getDetectedVersion()
      -
      Get the detected Version of the package.
      -
      +
    + + + +
      +
    • +

      getDetectedVersion

      +
      Version getDetectedVersion()
      +
      Get the detected Version of the package.
      • -
    • -
      -

      isWellFormedZip

      -
      boolean isWellFormedZip()
      +
    + + + +
      +
    • +

      isWellFormedZip

      +
      boolean isWellFormedZip()
      Is the item parsed a well formed ZipArchive.
      -
      -
      Returns:
      +
      +
      Returns:
      true if the package is well formed, otherwise false
      -
      • -
    • -
      -

      getMimeType

      -
      String getMimeType()
      +
    + + + +
      +
    • +

      getMimeType

      +
      String getMimeType()
      Get the declared mimetype of the package. This is the mimetype declared in the mimetype ZipEntry and/or the manifest's root("/") FileEntry. This may differ from the detected format.
      -
      -
      Returns:
      +
      +
      Returns:
      the declared mimetype of the package
      -
      • -
    • -
      -

      hasMimeEntry

      -
      boolean hasMimeEntry()
      +
    + + + +
      +
    • +

      hasMimeEntry

      +
      boolean hasMimeEntry()
      Does the package have a mimetype ZipEntry?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the package has a mimetype ZipEntry, otherwise false
      -
      • -
    • -
      -

      isMimeFirst

      -
      boolean isMimeFirst()
      +
    + + + +
      +
    • +

      isMimeFirst

      +
      boolean isMimeFirst()
      Is the mimetype ZipEntry the first ZipEntry in the package?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the mimetype ZipEntry is the first entry in the package's ZipArchive, otherwise false
      -
      • -
    • -
      -

      hasManifest

      -
      boolean hasManifest()
      +
    + + + +
      +
    • +

      hasManifest

      +
      boolean hasManifest()
      Does the package have a manifest, that is a ZipEntry with the path META-INF/manifest.xml?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the package has a manifest, otherwise false
      -
      • -
    • -
      -

      hasThumbnail

      -
      boolean hasThumbnail()
      +
    + + + +
      +
    • +

      hasThumbnail

      +
      boolean hasThumbnail()
      Does the package have a ZipEntry with the path Thumbnails/thumbnail.png?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the package has a thumbnail preview ZipEntry, otherwise false
      -
      • -
    • -
      -

      getZipArchive

      -
      ZipArchive getZipArchive()
      +
    + + + +
      +
    • +

      getZipArchive

      +
      ZipArchive getZipArchive()
      Returns the details of the underlying ZipArchive for the package.
      -
      -
      Returns:
      +
      +
      Returns:
      the package ZipAchive
      -
      • -
    • -
      -

      getManifest

      -
      Manifest getManifest()
      +
    + + + +
      +
    • +

      getManifest

      +
      Manifest getManifest()
      Get the Manifest object for the package, this is parsed as long as the META-INF/manifest.xml file exists and is a well formed XML document.
      -
      -
      Returns:
      +
      +
      Returns:
      the package Manifest
      -
      • -
    • -
      -

      getEntryXmlStream

      -
      InputStream getEntryXmlStream(String path) - throws IOException
      +
    + + + +
      +
    • +

      getEntryXmlStream

      +
      InputStream getEntryXmlStream​(String path)
+                       throws IOException
      Get the InputStream to any of an identified ODF XML document in the package
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the internal String path to the XML document
      -
      Returns:
      +
      Returns:
      the InputStream to the XML document
      -
      Throws:
      -
      IOException - when there's a problem reading the entry with the +
      Throws:
      +
      IOException - when there's a problem reading the entry with the supplied path
      -
      • -
    • -
      -

      getEntryXmlParseResult

      -
      ParseResult getEntryXmlParseResult(String path)
      +
    + + + +
      +
    • +

      getEntryXmlParseResult

      +
      ParseResult getEntryXmlParseResult​(String path)
      Get the XML ParseResult of and identified ODF XML documents in the package
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the internal String package path to the XML document
      -
      Returns:
      +
      Returns:
      the ParseResult returned from parsing the XML document with the supplied path.
      -
      Throws:
      -
      IOException - when there's a problem reading the entry with the +
      Throws:
      +
      IOException - when there's a problem reading the entry with the supplied path.
      -
      • -
    • -
      -

      getXmlEntryPaths

      -
      List<String> getXmlEntryPaths()
      +
    + + + +
      +
    • +

      getXmlEntryPaths

      +
      List<String> getXmlEntryPaths()
      Get a List paths of the package's identified ODF XML documents. @@ -427,149 +575,234 @@

      getXmlEntryPaths

    • settings.xml
    • manifest.rdf
    -
    -
    Returns:
    +
    +
    Returns:
    a List of all of the String internal paths to the packge ODF XML documents
    - -
  • -
    -

    getXmlEntries

    -
    Set<FileEntry> getXmlEntries()
    + + + + +
      +
    • +

      getXmlEntries

      +
      Set<FileEntry> getXmlEntries()
      Get the Set of FileEntry to all of the identified ODF XML documents in the package. See getXmlEntryPaths() for the list of XML documents.
      -
      -
      Returns:
      +
      +
      Returns:
      a Set of all of the identified ODF XML documents in the package.
      -
    • -
  • -
    -

    getEntryStream

    -
    InputStream getEntryStream(FileEntry entry) - throws IOException
    + + + + +
      +
    • +

      getEntryStream

      +
      InputStream getEntryStream​(FileEntry entry)
+                    throws IOException
      Get the InputStream for any item from the document's Manifest
      -
      -
      Parameters:
      +
      +
      Parameters:
      entry - the Manifest FileEntry to get the InputStream for
      -
      Returns:
      +
      Returns:
      the InputStream for the FileEntry supplied
      -
      Throws:
      -
      IOException - when there's a problem reading the +
      Throws:
      +
      IOException - when there's a problem reading the FileEntry.
      -
    • -
  • -
    -

    getDocument

    -
    OdfPackageDocument getDocument()
    + + + + +
      +
    • +

      getDocument

      +
      OdfPackageDocument getDocument()
      Get the OdfPackageDocument for the package, this is the root document of the ODF Package
      -
      -
      Returns:
      +
      +
      Returns:
      the package's root OdfPackageDocument
      -
    • -
  • -
    -

    getDocumentMap

    -
    Map<String,OdfPackageDocument> getDocumentMap()
    + + + + +
      +
    • +

      getDocumentMap

      +
      Map<String,​OdfPackageDocument> getDocumentMap()
      Get the Map of the package's OdfPackageDocument objects by String path key.
      -
      -
      Returns:
      +
      +
      Returns:
      the Map of OdfPackageDocument Sub-Documents for the package.
      -
    • -
  • -
    -

    getSubDocument

    -
    OdfPackageDocument getSubDocument(String path)
    + + + + +
      +
    • +

      getSubDocument

      +
      OdfPackageDocument getSubDocument​(String path)
      Get an OdfPackageDocument for a sub-document identified by the passed String path.
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the internal String path to the sub-document
      -
      Returns:
      +
      Returns:
      the OdfPackageDocument for the sub-document
      -
    • -
  • -
    -

    getMetaInfMap

    -
    Map<String,ParseResult> getMetaInfMap()
    + + + + +
      +
    • +

      getMetaInfMap

      +
      Map<String,​ParseResult> getMetaInfMap()
      Retrieve the Map of String path keys and ParseResult values for any ZipEntry below the META-INF directory.
      -
      -
      Returns:
      +
      +
      Returns:
      the Map of META-INF String paths and XML ParseResults.
      -
    • -
  • -
    -

    hasDsigEntries

    -
    boolean hasDsigEntries()
    + + + + +
      +
    • +

      hasDsigEntries

      +
      boolean hasDsigEntries()
      Does the META-INF directory or sub-directories contain a ZipeEntry with the term "signatures" in its name.
      -
      -
      Returns:
      +
      +
      Returns:
      true if the package has Digital Signature entries, otherwise false.
      -
    • -
  • -
    -

    isExtended

    -
    boolean isExtended()
    + + + + +
      +
    • +

      isExtended

      +
      boolean isExtended()
      Discover if the file uses any namespaces outside of the ODF specification.
      -
      -
      Returns:
      +
      +
      Returns:
      true if the file uses any namespaces outside of the ODF
      -
    • -
  • -
    -

    isEncrypted

    -
    boolean isEncrypted()
    + + + + +
      +
    • +

      isEncrypted

      +
      boolean isEncrypted()
      Discover if the package had any encrypted entries.
      -
      -
      Returns:
      +
      +
      Returns:
      true if the package has encrypted entries
      -
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackageDocument.html b/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackageDocument.html index 7e31e557..4b251607 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackageDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackageDocument.html @@ -1,179 +1,316 @@ + - -OdfPackageDocument (ODF spreadsheet validator. 0.18.5 API) - + +OdfPackageDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Interface OdfPackageDocument

    +
    Package org.openpreservation.odf.pkg
    +

    Interface OdfPackageDocument

    -
    -
    +
    +
    +
    -
    -
      +
      public interface OdfPackageDocument
+extends OdfDocument
      + +
    +
    +
    + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackages.html b/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackages.html index 683b0b59..7466d989 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackages.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/OdfPackages.html @@ -1,265 +1,361 @@ + - -OdfPackages (ODF spreadsheet validator. 0.18.5 API) - + +OdfPackages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Class OdfPackages

    +
    Package org.openpreservation.odf.pkg
    +

    Class OdfPackages

    -
    java.lang.Object -
    org.openpreservation.odf.pkg.OdfPackages
    -
    -
    +
    + +
    +
      +
    • -
      public final class OdfPackages -extends Object
      +
      public final class OdfPackages
+extends Object
      A static utility class for general ODF package parsing. The class doubles as a lightweight factory as well as providing useful constants and utility methods.
      -
    -
    -
      + +
    +
    +
    + + + + +
      +
    • +

      isOdfXml

      +
      public static final boolean isOdfXml​(String entrypath)
      Check if the passed String path is an ODF specified XML file name. This is the list of ODF specified XML files: @@ -270,26 +366,84 @@

      isOdfXml

    • settings.xml
    • manifest.rdf
    -
    -
    Parameters:
    +
    +
    Parameters:
    entrypath - a String file path to check
    -
    Returns:
    +
    Returns:
    true if entryPath is an ODF specified XML file name, else false.
    - - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.ParseException.html b/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.ParseException.html index 79eb8b5b..bdf82437 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.ParseException.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.ParseException.html @@ -1,173 +1,327 @@ + - -PackageParser.ParseException (ODF spreadsheet validator. 0.18.5 API) - + +PackageParser.ParseException (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Class PackageParser.ParseException

    -
    -
    java.lang.Object -
    java.lang.Throwable -
    java.lang.Exception -
    org.openpreservation.odf.pkg.PackageParser.ParseException
    -
    -
    +
    Package org.openpreservation.odf.pkg
    +

    Class PackageParser.ParseException

    -
    -
    +
    + +
    +
    -
    -
    - +
    +
    +
    +
      +
    • -
    • -
      -

      Constructor Details

      -
        -
      • -
        -

        ParseException

        -
        public ParseException(String message)
        -
        +
        +
          +
        • + + +

          Constructor Detail

          + + + +
            +
          • +

            ParseException

            +
            public ParseException​(String message)
            • -
          • -
            -

            ParseException

            -
            public ParseException(Map<String,String> badEntries)
            -
            +
          + + + +
            +
          • +

            ParseException

            +
            public ParseException​(Map<String,​String> badEntries)
            • -
          • -
            -

            ParseException

            -
            public ParseException(String message, - Throwable cause)
            -
            +
          + + + +
            +
          • +

            ParseException

            +
            public ParseException​(String message,
+                      Throwable cause)
          -
      - +
      • +
    +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.html b/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.html index 80937f06..6b517d4f 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/PackageParser.html @@ -1,200 +1,336 @@ + - -PackageParser (ODF spreadsheet validator. 0.18.5 API) - + +PackageParser (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.pkg
    -

    Interface PackageParser

    +
    Package org.openpreservation.odf.pkg
    +

    Interface PackageParser

    -
    -
    +
    +
    +
      +
    • +
      All Known Subinterfaces:
      ValidatingParser
      -
      public interface PackageParser
      +
      public interface PackageParser
      An interface defining the behaviour of ODF package parsers.
      -
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      Nested Classes
      -
      -
      Modifier and Type
      -
      Interface
      -
      Description
      -
      static class 
      -
      PackageParser.ParseException
      -
       
      +
      • +
    - +
    + - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Constants.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Constants.html index 4e6e2365..af780082 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Constants.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Constants.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.pkg.Constants (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.pkg.Constants (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.pkg.Constants

    +

    Uses of Class
    org.openpreservation.odf.pkg.Constants

    -No usage of org.openpreservation.odf.pkg.Constants
    +
    No usage of org.openpreservation.odf.pkg.Constants
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/FileEntry.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/FileEntry.html index ee482eb0..f119a2b2 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/FileEntry.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/FileEntry.html @@ -1,140 +1,269 @@ + - -Uses of Interface org.openpreservation.odf.pkg.FileEntry (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.pkg.FileEntry (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.pkg.FileEntry

    +

    Uses of Interface
    org.openpreservation.odf.pkg.FileEntry

    -
    Packages that use FileEntry
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.pkg
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Manifest.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Manifest.html index bc16975d..d45a19f8 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Manifest.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/Manifest.html @@ -1,110 +1,227 @@ + - -Uses of Interface org.openpreservation.odf.pkg.Manifest (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.pkg.Manifest (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.pkg.Manifest

    +

    Uses of Interface
    org.openpreservation.odf.pkg.Manifest

    -
    Packages that use Manifest
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackage.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackage.html index e152aa8d..a59e5bac 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackage.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackage.html @@ -1,143 +1,278 @@ + - -Uses of Interface org.openpreservation.odf.pkg.OdfPackage (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.pkg.OdfPackage (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.pkg.OdfPackage

    -
    -
    Packages that use OdfPackage
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    +

    Uses of Interface
    org.openpreservation.odf.pkg.OdfPackage

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackageDocument.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackageDocument.html index 05f60a07..69224bbe 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackageDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackageDocument.html @@ -1,109 +1,224 @@ + - -Uses of Interface org.openpreservation.odf.pkg.OdfPackageDocument (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.pkg.OdfPackageDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.pkg.OdfPackageDocument

    +

    Uses of Interface
    org.openpreservation.odf.pkg.OdfPackageDocument

    -
    Packages that use OdfPackageDocument
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.pkg
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackages.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackages.html index 89b58f39..dc20437d 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackages.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/OdfPackages.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.pkg.OdfPackages (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.pkg.OdfPackages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.pkg.OdfPackages

    +

    Uses of Class
    org.openpreservation.odf.pkg.OdfPackages

    -No usage of org.openpreservation.odf.pkg.OdfPackages
    +
    No usage of org.openpreservation.odf.pkg.OdfPackages
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.ParseException.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.ParseException.html index 1d6edc6b..d09fba17 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.ParseException.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.ParseException.html @@ -1,177 +1,330 @@ + - -Uses of Class org.openpreservation.odf.pkg.PackageParser.ParseException (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.pkg.PackageParser.ParseException (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.pkg.PackageParser.ParseException

    -
    -
    Packages that use PackageParser.ParseException
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.html b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.html index fc757602..6185b9b5 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/class-use/PackageParser.html @@ -1,105 +1,222 @@ + - -Uses of Interface org.openpreservation.odf.pkg.PackageParser (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.pkg.PackageParser (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.pkg.PackageParser

    +

    Uses of Interface
    org.openpreservation.odf.pkg.PackageParser

    -
    Packages that use PackageParser
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/pkg/package-summary.html index d633ea0a..283381f7 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/package-summary.html @@ -1,134 +1,224 @@ + - -org.openpreservation.odf.pkg (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.pkg (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.pkg

    +

    Package org.openpreservation.odf.pkg

    -
    -
    package org.openpreservation.odf.pkg
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/pkg/package-tree.html index 472a6d07..b6ec1098 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/package-tree.html @@ -1,72 +1,119 @@ + - -org.openpreservation.odf.pkg Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.pkg Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.pkg

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/pkg/package-use.html b/docs/site/apidocs/org/openpreservation/odf/pkg/package-use.html index 1251cbd5..51fb8841 100644 --- a/docs/site/apidocs/org/openpreservation/odf/pkg/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/pkg/package-use.html @@ -1,151 +1,294 @@ + - -Uses of Package org.openpreservation.odf.pkg (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.pkg (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.pkg

    -
    Packages that use org.openpreservation.odf.pkg
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/Check.html b/docs/site/apidocs/org/openpreservation/odf/validation/Check.html index 3f2c5eae..6c3bf23b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/Check.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/Check.html @@ -1,157 +1,285 @@ + - -Check (ODF spreadsheet validator. 0.18.5 API) - + +Check (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface Check

    +
    Package org.openpreservation.odf.validation
    +

    Interface Check

    -
    -
    +
    +
    +
      +
    • +
      All Known Implementing Classes:
      CheckImpl
      -
      public interface Check
      +
      public interface Check
      Interface for a check, the application of a validation rule and message to an ODF document.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      Message
      -
      getMessage()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getMessage

          -
          Message getMessage()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getMessage

              +
              Message getMessage()
              Get the message associated with the check.
              -
              -
              Returns:
              +
              +
              Returns:
              the message
              -
          • -
        • -
          -

          getPath

          -
          String getPath()
          +
        + + + +
          +
        • +

          getPath

          +
          String getPath()
          Get the path to the element in the ODF document that the check applies to.
          -
          -
          Returns:
          +
          +
          Returns:
          the path
          -
      -
    - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/CheckImpl.html b/docs/site/apidocs/org/openpreservation/odf/validation/CheckImpl.html index 0ac8e218..60d77dd7 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/CheckImpl.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/CheckImpl.html @@ -1,181 +1,323 @@ + - -CheckImpl (ODF spreadsheet validator. 0.18.5 API) - + +CheckImpl (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Class CheckImpl

    +
    Package org.openpreservation.odf.validation
    +

    Class CheckImpl

    -
    java.lang.Object -
    org.openpreservation.odf.validation.CheckImpl
    -
    -
    -
    +
    + +
    +
      +
    • +
      All Implemented Interfaces:
      Check
      -
      public class CheckImpl -extends Object -implements Check
      -
    -
    -
      +
      public class CheckImpl
+extends Object
+implements Check
      + +
    +
    +
    + - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidator.html b/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidator.html index c14a6622..a95b3ac4 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidator.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidator.html @@ -1,155 +1,229 @@ + - -OdfValidator (ODF spreadsheet validator. 0.18.5 API) - + +OdfValidator (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface OdfValidator

    +
    Package org.openpreservation.odf.validation
    +

    Interface OdfValidator

    -
    +
    +
    +
      +
    • -
      public interface OdfValidator
      -
    -
    -
      +
      public interface OdfValidator
      + +
    +
    +
    + + + + + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidators.html b/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidators.html index 20913b06..75b83166 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidators.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/OdfValidators.html @@ -1,248 +1,410 @@ + - -OdfValidators (ODF spreadsheet validator. 0.18.5 API) - + +OdfValidators (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Class OdfValidators

    -
    -
    java.lang.Object -
    org.openpreservation.odf.validation.OdfValidators
    +
    Package org.openpreservation.odf.validation
    +

    Class OdfValidators

    -
    +
    + +
    +
      +
    • -
      public class OdfValidators -extends Object
      -
    -
    -
      +
      public class OdfValidators
+extends Object
      + +
    +
    +
    + + + + +
      +
    • +

      isCompressionValid

      +
      public static boolean isCompressionValid​(ZipEntry entry)
      Check if a zip entry has a valid compression method.
      -
      -
      Parameters:
      +
      +
      Parameters:
      entry - a zip entry to check
      -
      Returns:
      +
      Returns:
      true if the compression method is valid, else false
      -
      • -
    • -
      -

      resultOf

      -
      public static final ValidationResult resultOf(String name, - MessageLog messages)
      +
    + + + +
      +
    • +

      resultOf

      +
      public static final ValidationResult resultOf​(String name,
+                                              MessageLog messages)
      Create a mimimal validation report.
      -
      -
      Parameters:
      +
      +
      Parameters:
      filename - a name for the report
      -
      Returns:
      +
      Returns:
      the minimal validation report with the given name
      -
      • -
    • -
      -

      getOdfValidator

      -
      public static final OdfValidator getOdfValidator()
      -
      +
    + + + +
      +
    • +

      getOdfValidator

      +
      public static final OdfValidator getOdfValidator()
      • -
    • -
      -

      getOdfValidator

      -
      public static final OdfValidator getOdfValidator(boolean isExtended)
      -
      +
    + + + +
      +
    • +

      getOdfValidator

      +
      public static final OdfValidator getOdfValidator​(boolean isExtended)
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/OdfXmlValidator.html b/docs/site/apidocs/org/openpreservation/odf/validation/OdfXmlValidator.html new file mode 100644 index 00000000..8b3bd84b --- /dev/null +++ b/docs/site/apidocs/org/openpreservation/odf/validation/OdfXmlValidator.html @@ -0,0 +1,289 @@ + + + + + +OdfXmlValidator (ODF Document validator. 0.20-alpha-2 API) + + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package org.openpreservation.odf.validation
    +

    Class OdfXmlValidator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.openpreservation.odf.validation.OdfXmlValidator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class OdfXmlValidator
+extends Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/Profile.html b/docs/site/apidocs/org/openpreservation/odf/validation/Profile.html index 39b66c89..51b2236e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/Profile.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/Profile.html @@ -1,217 +1,352 @@ + - -Profile (ODF spreadsheet validator. 0.18.5 API) - + +Profile (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface Profile

    +
    Package org.openpreservation.odf.validation
    +

    Interface Profile

    -
    +
    +
    +
      +
    • -
      public interface Profile
      -
    -
    -
      +
      public interface Profile
      + +
    +
    +
    + + + + + + + + +
      +
    • +

      getRules

      +
      Set<Rule> getRules()
      Get the set of rules that comprise the profile.
      -
      -
      Returns:
      +
      +
      Returns:
      the set of rules that comprise the profile
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      Rule
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ProfileResult.html b/docs/site/apidocs/org/openpreservation/odf/validation/ProfileResult.html deleted file mode 100644 index 9ec172eb..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ProfileResult.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - -ProfileResult (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.odf.validation
    -

    Interface ProfileResult

    -
    -
    -
    -
    public interface ProfileResult
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        getId

        -
        String getId()
        -
        -
        • -
      • -
        -

        getName

        -
        String getName()
        -
        -
        • -
      • -
        -

        getValidationReport

        -
        ValidationReport getValidationReport()
        -
        -
        • -
      • -
        -

        getMessageLog

        -
        MessageLog getMessageLog()
        -
        -
        • -
      • -
        -

        isValid

        -
        boolean isValid()
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/Rule.html b/docs/site/apidocs/org/openpreservation/odf/validation/Rule.html index 53e1189d..ab5c8304 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/Rule.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/Rule.html @@ -1,183 +1,331 @@ + - -Rule (ODF spreadsheet validator. 0.18.5 API) - + +Rule (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface Rule

    +
    Package org.openpreservation.odf.validation
    +

    Interface Rule

    -
    -
    +
    +
    +
    -
    -
    - +
    +
    +
    + - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidatingParser.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidatingParser.html index b8d1f547..889ae17b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidatingParser.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/ValidatingParser.html @@ -1,168 +1,299 @@ + - -ValidatingParser (ODF spreadsheet validator. 0.18.5 API) - + +ValidatingParser (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface ValidatingParser

    +
    Package org.openpreservation.odf.validation
    +

    Interface ValidatingParser

    -
    -
    +
    +
    +
    -
    - +
    +
    + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReport.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReport.html index a8005397..cefbfaac 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReport.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReport.html @@ -1,330 +1,496 @@ + - -ValidationReport (ODF spreadsheet validator. 0.18.5 API) - + +ValidationReport (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface ValidationReport

    +
    Package org.openpreservation.odf.validation
    +

    Interface ValidationReport

    -
    +
    +
    +
      +
    • -
      public interface ValidationReport
      -
    -
    -
      +
      public interface ValidationReport
      + +
    +
    +
    + + + + +
      +
    • +

      getVersion

      +
      Version getVersion()
      Get the detected format of the OpenDocument.
      -
      -
      Returns:
      +
      +
      Returns:
      the detected format of the OpenDocument
      -
      • -
    • -
      -

      getVersionString

      -
      String getVersionString()
      +
    + + + +
      +
    • +

      getVersionString

      +
      String getVersionString()
      Get the detected format of the OpenDocument.
      -
      -
      Returns:
      +
      +
      Returns:
      the detected format of the OpenDocument
      -
      • -
    • -
      -

      getDetectedFormat

      -
      Formats getDetectedFormat()
      +
    + + + +
      +
    • +

      getDetectedFormat

      +
      Formats getDetectedFormat()
      Get the detected format of the OpenDocument.
      -
      -
      Returns:
      +
      +
      Returns:
      the detected format of the OpenDocument
      -
      • -
    • -
      -

      getFormat

      -
      String getFormat()
      +
    + + + +
      +
    • +

      getFormat

      +
      String getFormat()
      Get the detected format of the OpenDocument.
      -
      -
      Returns:
      +
      +
      Returns:
      the detected format of the OpenDocument
      -
      • -
    • -
      -

      getMetadata

      -
      Metadata getMetadata()
      +
    + + + +
      +
    • +

      getMetadata

      +
      Metadata getMetadata()
      Get the Metadata object for the ODF document.
      -
      -
      Returns:
      +
      +
      Returns:
      the Metadata object.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      Metadata
      -
      • -
    • -
      -

      getManifest

      -
      Manifest getManifest()
      +
    + + + +
      +
    • +

      getManifest

      +
      Manifest getManifest()
      The Manifest object for the ODF document.
      -
      -
      Returns:
      +
      +
      Returns:
      the Manifest object for an ODF document.
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      Manifest
      -
      • -
    • -
      -

      getValidationResults

      -
      List<ValidationResult> getValidationResults()
      +
    + + + + + + + +
      +
    • +

      getChecks

      +
      List<Check> getChecks()
      Get a list of all checks, from all Results contained in the file.
      -
      -
      Returns:
      +
      +
      Returns:
      -
      • -
    • -
      -

      hasSeverity

      -
      boolean hasSeverity(Message.Severity severity)
      +
    + + + +
      +
    • +

      hasSeverity

      +
      boolean hasSeverity​(Message.Severity severity)
      Do any of the contained results contain the specified severity?
      -
      -
      Returns:
      +
      +
      Returns:
      true if any of the validation result messages contain the specified severity.
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReportImpl.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReportImpl.html deleted file mode 100644 index 7d548547..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReportImpl.html +++ /dev/null @@ -1,469 +0,0 @@ - - - - -ValidationReportImpl (ODF spreadsheet validator. 0.18.3 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.odf.validation
    -

    Class ValidationReportImpl

    -
    -
    java.lang.Object -
    org.openpreservation.odf.validation.ValidationReportImpl
    -
    -
    -
    -
    All Implemented Interfaces:
    -
    ValidationReport
    -
    -
    -
    public class ValidationReportImpl -extends Object -implements ValidationReport
    -
    -
    - -
    -
    - -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.FormatOption.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.FormatOption.html index 132d87d0..cc1cb417 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.FormatOption.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.FormatOption.html @@ -1,240 +1,403 @@ + - -ValidationReports.FormatOption (ODF spreadsheet validator. 0.18.5 API) - + +ValidationReports.FormatOption (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Enum Class ValidationReports.FormatOption

    -
    -
    java.lang.Object -
    java.lang.Enum<ValidationReports.FormatOption> -
    org.openpreservation.odf.validation.ValidationReports.FormatOption
    -
    +
    Package org.openpreservation.odf.validation
    +

    Enum ValidationReports.FormatOption

    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • - -
    • -
      -

      Enum Constant Summary

      -
      Enum Constants
      -
      -
      Enum Constant
      -
      Description
      -
      JSON
      -
       
      -
      TEXT
      -
       
      -
      XML
      -
       
      +
    - +
    + - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.html index 0538f6bd..c4a9a8da 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationReports.html @@ -1,234 +1,389 @@ + - -ValidationReports (ODF spreadsheet validator. 0.18.5 API) - + +ValidationReports (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Class ValidationReports

    -
    -
    java.lang.Object -
    org.openpreservation.odf.validation.ValidationReports
    +
    Package org.openpreservation.odf.validation
    +

    Class ValidationReports

    -
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.openpreservation.odf.validation.ValidationReports
        • +
      +
      • +
    +
    +
      +
    • -
      public final class ValidationReports -extends Object
      -
    -
    -
      +
      public final class ValidationReports
+extends Object
      + +
    +
    +
    + + + + +
      +
    • +

      getReport

      +
      public static String getReport​(ValidationReport report,
+                               ValidationReports.FormatOption format)
+                        throws com.fasterxml.jackson.core.JsonProcessingException
      Get a string representation of the validation report in the specified format.
      -
      -
      Parameters:
      +
      +
      Parameters:
      report - the report to format, may contain multiple results
      format - the format for the returned report, may be JSON, XML or TEXT
      -
      Returns:
      +
      Returns:
      a string representation of the validation report in the specified format
      -
      Throws:
      +
      Throws:
      com.fasterxml.jackson.core.JsonProcessingException - when there is an error during JSON or XML processing
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResult.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResult.html index 18899eb7..17e20131 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResult.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResult.html @@ -1,194 +1,328 @@ + - -ValidationResult (ODF spreadsheet validator. 0.18.5 API) - + +ValidationResult (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Interface ValidationResult

    +
    Package org.openpreservation.odf.validation
    +

    Interface ValidationResult

    -
    -
    +
    +
    +
    -
    -
      +
      public interface ValidationResult
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      List<Check>
      -
      getChecks()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getName

          -
          String getName()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getName

              +
              String getName()
              Get the name of the validation profile been used.
              -
              -
              Returns:
              +
              +
              Returns:
              the name of the validation profile
              -
          • -
        • -
          -

          isValid

          -
          boolean isValid()
          +
        + + + +
          +
        • +

          isValid

          +
          boolean isValid()
          Determine if the OpenDocument is valid.
          -
          -
          Returns:
          +
          +
          Returns:
          true if the OpenDocument is valid, otherwise false
          -
        • -
      • -
        -

        getChecks

        -
        List<Check> getChecks()
        +
      + + + +
        +
      • +

        getChecks

        +
        List<Check> getChecks()
        Get all of the validation messages for the OpenDocument.
        -
        -
        Returns:
        +
        +
        Returns:
        a list of all of the validation messages for the OpenDocument
        -
      • -
    • -
      -

      getMessageLog

      -
      MessageLog getMessageLog()
      +
    + + + +
      +
    • +

      getMessageLog

      +
      MessageLog getMessageLog()
      Get the profile message log
      -
      -
      Returns:
      +
      +
      Returns:
      the MessageLog associated with the profile result
      -
      See Also:
      -
      - -
      +
      See Also:
      +
      MessageLog
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResultImpl.html b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResultImpl.html index d0d25de5..26383d36 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResultImpl.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/ValidationResultImpl.html @@ -1,284 +1,457 @@ + - -ValidationResultImpl (ODF spreadsheet validator. 0.18.5 API) - + +ValidationResultImpl (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation
    -

    Class ValidationResultImpl

    +
    Package org.openpreservation.odf.validation
    +

    Class ValidationResultImpl

    -
    java.lang.Object -
    org.openpreservation.odf.validation.ValidationResultImpl
    -
    -
    -
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.openpreservation.odf.validation.ValidationResultImpl
        • +
      +
      • +
    +
    +
    -
    - +
    +
    + + + + +
      +
    • +

      getChecks

      +
      public List<Check> getChecks()
      +
      Description copied from interface: ValidationResult
      Get all of the validation messages for the OpenDocument.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getChecks in interface ValidationResult
      -
      Returns:
      +
      Returns:
      a list of all of the validation messages for the OpenDocument
      -
      • -
    • -
      -

      getName

      -
      public String getName()
      -
      Description copied from interface: ValidationResult
      +
    + + + +
      +
    • +

      getName

      +
      public String getName()
      +
      Description copied from interface: ValidationResult
      Get the name of the validation profile been used.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getName in interface ValidationResult
      -
      Returns:
      +
      Returns:
      the name of the validation profile
      -
      • -
    • -
      -

      hashCode

      -
      public int hashCode()
      -
      -
      Overrides:
      -
      hashCode in class Object
      +
    + + + +
      +
    • +

      hashCode

      +
      public int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      -
      • -
    • -
      -

      equals

      -
      public boolean equals(Object obj)
      -
      -
      Overrides:
      -
      equals in class Object
      +
    + + + +
      +
    • +

      equals

      +
      public boolean equals​(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/Validator.html b/docs/site/apidocs/org/openpreservation/odf/validation/Validator.html deleted file mode 100644 index bfbe810c..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/Validator.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - -Validator (ODF spreadsheet validator. 1.18.1 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.odf.validation
    -

    Class Validator

    -
    -
    java.lang.Object -
    org.openpreservation.odf.validation.Validator
    -
    -
    -
    -
    public class Validator -extends Object
    -
    -
    - -
    -
    - -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/Validators.html b/docs/site/apidocs/org/openpreservation/odf/validation/Validators.html deleted file mode 100644 index cb8af399..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/Validators.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - -Validators (ODF spreadsheet validator. 1.18.1 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.odf.validation
    -

    Class Validators

    -
    -
    java.lang.Object -
    org.openpreservation.odf.validation.Validators
    -
    -
    -
    -
    public class Validators -extends Object
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        getValidatingParser

        -
        public static final ValidatingParser getValidatingParser() - throws ParserConfigurationException, -SAXException
        -
        Get a validating parser instance.
        -
        -
        Returns:
        -
        a validating parser instance
        -
        Throws:
        -
        ParserConfigurationException
        -
        SAXException
        -
        -
        -
        • -
      • -
        -

        isCompressionValid

        -
        public static boolean isCompressionValid(ZipEntry entry)
        -
        Check if a zip entry has a valid compression method.
        -
        -
        Parameters:
        -
        entry - a zip entry to check
        -
        Returns:
        -
        true if the compression method is valid, else false
        -
        -
        -
        • -
      • -
        -

        resultOf

        -
        public static final ValidationResult resultOf(String name, - MessageLog messages)
        -
        Create a mimimal validation report.
        -
        -
        Parameters:
        -
        filename - a name for the report
        -
        Returns:
        -
        the minimal validation report with the given name
        -
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Check.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Check.html index 87ee3347..8f1fbce8 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Check.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Check.html @@ -1,164 +1,309 @@ + - -Uses of Interface org.openpreservation.odf.validation.Check (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.Check (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.Check

    -
    -
    Packages that use Check
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/CheckImpl.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/CheckImpl.html index 1378dc43..3d575caa 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/CheckImpl.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/CheckImpl.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.validation.CheckImpl (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.CheckImpl (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.validation.CheckImpl

    +

    Uses of Class
    org.openpreservation.odf.validation.CheckImpl

    -No usage of org.openpreservation.odf.validation.CheckImpl
    +
    No usage of org.openpreservation.odf.validation.CheckImpl
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidator.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidator.html index 170e2a01..95564ebe 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidator.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidator.html @@ -1,90 +1,199 @@ + - -Uses of Interface org.openpreservation.odf.validation.OdfValidator (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.OdfValidator (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.OdfValidator

    -
    -
    Packages that use OdfValidator
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidators.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidators.html index 86bb92a8..f98772cc 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidators.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfValidators.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.validation.OdfValidators (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.OdfValidators (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.validation.OdfValidators

    +

    Uses of Class
    org.openpreservation.odf.validation.OdfValidators

    -No usage of org.openpreservation.odf.validation.OdfValidators
    +
    No usage of org.openpreservation.odf.validation.OdfValidators
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfXmlValidator.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfXmlValidator.html new file mode 100644 index 00000000..3669b483 --- /dev/null +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/OdfXmlValidator.html @@ -0,0 +1,150 @@ + + + + + +Uses of Class org.openpreservation.odf.validation.OdfXmlValidator (ODF Document validator. 0.20-alpha-2 API) + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Uses of Class
    org.openpreservation.odf.validation.OdfXmlValidator

    +
    +
    No usage of org.openpreservation.odf.validation.OdfXmlValidator
    +
    + + + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Profile.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Profile.html index e4de4691..ec2da96f 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Profile.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Profile.html @@ -1,106 +1,223 @@ + - -Uses of Interface org.openpreservation.odf.validation.Profile (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.Profile (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.Profile

    +

    Uses of Interface
    org.openpreservation.odf.validation.Profile

    -
    Packages that use Profile
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ProfileResult.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ProfileResult.html deleted file mode 100644 index f8e5da32..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ProfileResult.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Uses of Interface org.openpreservation.odf.validation.ProfileResult (ODF spreadsheet validator. 1.16.2 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Interface
    org.openpreservation.odf.validation.ProfileResult

    -
    -
    Packages that use ProfileResult
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Rule.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Rule.html index 26cb24c0..5b7363d3 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Rule.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Rule.html @@ -1,144 +1,287 @@ + - -Uses of Interface org.openpreservation.odf.validation.Rule (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.Rule (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.Rule

    +

    Uses of Interface
    org.openpreservation.odf.validation.Rule

    -
    Packages that use Rule
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidatingParser.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidatingParser.html index 069835ef..f7cfd57b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidatingParser.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidatingParser.html @@ -1,99 +1,210 @@ + - -Uses of Interface org.openpreservation.odf.validation.ValidatingParser (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.ValidatingParser (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.ValidatingParser

    +

    Uses of Interface
    org.openpreservation.odf.validation.ValidatingParser

    -
    Packages that use ValidatingParser
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReport.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReport.html index 20d69ba5..93b3a19a 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReport.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReport.html @@ -1,135 +1,260 @@ + - -Uses of Interface org.openpreservation.odf.validation.ValidationReport (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.ValidationReport (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.ValidationReport

    +

    Uses of Interface
    org.openpreservation.odf.validation.ValidationReport

    -
    Packages that use ValidationReport
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReportImpl.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReportImpl.html deleted file mode 100644 index aaf03c6b..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReportImpl.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - -Uses of Class org.openpreservation.odf.validation.ValidationReportImpl (ODF spreadsheet validator. 0.18.3 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Class
    org.openpreservation.odf.validation.ValidationReportImpl

    -
    -
    Packages that use ValidationReportImpl
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.FormatOption.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.FormatOption.html index f66c2a6f..4a2f0606 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.FormatOption.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.FormatOption.html @@ -1,107 +1,222 @@ + - -Uses of Enum Class org.openpreservation.odf.validation.ValidationReports.FormatOption (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.ValidationReports.FormatOption (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.validation.ValidationReports.FormatOption

    +

    Uses of Class
    org.openpreservation.odf.validation.ValidationReports.FormatOption

    -
    Packages that use ValidationReports.FormatOption
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.html index 776a0451..5633d513 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationReports.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.validation.ValidationReports (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.ValidationReports (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.validation.ValidationReports

    +

    Uses of Class
    org.openpreservation.odf.validation.ValidationReports

    -No usage of org.openpreservation.odf.validation.ValidationReports
    +
    No usage of org.openpreservation.odf.validation.ValidationReports
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResult.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResult.html index 64ae16bd..1252602b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResult.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResult.html @@ -1,133 +1,262 @@ + - -Uses of Interface org.openpreservation.odf.validation.ValidationResult (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.ValidationResult (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.ValidationResult

    -
    -
    Packages that use ValidationResult
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    +

    Uses of Interface
    org.openpreservation.odf.validation.ValidationResult

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResultImpl.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResultImpl.html index d38a6aa5..044f6f7c 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResultImpl.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/ValidationResultImpl.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.validation.ValidationResultImpl (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.ValidationResultImpl (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.validation.ValidationResultImpl

    +

    Uses of Class
    org.openpreservation.odf.validation.ValidationResultImpl

    -No usage of org.openpreservation.odf.validation.ValidationResultImpl
    +
    No usage of org.openpreservation.odf.validation.ValidationResultImpl
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Validator.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Validator.html deleted file mode 100644 index 1a1ae27c..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Validator.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - -Uses of Class org.openpreservation.odf.validation.Validator (ODF spreadsheet validator. 1.18.1 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Class
    org.openpreservation.odf.validation.Validator

    -
    -No usage of org.openpreservation.odf.validation.Validator
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Validators.html b/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Validators.html deleted file mode 100644 index 7c7cbed8..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/validation/class-use/Validators.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - -Uses of Class org.openpreservation.odf.validation.Validators (ODF spreadsheet validator. 1.18.1 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Class
    org.openpreservation.odf.validation.Validators

    -
    -No usage of org.openpreservation.odf.validation.Validators
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.Severity.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.Severity.html index f90a99db..abe24d24 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.Severity.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.Severity.html @@ -1,287 +1,468 @@ + - -Message.Severity (ODF spreadsheet validator. 0.18.5 API) - + +Message.Severity (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Enum Class Message.Severity

    -
    -
    java.lang.Object -
    java.lang.Enum<Message.Severity> -
    org.openpreservation.odf.validation.messages.Message.Severity
    +
    Package org.openpreservation.odf.validation.messages
    +

    Enum Message.Severity

    -
    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • +
    +
    +
    + + + + +
      +
    • +

      FATAL

      +
      public static final Message.Severity FATAL
      The message is a fatal error, usually an system issue
      -
    - + + -
  • -
    -

    Field Details

    -
      -
    • -
      -

      label

      -
      public final String label
      +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          label

          +
          public final String label
          The label for the severity, lower case
          -
    -
    • + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Message.Severity[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Message.Severity[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Message.Severity c : Message.Severity.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static Message.Severity valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static Message.Severity valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.html index e012f10e..be01eeff 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Message.html @@ -1,326 +1,507 @@ + - -Message (ODF spreadsheet validator. 0.18.5 API) - + +Message (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Interface Message

    +
    Package org.openpreservation.odf.validation.messages
    +

    Interface Message

    -
    +
    +
    +
      +
    • -
      public interface Message
      +
      public interface Message
      Defines behaviour of validation messages. These messages have a unique string identifier as well as the previous message and sub-message strings.
      -
      -
      Author:
      +
      +
      Author:
      Carl Wilson carlwilson AT github
      -
    -
    -
      + +
    +
    +
    + + + + +
      +
    • +

      getTitle

      +
      String getTitle()
      Get the main message
      -
      -
      Returns:
      +
      +
      Returns:
      the String message
      -
      • -
    • -
      -

      hasText

      -
      boolean hasText()
      +
    + + + +
      +
    • +

      hasText

      +
      boolean hasText()
      Test whether the message has a sub-message
      -
      -
      Returns:
      +
      +
      Returns:
      true if the message has a sub-message, false otherwise
      -
      • -
    • -
      -

      getText

      -
      String getText()
      +
    + + + +
      +
    • +

      getText

      +
      String getText()
      Get the sub-message
      -
      -
      Returns:
      +
      +
      Returns:
      the String sub-message
      -
      • -
    • -
      -

      getParameters

      -
      List<Parameter> getParameters()
      +
    + + + +
      +
    • +

      getParameters

      +
      List<Parameter> getParameters()
      Get the parameters
      -
      -
      Returns:
      +
      +
      Returns:
      -
      • -
    • -
      -

      isError

      -
      boolean isError()
      -
      Test whether the message has Message.Severity ERROR.
      -
      -
      Returns:
      +
    + + + +
      +
    • +

      isError

      +
      boolean isError()
      +
      Test whether the message has Message.Severity ERROR.
      +
      +
      Returns:
      true if the message has Severity.ERROR, false otherwise
      -
      • -
    • -
      -

      isFatal

      -
      boolean isFatal()
      -
      Test whether the message has Message.Severity FATAL.
      -
      -
      Returns:
      +
    + + + +
      +
    • +

      isFatal

      +
      boolean isFatal()
      +
      Test whether the message has Message.Severity FATAL.
      +
      +
      Returns:
      true if the message has Severity.FATAL, false otherwise
      -
      • -
    • -
      -

      isInfo

      -
      boolean isInfo()
      -
      Test whether the message has Message.Severity INFO.
      -
      -
      Returns:
      +
    + + + +
      +
    • +

      isInfo

      +
      boolean isInfo()
      +
      Test whether the message has Message.Severity INFO.
      +
      +
      Returns:
      true if the message has Severity.INFO, false otherwise
      -
      • -
    • -
      -

      isWarning

      -
      boolean isWarning()
      -
      Test whether the message has Message.Severity WARNING.
      -
      -
      Returns:
      +
    + + + +
      +
    • +

      isWarning

      +
      boolean isWarning()
      +
      Test whether the message has Message.Severity WARNING.
      +
      +
      Returns:
      true if the message has Severity.WARNING, false otherwise
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageFactory.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageFactory.html index 97edff10..d881f8a8 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageFactory.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageFactory.html @@ -1,367 +1,535 @@ + - -MessageFactory (ODF spreadsheet validator. 0.18.5 API) - + +MessageFactory (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Interface MessageFactory

    +
    Package org.openpreservation.odf.validation.messages
    +

    Interface MessageFactory

    -
    +
    +
    +
    -
    -
      + +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      +
    • +

      getWarning

      +
      Message getWarning​(String id,
+                   Parameter.ParameterList parameters)
+            throws NoSuchElementException
      Retrieve warning Message by unique persistent id and format with the given arguments
      -
      -
      Parameters:
      +
      +
      Parameters:
      id - the id of the message to be retrieved
      args - the arguments to be used in formatting the message
      -
      Returns:
      +
      Returns:
      the message with persistent id equal to id
      -
      Throws:
      -
      NoSuchElementException - if no message with id can be retrieved
      +
      Throws:
      +
      NoSuchElementException - if no message with id can be retrieved
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageLog.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageLog.html index b4025349..068a5cd1 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageLog.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/MessageLog.html @@ -1,458 +1,676 @@ + - -MessageLog (ODF spreadsheet validator. 0.18.5 API) - + +MessageLog (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Interface MessageLog

    +
    Package org.openpreservation.odf.validation.messages
    +

    Interface MessageLog

    -
    +
    +
    +
      +
    • -
      public interface MessageLog
      +
      public interface MessageLog
      Interface for a log of Message objects.
      -
    -
    -
      - -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      int
      -
      add(String path, - Collection<? extends Message> messages)
      -
      -
      Add a Collection of Messages to the log for a particular path.
      +
      • +
    -
    int
    -
    add(String path, - Message message)
    -
    +
    +
    +
    +
      +
    • -
    • -
      -

      Method Details

      -
        -
      • -
        -

        size

        -
        int size()
        +
        +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            size

            +
            int size()
            Get the number of messages in the log.
            -
            -
            Returns:
            +
            +
            Returns:
            the int number of messages in the log
            -
        • -
      • -
        -

        isEmpty

        -
        boolean isEmpty()
        +
      + + + +
        +
      • +

        isEmpty

        +
        boolean isEmpty()
        Is the log empty?
        -
        -
        Returns:
        +
        +
        Returns:
        true if the log is empty, false otherwise
        -
      • -
    • -
      -

      add

      -
      int add(String path, - Message message)
      +
    + + + +
      +
    • +

      add

      +
      int add​(String path,
+        Message message)
      Add a Message to the log for a particular path.
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the String path for the message
      message - the Message to be added
      -
      Returns:
      +
      Returns:
      the int number of messages in the log
      -
      • -
    • -
      -

      add

      -
      int add(String path, - Collection<? extends Message> messages)
      -
      Add a Collection of Messages to the log for a particular path.
      -
      -
      Parameters:
      +
    + + + +
      +
    • +

      add

      +
      int add​(String path,
+        Collection<? extends Message> messages)
      +
      Add a Collection of Messages to the log for a particular path.
      +
      +
      Parameters:
      path - the String path for the message
      messages - the Collection<Message> of Messages to be added
      -
      Returns:
      +
      Returns:
      the int number of messages in the log
      -
      • -
    • -
      -

      add

      -
      int add(Map<String,List<Message>> messages)
      +
    + + + +
      +
    • +

      add

      +
      int add​(Map<String,​List<Message>> messages)
      Add a map of messages to the log.
      -
      -
      Parameters:
      +
      +
      Parameters:
      messages - the Map<String, List<Message>> of messages to be added
      -
      Returns:
      +
      Returns:
      the int number of messages in the log
      -
      • -
    • -
      -

      getErrors

      -
      List<Check> getErrors()
      +
    + + + +
      +
    • +

      getErrors

      +
      List<Check> getErrors()
      Get all error messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      a Map<String, List<Message>> of error messages
      -
      • -
    • -
      -

      getWarnings

      -
      List<Check> getWarnings()
      +
    + + + +
      +
    • +

      getWarnings

      +
      List<Check> getWarnings()
      Get all warning messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      a Map<String, List<Message>> of warning messages
      -
      • -
    • -
      -

      getInfos

      -
      List<Check> getInfos()
      +
    + + + +
      +
    • +

      getInfos

      +
      List<Check> getInfos()
      Get all info messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      a Map<String, List<Message>> of info messages
      -
      • -
    • -
      -

      getChecks

      -
      List<Check> getChecks()
      +
    + + + +
      +
    • +

      getChecks

      +
      List<Check> getChecks()
      Get all messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      a Map<String, List<Message>> of all messages
      -
      • -
    • -
      -

      getMessages

      -
      Map<String,List<Message>> getMessages()
      +
    + + + +
      +
    • +

      getMessages

      +
      Map<String,​List<Message>> getMessages()
      Get all messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      a Map<String, List<Message>> of all messages
      -
      • -
    • -
      -

      hasErrors

      -
      boolean hasErrors()
      +
    + + + +
      +
    • +

      hasErrors

      +
      boolean hasErrors()
      Does the log contain any error messages?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the log contains error messages, false otherwise
      -
      • -
    • -
      -

      hasWarnings

      -
      boolean hasWarnings()
      +
    + + + +
      +
    • +

      hasWarnings

      +
      boolean hasWarnings()
      Does the log contain any warning messages?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the log contains warning messages, false otherwise
      -
      • -
    • -
      -

      hasInfos

      -
      boolean hasInfos()
      +
    + + + +
      +
    • +

      hasInfos

      +
      boolean hasInfos()
      Does the log contain any info messages?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the log contains info messages, false otherwise
      -
      • -
    • -
      -

      hasFatals

      -
      boolean hasFatals()
      +
    + + + +
      +
    • +

      hasFatals

      +
      boolean hasFatals()
      Does the log contain any fatal error messages?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the log contains fatal messages, false otherwise
      -
      • -
    • -
      -

      getErrorCount

      -
      int getErrorCount()
      +
    + + + +
      +
    • +

      getErrorCount

      +
      int getErrorCount()
      Get the number of error messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      the int number of error messages in the log
      -
      • -
    • -
      -

      getWarningCount

      -
      int getWarningCount()
      +
    + + + +
      +
    • +

      getWarningCount

      +
      int getWarningCount()
      Get the number of warning messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      the int number of warning messages in the log
      -
      • -
    • -
      -

      getInfoCount

      -
      int getInfoCount()
      +
    + + + +
      +
    • +

      getInfoCount

      +
      int getInfoCount()
      Get the number of info messages in the log.
      -
      -
      Returns:
      +
      +
      Returns:
      -
      • -
    • -
      -

      getChecksBySeverity

      -
      List<Check> getChecksBySeverity(Message.Severity severity)
      +
    + + + +
      +
    • +

      getChecksBySeverity

      +
      List<Check> getChecksBySeverity​(Message.Severity severity)
      Get all messages in the log of a particular severity.
      -
      -
      Parameters:
      -
      severity - the Message.Severity of the messages to be retrieved
      -
      Returns:
      +
      +
      Parameters:
      +
      severity - the Message.Severity of the messages to be retrieved
      +
      Returns:
      a Map<String, List<Message>> of messages of the specified severity
      -
      • -
    • -
      -

      getChecksById

      -
      List<Check> getChecksById(String id)
      +
    + + + +
      +
    • +

      getChecksById

      +
      List<Check> getChecksById​(String id)
      Get all messages in the log for a particular ID
      -
      -
      Parameters:
      +
      +
      Parameters:
      id - the String ID of the messages to be retrieved
      -
      Returns:
      +
      Returns:
      a Map<String, List<Message>> of messages for the specified ID
      -
      • -
    • -
      -

      getChecksForPath

      -
      List<Check> getChecksForPath(String path)
      +
    + + + +
      +
    • +

      getChecksForPath

      +
      List<Check> getChecksForPath​(String path)
      Get all messages in the log for a particular path
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the String path of the messages to be retrieved
      -
      Returns:
      +
      Returns:
      a List<Message> of messages for the specified path
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Messages.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Messages.html index f3f3fccc..c66c4446 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Messages.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Messages.html @@ -1,580 +1,808 @@ + - -Messages (ODF spreadsheet validator. 0.18.5 API) - + +Messages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Enum Class Messages

    -
    -
    java.lang.Object -
    java.lang.Enum<Messages> -
    org.openpreservation.odf.validation.messages.Messages
    -
    +
    Package org.openpreservation.odf.validation.messages
    +

    Enum Messages

    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • +
    +
    +
    + + + + +
      +
    • +

      DEFAULT_MESSAGE

      +
      public static final Message DEFAULT_MESSAGE
    - + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Messages[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Messages[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Messages c : Messages.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static Messages valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static Messages valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    getMessageInstance

    -
    public static Message getMessageInstance(String title) - throws IllegalArgumentException
    + + + + +
      +
    • +

      getMessageInstance

      +
      public static Message getMessageInstance​(String title)
+                                  throws IllegalArgumentException
      Create a new message instance with a DEFAULT_ID
      -
      -
      Parameters:
      +
      +
      Parameters:
      title - the message of the new message
      -
      Returns:
      +
      Returns:
      the new message instance
      -
      Throws:
      -
      IllegalArgumentException - if the id or message is null or empty
      +
      Throws:
      +
      IllegalArgumentException - if the id or message is null or empty
      -
    • -
  • -
    -

    getMessageInstance

    -
    public static Message getMessageInstance(String id, - Message.Severity severity, - String title) - throws IllegalArgumentException
    + + + + +
    • -
  • -
    -

    getMessageInstance

    -
    public static Message getMessageInstance(String id, - Message.Severity severity, - String title, - Parameter.ParameterList parameters) - throws IllegalArgumentException
    + + + + +
    • -
  • -
    -

    getMessageInstance

    -
    public static Message getMessageInstance(String id, - Message.Severity severity, - String title, - String text) - throws IllegalArgumentException
    + + + + +
      +
    • +

      getMessageInstance

      +
      public static Message getMessageInstance​(String id,
+                                         Message.Severity severity,
+                                         String title,
+                                         String text)
+                                  throws IllegalArgumentException
      Create a new Message instance with the given id, message and sub-message
      -
      -
      Parameters:
      +
      +
      Parameters:
      id - the id of the new message
      title - the message of the new message
      text - the sub-message of the new message
      -
      Returns:
      +
      Returns:
      the new message instance
      -
      Throws:
      -
      IllegalArgumentException - if the id or message is null or empty
      +
      Throws:
      +
      IllegalArgumentException - if the id or message is null or empty
      -
    • -
  • -
    -

    getMessageInstance

    -
    public static Message getMessageInstance(String id, - Message.Severity severity, - String title, - String text, - Parameter.ParameterList parameters) - throws IllegalArgumentException
    + + + + +
    • -
  • -
    -

    getInstance

    -
    public static MessageFactory getInstance() - throws IllegalArgumentException
    + + + + +
      +
    • +

      getInstance

      +
      public static MessageFactory getInstance()
+                                  throws IllegalArgumentException
      Get a MessageFactory instance with the default property based bundle name and the default user locale
      -
      -
      Returns:
      +
      +
      Returns:
      a new MessageFactory instance backed by the bundle property file.
      -
      Throws:
      -
      IllegalArgumentException - if the bundle name is empty or the message +
      Throws:
      +
      IllegalArgumentException - if the bundle name is empty or the message bundle can't be located
      -
    • -
  • -
    -

    getInstance

    -
    public static MessageFactory getInstance(String bundleName) - throws IllegalArgumentException
    + + + + +
      +
    • +

      getInstance

      +
      public static MessageFactory getInstance​(String bundleName)
+                                  throws IllegalArgumentException
      Get a MessageFactory instance with the requested property based bundle name and the default user locale
      -
      -
      Parameters:
      +
      +
      Parameters:
      bundleName - the fully qualified resource path for the message bundle property file
      -
      Returns:
      +
      Returns:
      a new MessageFactory instance backed by the bundle property file.
      -
      Throws:
      -
      IllegalArgumentException - if the bundle name is empty or the message +
      Throws:
      +
      IllegalArgumentException - if the bundle name is empty or the message bundle can't be located
      -
    • -
  • -
    -

    getInstance

    -
    public static MessageFactory getInstance(String bundleName, - Locale locale) - throws IllegalArgumentException
    + + + + +
      +
    • +

      getInstance

      +
      public static MessageFactory getInstance​(String bundleName,
+                                         Locale locale)
+                                  throws IllegalArgumentException
      Get a MessageFactory instance with the requested property based bundle name and a specific locale
      -
      -
      Parameters:
      +
      +
      Parameters:
      bundleName - the fully qualified resource path for the message bundle property file
      locale - the locale for the message bundle
      -
      Returns:
      +
      Returns:
      a new MessageFactory instance backed by the bundle property file.
      -
      Throws:
      -
      IllegalArgumentException - if the bundle name is empty or the message +
      Throws:
      +
      IllegalArgumentException - if the bundle name is empty or the message bundle can't be located
      -
    • -
  • -
    -

    messageLogInstance

    -
    public static MessageLog messageLogInstance()
    + + + + +
      +
    • +

      messageLogInstance

      +
      public static MessageLog messageLogInstance()
      Get the new MessageLog instance
      -
      -
      Returns:
      +
      +
      Returns:
      a new message log instance with the default path and no messages
      -
    • -
  • -
    -

    messageLogInstance

    -
    public static MessageLog messageLogInstance(String path, - List<Message> messages)
    + + + + +
      +
    • +

      messageLogInstance

      +
      public static MessageLog messageLogInstance​(String path,
+                                            List<Message> messages)
      Create a new MessageLog instance with the given values
      -
      -
      Parameters:
      +
      +
      Parameters:
      path - the path reference for the message log, i.e. the path to the entity that the log is associated with
      messages - the list of messages to be added to the log
      -
      Returns:
      +
      Returns:
      the new MessageLog instance created with the given values
      -
    • -
  • -
    -

    parameterOf

    -
    public static Parameter parameterOf(String name, - String value)
    + + + + +
      +
    • +

      parameterOf

      +
      public static Parameter parameterOf​(String name,
+                                    String value)
      Create a new Parameter instance with the given name and value
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the parameter
      value - the value of the parameter
      -
      Returns:
      +
      Returns:
      the new Parameter instance created with the given name and value
      -
    • -
  • -
    -

    parameterListInstance

    -
    public static Parameter.ParameterList parameterListInstance()
    + + + + +
      +
    • +

      parameterListInstance

      +
      public static Parameter.ParameterList parameterListInstance()
      Create a new empty ParameterList instance
      -
      -
      Returns:
      +
      +
      Returns:
      the new ParameterList instance
      -
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.ParameterList.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.ParameterList.html index f3cbb40b..68b393e2 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.ParameterList.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.ParameterList.html @@ -1,171 +1,314 @@ + - -Parameter.ParameterList (ODF spreadsheet validator. 0.18.5 API) - + +Parameter.ParameterList (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Interface Parameter.ParameterList

    +
    Package org.openpreservation.odf.validation.messages
    +

    Interface Parameter.ParameterList

    -
    -
    +
    +
    +
      +
    • +
      Enclosing interface:
      Parameter
      -
      public static interface Parameter.ParameterList
      -
    -
    -
    - +
    +
    +
    + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.html index 763c754c..9f90544c 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/Parameter.html @@ -1,153 +1,289 @@ + - -Parameter (ODF spreadsheet validator. 0.18.5 API) - + +Parameter (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.messages
    -

    Interface Parameter

    +
    Package org.openpreservation.odf.validation.messages
    +

    Interface Parameter

    -
    +
    +
    +
      +
    • -
      public interface Parameter
      -
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      Nested Classes
      -
      -
      Modifier and Type
      -
      Interface
      -
      Description
      -
      static interface 
      -
      Parameter.ParameterList
      -
       
      -
      -
      +
      public interface Parameter
      • - -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      String
      -
      getName()
      -
       
      -
      String
      -
      getValue()
      -
       
      -
      -
      +
    +
    +
    +
    +
      +
    • -
    • -
      -

      Method Details

      -
      - +
      • +
    +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.Severity.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.Severity.html index a368463b..50632d3b 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.Severity.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.Severity.html @@ -1,186 +1,331 @@ + - -Uses of Enum Class org.openpreservation.odf.validation.messages.Message.Severity (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.messages.Message.Severity (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.validation.messages.Message.Severity

    -
    -
    Packages that use Message.Severity
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.messages
    -
     
    +

    Uses of Class
    org.openpreservation.odf.validation.messages.Message.Severity

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.html index 01e2d70f..45817a18 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Message.html @@ -1,362 +1,614 @@ + - -Uses of Interface org.openpreservation.odf.validation.messages.Message (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.messages.Message (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.messages.Message

    -
    -
    Packages that use Message
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.odf.apps
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageFactory.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageFactory.html index 69d94c81..ac218a1a 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageFactory.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageFactory.html @@ -1,103 +1,214 @@ + - -Uses of Interface org.openpreservation.odf.validation.messages.MessageFactory (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.messages.MessageFactory (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.messages.MessageFactory

    +

    Uses of Interface
    org.openpreservation.odf.validation.messages.MessageFactory

    -
    Packages that use MessageFactory
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageLog.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageLog.html index 45bc79ed..9fed6400 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageLog.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/MessageLog.html @@ -1,147 +1,286 @@ + - -Uses of Interface org.openpreservation.odf.validation.messages.MessageLog (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.messages.MessageLog (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.messages.MessageLog

    -
    -
    Packages that use MessageLog
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    +

    Uses of Interface
    org.openpreservation.odf.validation.messages.MessageLog

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Messages.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Messages.html index 30927096..8cffd0f5 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Messages.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Messages.html @@ -1,95 +1,204 @@ + - -Uses of Enum Class org.openpreservation.odf.validation.messages.Messages (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.messages.Messages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.validation.messages.Messages

    +

    Uses of Class
    org.openpreservation.odf.validation.messages.Messages

    -
    Packages that use Messages
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.ParameterList.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.ParameterList.html index 129ef71a..19c4adbf 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.ParameterList.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.ParameterList.html @@ -1,156 +1,285 @@ + - -Uses of Interface org.openpreservation.odf.validation.messages.Parameter.ParameterList (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.messages.Parameter.ParameterList (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.messages.Parameter.ParameterList

    +

    Uses of Interface
    org.openpreservation.odf.validation.messages.Parameter.ParameterList

    -
    Packages that use Parameter.ParameterList
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.html index cfd3b574..fc77fec8 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/class-use/Parameter.html @@ -1,107 +1,224 @@ + - -Uses of Interface org.openpreservation.odf.validation.messages.Parameter (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.validation.messages.Parameter (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.validation.messages.Parameter

    +

    Uses of Interface
    org.openpreservation.odf.validation.messages.Parameter

    -
    Packages that use Parameter
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-summary.html index b73aab55..3ae80f6f 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-summary.html @@ -1,128 +1,213 @@ + - -org.openpreservation.odf.validation.messages (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.validation.messages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.validation.messages

    -
    -
    -
    package org.openpreservation.odf.validation.messages
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-tree.html index 9b578ea3..f14bc9b3 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-tree.html @@ -1,91 +1,180 @@ + - -org.openpreservation.odf.validation.messages Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.validation.messages Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.validation.messages

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Interface Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-use.html b/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-use.html index 8e9b0d7b..e9921c4a 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/messages/package-use.html @@ -1,174 +1,323 @@ + - -Uses of Package org.openpreservation.odf.validation.messages (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.validation.messages (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.validation.messages

    -
    Packages that use org.openpreservation.odf.validation.messages
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.format.xml
    -
     
    -
    org.openpreservation.odf.apps
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/validation/package-summary.html index 4c7aeba0..9779f1b8 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/package-summary.html @@ -1,144 +1,242 @@ + - -org.openpreservation.odf.validation (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.validation (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.validation

    -
    -
    -
    package org.openpreservation.odf.validation
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/validation/package-tree.html index f6c7e5ff..0e94ff5a 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/package-tree.html @@ -1,109 +1,199 @@ + - -org.openpreservation.odf.validation Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.validation Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.validation

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/package-use.html b/docs/site/apidocs/org/openpreservation/odf/validation/package-use.html index 571f3001..c807b28e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/package-use.html @@ -1,132 +1,265 @@ + - -Uses of Package org.openpreservation.odf.validation (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.validation (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.validation

    -
    Packages that use org.openpreservation.odf.validation
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.validation.messages
    -
     
    -
    org.openpreservation.odf.validation.rules
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/EmbeddedObjectsRule.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/EmbeddedObjectsRule.html index 633569c5..0e01d128 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/EmbeddedObjectsRule.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/EmbeddedObjectsRule.html @@ -1,238 +1,405 @@ + - -EmbeddedObjectsRule (ODF spreadsheet validator. 0.18.5 API) - + +EmbeddedObjectsRule (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.rules
    -

    Class EmbeddedObjectsRule

    -
    -
    java.lang.Object -
    org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
    +
    Package org.openpreservation.odf.validation.rules
    +

    Class EmbeddedObjectsRule

    -
    -
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
        • +
      +
      • +
    +
    +
      +
    • +
      All Implemented Interfaces:
      Rule
      -
      public class EmbeddedObjectsRule -extends Object
      -
    -
    -
    -
    -

    Methods inherited from class java.lang.Object

    -clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    - +
    +
    +
    + + + + +
      +
    • +

      getName

      +
      public String getName()
      +
      +
      Specified by:
      getName in interface Rule
      -
      • -
    • -
      -

      getDescription

      -
      public String getDescription()
      -
      -
      Specified by:
      +
    + + + + + + + +
      +
    • +

      getSeverity

      +
      public Message.Severity getSeverity()
      +
      +
      Specified by:
      getSeverity in interface Rule
      -
      • -
    • -
      -

      isPrerequisite

      -
      public boolean isPrerequisite()
      -
      -
      Specified by:
      +
    + + + +
      +
    • +

      isPrerequisite

      +
      public boolean isPrerequisite()
      +
      +
      Specified by:
      isPrerequisite in interface Rule
      -
      • -
    • -
      -

      hashCode

      -
      public final int hashCode()
      -
      -
      Overrides:
      -
      hashCode in class Object
      +
    + + + +
      +
    • +

      hashCode

      +
      public final int hashCode()
      +
      +
      Overrides:
      +
      hashCode in class Object
      -
      • -
    • -
      -

      equals

      -
      public final boolean equals(Object obj)
      -
      -
      Overrides:
      -
      equals in class Object
      +
    + + + +
      +
    • +

      equals

      +
      public final boolean equals​(Object obj)
      +
      +
      Overrides:
      +
      equals in class Object
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/Rules.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/Rules.html index 32076f3b..831e4710 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/Rules.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/Rules.html @@ -1,242 +1,429 @@ + - -Rules (ODF spreadsheet validator. 0.18.5 API) - + +Rules (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.validation.rules
    -

    Class Rules

    +
    Package org.openpreservation.odf.validation.rules
    +

    Class Rules

    -
    java.lang.Object -
    org.openpreservation.odf.validation.rules.Rules
    -
    -
    -
    -
    public class Rules -extends Object
    -
    -
    -
    +
    +
    +
    +
      +
    • -
    • -
      -

      Method Details

      - -
    - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/EmbeddedObjectsRule.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/EmbeddedObjectsRule.html index 0de1e555..a159c947 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/EmbeddedObjectsRule.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/EmbeddedObjectsRule.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.rules.EmbeddedObjectsRule (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.validation.rules.EmbeddedObjectsRule

    +

    Uses of Class
    org.openpreservation.odf.validation.rules.EmbeddedObjectsRule

    -No usage of org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
    +
    No usage of org.openpreservation.odf.validation.rules.EmbeddedObjectsRule
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/Rules.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/Rules.html index d858eb9d..40bbcf65 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/Rules.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/class-use/Rules.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.validation.rules.Rules (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.validation.rules.Rules (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.validation.rules.Rules

    +

    Uses of Class
    org.openpreservation.odf.validation.rules.Rules

    -No usage of org.openpreservation.odf.validation.rules.Rules
    +
    No usage of org.openpreservation.odf.validation.rules.Rules
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-summary.html index 8120e5f9..274a94a5 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-summary.html @@ -1,102 +1,172 @@ + - -org.openpreservation.odf.validation.rules (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.validation.rules (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.validation.rules

    -
    -
    -
    package org.openpreservation.odf.validation.rules
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-tree.html index b6fc4109..b192a9d6 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-tree.html @@ -1,77 +1,166 @@ + - -org.openpreservation.odf.validation.rules Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.validation.rules Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.validation.rules

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-use.html b/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-use.html index f944d094..7f9f1fe4 100644 --- a/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/validation/rules/package-use.html @@ -1,62 +1,150 @@ + - -Uses of Package org.openpreservation.odf.validation.rules (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.validation.rules (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.validation.rules

    -No usage of org.openpreservation.odf.validation.rules
    +
    No usage of org.openpreservation.odf.validation.rules
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/Constants.html b/docs/site/apidocs/org/openpreservation/odf/xml/Constants.html index 5239b3fa..5c3fc6a1 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/Constants.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/Constants.html @@ -1,101 +1,224 @@ + - -Constants (ODF spreadsheet validator. 0.18.5 API) - + +Constants (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Class Constants

    -
    -
    java.lang.Object -
    org.openpreservation.odf.xml.Constants
    +
    Package org.openpreservation.odf.xml
    +

    Class Constants

    -
    +
    + +
    +
      +
    • -
      public class Constants -extends Object
      -
    -
    -
      +
      public class Constants
+extends Object
      + +
    +
    +
    + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/DocumentType.html b/docs/site/apidocs/org/openpreservation/odf/xml/DocumentType.html index 19851dd5..bc541f45 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/DocumentType.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/DocumentType.html @@ -1,382 +1,595 @@ + - -DocumentType (ODF spreadsheet validator. 0.18.5 API) - + +DocumentType (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Enum Class DocumentType

    +
    Package org.openpreservation.odf.xml
    +

    Enum DocumentType

    -
    java.lang.Object -
    java.lang.Enum<DocumentType> -
    org.openpreservation.odf.xml.DocumentType
    -
    -
    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • +
    +
    +
    + + + + +
      +
    • +

      DRAWING

      +
      public static final DocumentType DRAWING
      Drawing document type, e.g. ODF Drawing and template.
      -
      • -
    • -
      -

      CHART

      -
      public static final DocumentType CHART
      +
    + + + +
      +
    • +

      CHART

      +
      public static final DocumentType CHART
      Chart document type, e.g. ODF Chart and template.
      -
      • -
    • -
      -

      IMAGE

      -
      public static final DocumentType IMAGE
      +
    + + + +
      +
    • +

      IMAGE

      +
      public static final DocumentType IMAGE
      Image document type, e.g. ODF Image and template.
      -
      • -
    • -
      -

      FORMULA

      -
      public static final DocumentType FORMULA
      +
    + + + +
      +
    • +

      FORMULA

      +
      public static final DocumentType FORMULA
      Formula document type, e.g. ODF Formula and template.
      -
      • -
    • -
      -

      DATABASE

      -
      public static final DocumentType DATABASE
      +
    + + + +
      +
    • +

      DATABASE

      +
      public static final DocumentType DATABASE
      Database document type, e.g. ODF Database.
      -
    - + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static DocumentType[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static DocumentType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (DocumentType c : DocumentType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static DocumentType valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static DocumentType valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    getFormats

    -
    public Set<Formats> getFormats()
    + + + + +
      +
    • +

      getFormats

      +
      public Set<Formats> getFormats()
      Get the set of formats associated with this document type.
      -
      -
      Returns:
      +
      +
      Returns:
      the set of formats
      -
    • -
  • -
    -

    getBodyElementName

    -
    public String getBodyElementName()
    + + + + +
      +
    • +

      getBodyElementName

      +
      public String getBodyElementName()
      Get the body element name associated with this document type.
      -
      -
      Returns:
      +
      +
      Returns:
      the body element name
      -
    • -
  • -
    -

    getTypeByFormat

    -
    public static DocumentType getTypeByFormat(Formats format)
    + + + + +
      +
    • +

      getTypeByFormat

      +
      public static DocumentType getTypeByFormat​(Formats format)
      Get the document type by the format.
      -
      -
      Parameters:
      +
      +
      Parameters:
      format - the format
      -
      Returns:
      +
      Returns:
      the document type
      -
    • -
  • -
    -

    getTypeByBodyElement

    -
    public static DocumentType getTypeByBodyElement(String bodyElementName)
    + + + + +
      +
    • +

      getTypeByBodyElement

      +
      public static DocumentType getTypeByBodyElement​(String bodyElementName)
      Get the document type by the body element name.
      -
      -
      Parameters:
      +
      +
      Parameters:
      bodyElementName - the body element name
      -
      Returns:
      +
      Returns:
      the document type
      -
    • -
  • -
    -

    getTypeByMimeString

    -
    public static DocumentType getTypeByMimeString(String mimeString)
    + + + + +
      +
    • +

      getTypeByMimeString

      +
      public static DocumentType getTypeByMimeString​(String mimeString)
      Get the document type by the MIME type.
      -
      -
      Parameters:
      +
      +
      Parameters:
      mimeString - the MIME type
      -
      Returns:
      +
      Returns:
      the document type
      -
    • - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/ExtendedConformanceFilter.html b/docs/site/apidocs/org/openpreservation/odf/xml/ExtendedConformanceFilter.html index 88955518..5a6f6b4d 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/ExtendedConformanceFilter.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/ExtendedConformanceFilter.html @@ -1,237 +1,396 @@ + - -ExtendedConformanceFilter (ODF spreadsheet validator. 0.18.5 API) - + +ExtendedConformanceFilter (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Class ExtendedConformanceFilter

    -
    -
    java.lang.Object -
    org.xml.sax.helpers.XMLFilterImpl -
    org.openpreservation.odf.xml.ExtendedConformanceFilter
    +
    Package org.openpreservation.odf.xml
    +

    Class ExtendedConformanceFilter

    -
    -
    -
    +
    + +
    +
    -
    -
      +
      public class ExtendedConformanceFilter
+extends XMLFilterImpl
      + +
    +
    +
    + + + + + - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.UserDefinedField.html b/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.UserDefinedField.html index 15c92c3c..d144b787 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.UserDefinedField.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.UserDefinedField.html @@ -1,172 +1,305 @@ + - -Metadata.UserDefinedField (ODF spreadsheet validator. 0.18.5 API) - + +Metadata.UserDefinedField (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Interface Metadata.UserDefinedField

    +
    Package org.openpreservation.odf.xml
    +

    Interface Metadata.UserDefinedField

    -
    -
    +
    +
    +
      +
    • +
      Enclosing interface:
      Metadata
      -
      public static interface Metadata.UserDefinedField
      +
      public static interface Metadata.UserDefinedField
      Interface that handles basic user defined field information.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      String
      -
      getName()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getName

          -
          String getName()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getName

              +
              String getName()
              Get the name of the user defined field.
              -
              -
              Returns:
              +
              +
              Returns:
              The name of the user defined field.
              -
          • -
        • -
          -

          getValueType

          -
          String getValueType()
          +
        + + + +
          +
        • +

          getValueType

          +
          String getValueType()
          The defined data type of the user defined field's value.
          -
          -
          Returns:
          +
          +
          Returns:
          -
        • -
      • -
        -

        getValue

        -
        String getValue()
        +
      + + + +
        +
      • +

        getValue

        +
        String getValue()
        The String representation of the user defined field's value.
        -
        -
        Returns:
        +
        +
        Returns:
        the String value for the user defined field.
        -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.html b/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.html index 63a089bb..07396b7e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/Metadata.html @@ -1,230 +1,381 @@ + - -Metadata (ODF spreadsheet validator. 0.18.5 API) - + +Metadata (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Interface Metadata

    +
    Package org.openpreservation.odf.xml
    +

    Interface Metadata

    -
    +
    +
    +
      +
    • -
      public interface Metadata
      +
      public interface Metadata
      Interface for retrieving any useful metadata from an ODF package meta.xml file.
      -
    -
    -
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Nested Class Summary

      -
      Nested Classes
      -
      -
      Modifier and Type
      -
      Interface
      -
      Description
      -
      static interface 
      -
      Metadata.UserDefinedField
      -
      +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeInterfaceDescription
        static interface Metadata.UserDefinedField
        Interface that handles basic user defined field information.
        - - - +
        • +
      +
      -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      String
      -
      getStringValue(String qualifiedName)
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getVersion

          -
          String getVersion()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getVersion

              +
              String getVersion()
              Return the office version of the Metadata data.
              -
              -
              Returns:
              +
              +
              Returns:
              the office version of the Metadata data, or null if not present
              -
          • -
        • -
          -

          getStringValueMap

          -
          Map<String,String> getStringValueMap()
          +
        + + + +
          +
        • +

          getStringValueMap

          +
          Map<String,​String> getStringValueMap()
          The qualified Name value Map of all of the qualifiedName:string pairs found in the metadata block.
          -
          -
          Returns:
          +
          +
          Returns:
          The name value Map, may be an empty Map but never null
          -
        • -
      • -
        -

        getStringValue

        -
        String getStringValue(String qualifiedName)
        +
      + + + +
        +
      • +

        getStringValue

        +
        String getStringValue​(String qualifiedName)
        Get the String value for the supplied qualified name.
        -
        -
        Parameters:
        +
        +
        Parameters:
        qualifiedName - The qualified name of the value to retrieve
        -
        Returns:
        +
        Returns:
        The String value for the supplied qualified name or null if no key exists
        -
      • -
    • -
      -

      getStringValue

      -
      String getStringValue(String prefix, - String localName)
      +
    + + + +
      +
    • +

      getStringValue

      +
      String getStringValue​(String prefix,
+                      String localName)
      Look up the string value by prefix and local name.
      -
      -
      Parameters:
      +
      +
      Parameters:
      prefix - The prefix of the value to retrieve, usuall "meta" or "dc".
      localName - The local name of the value to retrieve.
      -
      Returns:
      +
      Returns:
      The String value for the supplied prefix and local name or null if no key
      -
      • -
    • -
      -

      getUserDefinedFields

      -
      List<Metadata.UserDefinedField> getUserDefinedFields()
      +
    + + + +
      +
    • +

      getUserDefinedFields

      +
      List<Metadata.UserDefinedField> getUserDefinedFields()
      Get the user defined fields from the metadata block
      -
      -
      Returns:
      +
      +
      Returns:
      a List of any user defined fields, which is empty if there are none.
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/Namespaces.html b/docs/site/apidocs/org/openpreservation/odf/xml/Namespaces.html deleted file mode 100644 index 818a209c..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/xml/Namespaces.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - -Namespaces (ODF spreadsheet validator. 0.10.0 API) - - - - - - - - - - - - - - - -
    - -
    -
    - -
    -
    Package org.openpreservation.odf.xml
    -

    Enum Class Namespaces

    -
    -
    java.lang.Object -
    java.lang.Enum<Namespaces> -
    org.openpreservation.odf.xml.Namespaces
    -
    -
    -
    -
    -
    All Implemented Interfaces:
    -
    Serializable, Comparable<Namespaces>, java.lang.constant.Constable
    -
    -
    -
    public enum Namespaces -extends Enum<Namespaces>
    -
    -
    - -
    -
    -
      - -
    • -
      -

      Enum Constant Details

      -
        -
      • -
        -

        ANIM

        -
        public static final Namespaces ANIM
        -
        -
        • -
      • -
        -

        CHART

        -
        public static final Namespaces CHART
        -
        -
        • -
      • -
        -

        CONFIG

        -
        public static final Namespaces CONFIG
        -
        -
        • -
      • -
        -

        DB

        -
        public static final Namespaces DB
        -
        -
        • -
      • -
        -

        DR3D

        -
        public static final Namespaces DR3D
        -
        -
        • -
      • -
        -

        DRAW

        -
        public static final Namespaces DRAW
        -
        -
        • -
      • -
        -

        FORM

        -
        public static final Namespaces FORM
        -
        -
        • -
      • -
        -

        FO

        -
        public static final Namespaces FO
        -
        -
        • -
      • -
        -

        GRDDL

        -
        public static final Namespaces GRDDL
        -
        -
        • -
      • -
        -

        MANIFEST

        -
        public static final Namespaces MANIFEST
        -
        -
        • -
      • -
        -

        META

        -
        public static final Namespaces META
        -
        -
        • -
      • -
        -

        NUMBER

        -
        public static final Namespaces NUMBER
        -
        -
        • -
      • -
        -

        OFFICE

        -
        public static final Namespaces OFFICE
        -
        -
        • -
      • -
        -

        PRESENTATION

        -
        public static final Namespaces PRESENTATION
        -
        -
        • -
      • -
        -

        SCRIPT

        -
        public static final Namespaces SCRIPT
        -
        -
        • -
      • -
        -

        STYLE

        -
        public static final Namespaces STYLE
        -
        -
        • -
      • -
        -

        TABLE

        -
        public static final Namespaces TABLE
        -
        -
        • -
      • -
        -

        TEXT

        -
        public static final Namespaces TEXT
        -
        -
        • -
      • -
        -

        DSIG

        -
        public static final Namespaces DSIG
        -
        -
        • -
      • -
        -

        PKG

        -
        public static final Namespaces PKG
        -
        -
        • -
      • -
        -

        DS

        -
        public static final Namespaces DS
        -
        -
        • -
      • -
        -

        XFORMS

        -
        public static final Namespaces XFORMS
        -
        -
        • -
      • -
        -

        XHTML

        -
        public static final Namespaces XHTML
        -
        -
        • -
      • -
        -

        XMLNS

        -
        public static final Namespaces XMLNS
        -
        -
        • -
      • - -
        • -
      • -
        -

        ODF

        -
        public static final Namespaces ODF
        -
        -
        • -
      -
      -
      • - -
    • -
      -

      Field Details

      -
        -
      • -
        -

        prefix

        -
        public final String prefix
        -
        -
        • -
      • -
        -

        id

        -
        public final URI id
        -
        -
        • -
      • -
        -

        description

        -
        public final String description
        -
        -
        • -
      -
      -
      • - -
    • -
      -

      Method Details

      -
        -
      • -
        -

        values

        -
        public static Namespaces[] values()
        -
        Returns an array containing the constants of this enum class, in -the order they are declared.
        -
        -
        Returns:
        -
        an array containing the constants of this enum class, in the order they are declared
        -
        -
        -
        • -
      • -
        -

        valueOf

        -
        public static Namespaces valueOf(String name)
        -
        Returns the enum constant of this class with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum class has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        -
        • -
      • -
        -

        fromPrefix

        -
        public static final Namespaces fromPrefix(String prefix)
        -
        -
        • -
      • -
        -

        fromId

        -
        public static final Namespaces fromId(String id)
        -
        -
        • -
      • -
        -

        fromId

        -
        public static final Namespaces fromId(URI id)
        -
        -
        • -
      -
      -
      • -
    -
    - -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/OdfNamespaces.html b/docs/site/apidocs/org/openpreservation/odf/xml/OdfNamespaces.html index 1171677a..beeb8418 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/OdfNamespaces.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/OdfNamespaces.html @@ -1,618 +1,969 @@ + - -OdfNamespaces (ODF spreadsheet validator. 0.18.5 API) - + +OdfNamespaces (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Enum Class OdfNamespaces

    -
    -
    java.lang.Object -
    java.lang.Enum<OdfNamespaces> -
    org.openpreservation.odf.xml.OdfNamespaces
    +
    Package org.openpreservation.odf.xml
    +

    Enum OdfNamespaces

    -
    -
    -
    +
    + +
    +
    -
    -
    - +
    + + + + +
      +
    • +

      fromId

      +
      public static final OdfNamespaces fromId​(String id)
      Get an instance of OdfNamespaces from a namespace ID string.
      -
      -
      Parameters:
      +
      +
      Parameters:
      id - the URI string to search for
      -
      Returns:
      +
      Returns:
      the OdfNamespaces instance with the given URI, or null if not found
      -
      • -
    • -
      -

      fromId

      -
      public static final OdfNamespaces fromId(URI id)
      +
    + + + +
      +
    • +

      fromId

      +
      public static final OdfNamespaces fromId​(URI id)
      Get an instance of OdfNamespaces from a namespace ID URI.
      -
      -
      Parameters:
      +
      +
      Parameters:
      id - the URI to search for
      -
      Returns:
      +
      Returns:
      the OdfNamespaces instance with the given URI, or null if not found
      -
      • -
    • -
      -

      getDescription

      -
      public String getDescription()
      +
    + + + +
      +
    • +

      getDescription

      +
      public String getDescription()
      Get a description of the namespace.
      -
      -
      Returns:
      +
      +
      Returns:
      a String description of the namespace
      -
      • -
    • -
      -

      getId

      -
      public URI getId()
      -
      Description copied from interface: Namespace
      +
    + + + +
      +
    • +

      getId

      +
      public URI getId()
      +
      Description copied from interface: Namespace
      Get the URI id of the Namespace.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getId in interface Namespace
      -
      Returns:
      +
      Returns:
      the URI id of the Namespace
      -
      • -
    • -
      -

      getPrefix

      -
      public String getPrefix()
      -
      Description copied from interface: Namespace
      +
    + + + +
      +
    • +

      getPrefix

      +
      public String getPrefix()
      +
      Description copied from interface: Namespace
      Get the String prefix of the Namespace.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getPrefix in interface Namespace
      -
      Returns:
      +
      Returns:
      the String prefix of the Namespace
      -
      • -
    • -
      -

      getSchemalocation

      -
      public URL getSchemalocation()
      -
      Description copied from interface: Namespace
      +
    + + + +
      +
    • +

      getSchemalocation

      +
      public URL getSchemalocation()
      +
      Description copied from interface: Namespace
      Get the String location of the Namespace.
      -
      -
      Specified by:
      +
      +
      Specified by:
      getSchemalocation in interface Namespace
      -
      Returns:
      +
      Returns:
      the String location of the Namespace
      -
    - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/OdfSchemaFactory.html b/docs/site/apidocs/org/openpreservation/odf/xml/OdfSchemaFactory.html index aadd4aa6..b2f1ea4e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/OdfSchemaFactory.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/OdfSchemaFactory.html @@ -1,176 +1,326 @@ + - -OdfSchemaFactory (ODF spreadsheet validator. 0.18.5 API) - + +OdfSchemaFactory (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Class OdfSchemaFactory

    +
    Package org.openpreservation.odf.xml
    +

    Class OdfSchemaFactory

    -
    java.lang.Object -
    org.openpreservation.odf.xml.OdfSchemaFactory
    -
    -
    -
    -
    public class OdfSchemaFactory -extends Object
    -
    -
    -
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocument.html b/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocument.html index e9bebeed..d9880e0e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocument.html @@ -1,285 +1,453 @@ + - -OdfXmlDocument (ODF spreadsheet validator. 0.18.5 API) - + +OdfXmlDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Interface OdfXmlDocument

    +
    Package org.openpreservation.odf.xml
    +

    Interface OdfXmlDocument

    -
    +
    +
    +
      +
    • -
      public interface OdfXmlDocument
      -
    -
    -
      +
      public interface OdfXmlDocument
      + +
    +
    +
    +
      +
    • -
    • -
      -

      Method Summary

      -
      -
      -
      -
      -
      Modifier and Type
      -
      Method
      -
      Description
      -
      Set<Namespace>
      -
      getForeignNamespaces()
      -
      +
      +
      -
      -
        + +
      +
      +
      +
        +
      • -
      • -
        -

        Method Details

        -
          -
        • -
          -

          getRootNamespace

          -
          Namespace getRootNamespace()
          +
          +
            +
          • + + +

            Method Detail

            + + + +
              +
            • +

              getRootNamespace

              +
              Namespace getRootNamespace()
              Get the default namespace associated with the root element of the document
              -
              -
              Returns:
              +
              +
              Returns:
              the root element namespace
              -
          • -
        • -
          -

          getLocalRootName

          -
          String getLocalRootName()
          +
        + + + +
          +
        • +

          getLocalRootName

          +
          String getLocalRootName()
          Get the name of the local/unqualified of the document's root element.
          -
          -
          Returns:
          +
          +
          Returns:
          the unqualified name of the root element
          -
        • -
      • -
        -

        getRootName

        -
        String getRootName()
        +
      + + + +
        +
      • +

        getRootName

        +
        String getRootName()
        Get the namespace prefixed/qualfied name of the document's root element.
        -
        -
        Returns:
        +
        +
        Returns:
        the unqualified name of the root element
        -
      • -
    • -
      -

      hasFormat

      -
      boolean hasFormat()
      +
    + + + +
      +
    • +

      hasFormat

      +
      boolean hasFormat()
      Does the document declare a MIME type?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the document declares a MIME type, otherwise false
      -
      • -
    • -
      -

      getFormat

      -
      Formats getFormat()
      +
    + + + +
      +
    • +

      getFormat

      +
      Formats getFormat()
      Get the declared ODF MIME type of the document, parsed from a root element attribute
      -
      -
      Returns:
      +
      +
      Returns:
      the value of the mimetype attribute or null if no attribute found.
      -
      • -
    • -
      -

      hasVersion

      -
      boolean hasVersion()
      +
    + + + +
      +
    • +

      hasVersion

      +
      boolean hasVersion()
      Does the document declare a version?
      -
      -
      Returns:
      +
      +
      Returns:
      true if the document declares a version, otherwise false
      -
      • -
    • -
      -

      getVersion

      -
      Version getVersion()
      +
    + + + +
      +
    • +

      getVersion

      +
      Version getVersion()
      Get the ODF version of the XML document, parsed from a root element attribute
      -
      -
      Returns:
      +
      +
      Returns:
      The value of the version attribute or null if no attribute found
      -
      • -
    • -
      -

      getForeignNamespaces

      -
      Set<Namespace> getForeignNamespaces()
      +
    + + + +
      +
    • +

      getForeignNamespaces

      +
      Set<Namespace> getForeignNamespaces()
      Get the set of foreign namespaces used in the document, e.g. all of the namespaces outside of the declared ODF namespaces.
      -
      -
      Returns:
      +
      +
      Returns:
      -
      • -
    • -
      -

      isExtended

      -
      boolean isExtended()
      +
    + + + +
      +
    • +

      isExtended

      +
      boolean isExtended()
      Establish whether the document uses a namespace outside of the declared ODF namespaces.
      -
      -
      Returns:
      +
      +
      Returns:
      true if the document uses a namespace outside of the declared ODF namespaces
      -
      • -
    • -
      -

      getParseResult

      -
      ParseResult getParseResult()
      +
    + + + +
      +
    • +

      getParseResult

      +
      ParseResult getParseResult()
      Get the parse result of the XML document
      -
      -
      Returns:
      +
      +
      Returns:
      the parse result of the XML document
      -
    - - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocuments.html b/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocuments.html index 722244cb..8a150770 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocuments.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/OdfXmlDocuments.html @@ -1,233 +1,380 @@ + - -OdfXmlDocuments (ODF spreadsheet validator. 0.18.5 API) - + +OdfXmlDocuments (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Class OdfXmlDocuments

    +
    Package org.openpreservation.odf.xml
    +

    Class OdfXmlDocuments

    -
    java.lang.Object -
    org.openpreservation.odf.xml.OdfXmlDocuments
    -
    -
    +
    + +
    +
      +
    • -
      public final class OdfXmlDocuments -extends Object
      -
    -
    -
      +
      public final class OdfXmlDocuments
+extends Object
      + +
    +
    +
    + + + + + - - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/Version.html b/docs/site/apidocs/org/openpreservation/odf/xml/Version.html index 69c01a2f..6c056c4a 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/Version.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/Version.html @@ -1,333 +1,534 @@ + - -Version (ODF spreadsheet validator. 0.18.5 API) - + +Version (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.odf.xml
    -

    Enum Class Version

    -
    -
    java.lang.Object -
    java.lang.Enum<Version> -
    org.openpreservation.odf.xml.Version
    +
    Package org.openpreservation.odf.xml
    +

    Enum Version

    -
    -
    -
    +
    + +
    +
    -
    -
      - -
    • -
      -

      Nested Class Summary

      -
      -

      Nested classes/interfaces inherited from class java.lang.Enum

      -Enum.EnumDesc<E extends Enum<E>>
      -
      • +
    +
    +
    + + + + +
      +
    • +

      ODF_13

      +
      public static final Version ODF_13
      ODF version 1.3.
      -
      • -
    • -
      -

      ODF_14

      -
      public static final Version ODF_14
      +
    + + + +
      +
    • +

      ODF_14

      +
      public static final Version ODF_14
      ODF version 1.4.
      -
      • -
    • -
      -

      UNKNOWN

      -
      public static final Version UNKNOWN
      +
    + + + +
      +
    • +

      UNKNOWN

      +
      public static final Version UNKNOWN
      Unknown version.
      -
    - + + -
  • -
    -

    Field Details

    -
      -
    • -
      -

      version

      -
      public final String version
      +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          version

          +
          public final String version
          The version string.
          -
    -
    • + + -
  • -
    -

    Method Details

    -
      -
    • -
      -

      values

      -
      public static Version[] values()
      -
      Returns an array containing the constants of this enum class, in -the order they are declared.
      -
      -
      Returns:
      -
      an array containing the constants of this enum class, in the order they are declared
      +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Version[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Version c : Version.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          -
      • -
    • -
      -

      valueOf

      -
      public static Version valueOf(String name)
      -
      Returns the enum constant of this class with the specified name. +
    + + + +
      +
    • +

      valueOf

      +
      public static Version valueOf​(String name)
      +
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an -enum constant in this class. (Extraneous whitespace characters are +enum constant in this type. (Extraneous whitespace characters are not permitted.)
      -
      -
      Parameters:
      +
      +
      Parameters:
      name - the name of the enum constant to be returned.
      -
      Returns:
      +
      Returns:
      the enum constant with the specified name
      -
      Throws:
      -
      IllegalArgumentException - if this enum class has no constant with the specified name
      -
      NullPointerException - if the argument is null
      +
      Throws:
      +
      IllegalArgumentException - if this enum type has no constant with the specified name
      +
      NullPointerException - if the argument is null
      -
    • -
  • -
    -

    supportedVersions

    -
    public static final String supportedVersions()
    -
    + + + + +
      +
    • +

      supportedVersions

      +
      public static final String supportedVersions()
      • -
    • -
      -

      fromVersion

      -
      public static Version fromVersion(String version)
      +
    + + + +
      +
    • +

      fromVersion

      +
      public static Version fromVersion​(String version)
      Returns the Version enum constant based on the provided version string.
      -
      -
      Parameters:
      +
      +
      Parameters:
      version - the version string to identify
      -
      Returns:
      +
      Returns:
      the identified Version enum constant, or UNKNOWN if no match is found
      -
    -
    • - + + +
    + + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Constants.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Constants.html index d8a30276..451cb13e 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Constants.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Constants.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.xml.Constants (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.Constants (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.xml.Constants

    +

    Uses of Class
    org.openpreservation.odf.xml.Constants

    -No usage of org.openpreservation.odf.xml.Constants
    +
    No usage of org.openpreservation.odf.xml.Constants
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/DocumentType.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/DocumentType.html index 2501d907..42ac20dd 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/DocumentType.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/DocumentType.html @@ -1,128 +1,253 @@ + - -Uses of Enum Class org.openpreservation.odf.xml.DocumentType (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.DocumentType (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.xml.DocumentType

    -
    -
    Packages that use DocumentType
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    +

    Uses of Class
    org.openpreservation.odf.xml.DocumentType

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/ExtendedConformanceFilter.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/ExtendedConformanceFilter.html index ee1e4e74..5317fa8c 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/ExtendedConformanceFilter.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/ExtendedConformanceFilter.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.xml.ExtendedConformanceFilter (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.ExtendedConformanceFilter (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.xml.ExtendedConformanceFilter

    +

    Uses of Class
    org.openpreservation.odf.xml.ExtendedConformanceFilter

    -No usage of org.openpreservation.odf.xml.ExtendedConformanceFilter
    +
    No usage of org.openpreservation.odf.xml.ExtendedConformanceFilter
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.UserDefinedField.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.UserDefinedField.html index c2af71ab..b37522f1 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.UserDefinedField.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.UserDefinedField.html @@ -1,103 +1,216 @@ + - -Uses of Interface org.openpreservation.odf.xml.Metadata.UserDefinedField (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.xml.Metadata.UserDefinedField (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.xml.Metadata.UserDefinedField

    +

    Uses of Interface
    org.openpreservation.odf.xml.Metadata.UserDefinedField

    -
    Packages that use Metadata.UserDefinedField
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.html index 1379b0b6..64cb4ee6 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Metadata.html @@ -1,149 +1,286 @@ + - -Uses of Interface org.openpreservation.odf.xml.Metadata (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.xml.Metadata (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.xml.Metadata

    -
    -
    Packages that use Metadata
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    +

    Uses of Interface
    org.openpreservation.odf.xml.Metadata

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Namespaces.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Namespaces.html deleted file mode 100644 index fb2596b2..00000000 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Namespaces.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - -Uses of Enum Class org.openpreservation.odf.xml.Namespaces (ODF spreadsheet validator. 0.10.0 API) - - - - - - - - - - - - - - - -
    - -
    -
    -
    -

    Uses of Enum Class
    org.openpreservation.odf.xml.Namespaces

    -
    -
    Packages that use Namespaces
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    - -
    -
    - -
    -
    - - diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfNamespaces.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfNamespaces.html index 1dc8fb8d..05f06612 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfNamespaces.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfNamespaces.html @@ -1,142 +1,277 @@ + - -Uses of Enum Class org.openpreservation.odf.xml.OdfNamespaces (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.OdfNamespaces (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.xml.OdfNamespaces

    -
    -
    Packages that use OdfNamespaces
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.xml
    -
     
    +

    Uses of Class
    org.openpreservation.odf.xml.OdfNamespaces

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfSchemaFactory.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfSchemaFactory.html index 75f71060..f1c5d5fd 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfSchemaFactory.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfSchemaFactory.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.xml.OdfSchemaFactory (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.OdfSchemaFactory (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.xml.OdfSchemaFactory

    +

    Uses of Class
    org.openpreservation.odf.xml.OdfSchemaFactory

    -No usage of org.openpreservation.odf.xml.OdfSchemaFactory
    +
    No usage of org.openpreservation.odf.xml.OdfSchemaFactory
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocument.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocument.html index 35337675..a551ee85 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocument.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocument.html @@ -1,152 +1,319 @@ + - -Uses of Interface org.openpreservation.odf.xml.OdfXmlDocument (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Interface org.openpreservation.odf.xml.OdfXmlDocument (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Interface
    org.openpreservation.odf.xml.OdfXmlDocument

    +

    Uses of Interface
    org.openpreservation.odf.xml.OdfXmlDocument

    -
    Packages that use OdfXmlDocument
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocuments.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocuments.html index 8e041ab4..643319f6 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocuments.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/OdfXmlDocuments.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.odf.xml.OdfXmlDocuments (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.OdfXmlDocuments (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.odf.xml.OdfXmlDocuments

    +

    Uses of Class
    org.openpreservation.odf.xml.OdfXmlDocuments

    -No usage of org.openpreservation.odf.xml.OdfXmlDocuments
    +
    No usage of org.openpreservation.odf.xml.OdfXmlDocuments
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Version.html b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Version.html index 9962029e..a926f163 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Version.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/class-use/Version.html @@ -1,189 +1,346 @@ + - -Uses of Enum Class org.openpreservation.odf.xml.Version (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.odf.xml.Version (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Enum Class
    org.openpreservation.odf.xml.Version

    -
    -
    Packages that use Version
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    +

    Uses of Class
    org.openpreservation.odf.xml.Version

    -
    - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/package-summary.html b/docs/site/apidocs/org/openpreservation/odf/xml/package-summary.html index deaf65ed..fb1217a1 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/package-summary.html @@ -1,143 +1,237 @@ + - -org.openpreservation.odf.xml (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.xml (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.odf.xml

    -
    -
    -
    package org.openpreservation.odf.xml
    -
    -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/package-tree.html b/docs/site/apidocs/org/openpreservation/odf/xml/package-tree.html index 50527bbd..0489f63c 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/package-tree.html @@ -1,107 +1,196 @@ + - -org.openpreservation.odf.xml Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.odf.xml Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.odf.xml

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    -
    +

    Interface Hierarchy

    -
    -

    Enum Class Hierarchy

    +
    +

    Enum Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/odf/xml/package-use.html b/docs/site/apidocs/org/openpreservation/odf/xml/package-use.html index efb81553..9b0c1806 100644 --- a/docs/site/apidocs/org/openpreservation/odf/xml/package-use.html +++ b/docs/site/apidocs/org/openpreservation/odf/xml/package-use.html @@ -1,168 +1,317 @@ + - -Uses of Package org.openpreservation.odf.xml (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.odf.xml (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.odf.xml

    -
    Packages that use org.openpreservation.odf.xml
    -
    -
    Package
    -
    Description
    -
    org.openpreservation.odf.document
    -
     
    -
    org.openpreservation.odf.pkg
    -
     
    -
    org.openpreservation.odf.validation
    -
     
    -
    org.openpreservation.odf.xml
    -
     
    -
    -
    -
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/utils/Checks.html b/docs/site/apidocs/org/openpreservation/utils/Checks.html index dcfab80c..73805e49 100644 --- a/docs/site/apidocs/org/openpreservation/utils/Checks.html +++ b/docs/site/apidocs/org/openpreservation/utils/Checks.html @@ -1,223 +1,371 @@ + - -Checks (ODF spreadsheet validator. 0.18.5 API) - + +Checks (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -
    +
    -
    Package org.openpreservation.utils
    -

    Class Checks

    -
    -
    java.lang.Object -
    org.openpreservation.utils.Checks
    +
    Package org.openpreservation.utils
    +

    Class Checks

    -
    -
    -
    public class Checks -extends Object
    -
    -
    -
    - + + -
  • -
    -

    Method Details

    - + + + +
      +
    • +

      errMessage

      +
      public static final String errMessage​(String toValidate,
+                                      String subMess)
    -
    • - + + +
    +
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/utils/class-use/Checks.html b/docs/site/apidocs/org/openpreservation/utils/class-use/Checks.html index 508f1e6e..1f2e04e6 100644 --- a/docs/site/apidocs/org/openpreservation/utils/class-use/Checks.html +++ b/docs/site/apidocs/org/openpreservation/utils/class-use/Checks.html @@ -1,62 +1,150 @@ + - -Uses of Class org.openpreservation.utils.Checks (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Class org.openpreservation.utils.Checks (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Uses of Class
    org.openpreservation.utils.Checks

    +

    Uses of Class
    org.openpreservation.utils.Checks

    -No usage of org.openpreservation.utils.Checks
    +
    No usage of org.openpreservation.utils.Checks
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/utils/package-summary.html b/docs/site/apidocs/org/openpreservation/utils/package-summary.html index 3774c81d..bb9ff446 100644 --- a/docs/site/apidocs/org/openpreservation/utils/package-summary.html +++ b/docs/site/apidocs/org/openpreservation/utils/package-summary.html @@ -1,87 +1,168 @@ + - -org.openpreservation.utils (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.utils (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -
    -

    Package org.openpreservation.utils

    -
    -
    -
    package org.openpreservation.utils
    -
    -
      -
    • -
      -
      Classes
      -
      -
      Class
      -
      Description
      -
      Checks
      -
       
      -
      +

      Package org.openpreservation.utils

      +
      +
        +
      • + + + + + + + + + + + + +
        Class Summary 
        ClassDescription
        Checks 
      -
    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/utils/package-tree.html b/docs/site/apidocs/org/openpreservation/utils/package-tree.html index b432e1c1..5096310d 100644 --- a/docs/site/apidocs/org/openpreservation/utils/package-tree.html +++ b/docs/site/apidocs/org/openpreservation/utils/package-tree.html @@ -1,76 +1,165 @@ + - -org.openpreservation.utils Class Hierarchy (ODF spreadsheet validator. 0.18.5 API) - + +org.openpreservation.utils Class Hierarchy (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Hierarchy For Package org.openpreservation.utils

    -Package Hierarchies: +Package Hierarchies:
    -
    +
    +

    Class Hierarchy

    +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/org/openpreservation/utils/package-use.html b/docs/site/apidocs/org/openpreservation/utils/package-use.html index d5a5528d..1c438281 100644 --- a/docs/site/apidocs/org/openpreservation/utils/package-use.html +++ b/docs/site/apidocs/org/openpreservation/utils/package-use.html @@ -1,62 +1,150 @@ + - -Uses of Package org.openpreservation.utils (ODF spreadsheet validator. 0.18.5 API) - + +Uses of Package org.openpreservation.utils (ODF Document validator. 0.20-alpha-2 API) - - - + - + - - + + + + + - - -
    -
    +
     
    + + -

    Uses of Package
    org.openpreservation.utils

    -No usage of org.openpreservation.utils
    +
    No usage of org.openpreservation.utils
    + + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/overview-summary.html b/docs/site/apidocs/overview-summary.html index 739e74ac..66b4e398 100644 --- a/docs/site/apidocs/overview-summary.html +++ b/docs/site/apidocs/overview-summary.html @@ -1,21 +1,18 @@ + - -ODF spreadsheet validator. 0.18.5 API - + +ODF Document validator. 0.20-alpha-2 API - - - - - + + - +
    + +

    Copyright © 2022–2025 The Open Preservation Foundation. All rights reserved.

    + diff --git a/docs/site/apidocs/stylesheet.css b/docs/site/apidocs/stylesheet.css index 836c62da..de945eda 100644 --- a/docs/site/apidocs/stylesheet.css +++ b/docs/site/apidocs/stylesheet.css @@ -1,4 +1,4 @@ -/* +/* * Javadoc style sheet */ @@ -40,6 +40,13 @@ a[href]:hover, a[href]:focus { a[name] { color:#353833; } +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} pre { font-family:'DejaVu Sans Mono', monospace; font-size:14px; @@ -52,24 +59,22 @@ h2 { } h3 { font-size:16px; + font-style:italic; } h4 { - font-size:15px; + font-size:13px; } h5 { - font-size:14px; + font-size:12px; } h6 { - font-size:13px; + font-size:11px; } ul { list-style-type:disc; } code, tt { font-family:'DejaVu Sans Mono', monospace; -} -:not(h1, h2, h3, h4, h5, h6) > code, -:not(h1, h2, h3, h4, h5, h6) > tt { font-size:14px; padding-top:4px; margin-top:8px; @@ -80,7 +85,7 @@ dt code { font-size:14px; padding-top:4px; } -.summary-table dt code { +table tr td dt code { font-family:'DejaVu Sans Mono', monospace; font-size:14px; vertical-align:top; @@ -89,10 +94,7 @@ dt code { sup { font-size:8px; } -button { - font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; - font-size: 14px; -} + /* * Styles for HTML generated by javadoc. * @@ -104,19 +106,26 @@ button { */ .clear { clear:both; - height:0; + height:0px; overflow:hidden; } -.about-language { +.aboutLanguage { float:right; - padding:0 21px 8px 8px; + padding:0px 21px; font-size:11px; + z-index:200; margin-top:-9px; - height:2.9em; } -.legal-copy { +.legalCopy { margin-left:.5em; } +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} .tab { background-color:#0066FF; color:#ffffff; @@ -127,124 +136,152 @@ button { /* * Styles for navigation bar. */ -@media screen { - .flex-box { - position:fixed; - display:flex; - flex-direction:column; - height: 100%; - width: 100%; - } - .flex-header { - flex: 0 0 auto; - } - .flex-content { - flex: 1 1 auto; - overflow-y: auto; - } -} -.top-nav { +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { background-color:#4D7A97; color:#FFFFFF; float:left; padding:0; width:100%; clear:right; - min-height:2.8em; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; padding-top:10px; overflow:hidden; font-size:12px; } -.sub-nav { +.subNav { background-color:#dee3e9; float:left; width:100%; overflow:hidden; font-size:12px; } -.sub-nav div { +.subNav div { clear:left; float:left; padding:0 0 5px 6px; text-transform:uppercase; } -.sub-nav .nav-list { - padding-top:5px; -} -ul.nav-list { - display:block; - margin:0 25px 0 0; - padding:0; -} -ul.sub-nav-list { +ul.navList, ul.subNavList { float:left; margin:0 25px 0 0; padding:0; } -ul.nav-list li { +ul.navList li{ list-style:none; float:left; padding: 5px 6px; text-transform:uppercase; } -.sub-nav .nav-list-search { +ul.navListSearch { float:right; margin:0 0 0 0; - padding:5px 6px; - clear:none; + padding:0; } -.nav-list-search label { +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { position:relative; right:-16px; } -ul.sub-nav-list li { +ul.subNavList li { list-style:none; float:left; - padding-top:10px; } -.top-nav a:link, .top-nav a:active, .top-nav a:visited { +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { color:#FFFFFF; text-decoration:none; text-transform:uppercase; } -.top-nav a:hover { +.topNav a:hover, .bottomNav a:hover { text-decoration:none; color:#bb7a2a; text-transform:uppercase; } -.nav-bar-cell1-rev { +.navBarCell1Rev { background-color:#F8981D; color:#253441; margin: auto 5px; } -.skip-nav { +.skipNav { position:absolute; top:auto; left:-9999px; overflow:hidden; } -/* - * Hide navigation links and search box in print layout - */ -@media print { - ul.nav-list, div.sub-nav { - display:none; - } -} /* * Styles for page header and footer. */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} .title { color:#2c4557; margin:10px 0; } -.sub-title { +.subTitle { margin:5px 0 0 0; } .header ul { margin:0 0 15px 0; padding:0; } +.footer ul { + margin:20px 0 5px 0; +} .header ul li, .footer ul li { list-style:none; font-size:13px; @@ -252,49 +289,69 @@ ul.sub-nav-list li { /* * Styles for headings. */ -body.class-declaration-page .summary h2, -body.class-declaration-page .details h2, -body.class-use-page h2, -body.module-declaration-page .block-list h2 { - font-style: italic; - padding:0; - margin:15px 0; +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; } -body.class-declaration-page .summary h3, -body.class-declaration-page .details h3, -body.class-declaration-page .summary .inherited-list h2 { +ul.blockList ul.blockList ul.blockList li.blockList h3 { background-color:#dee3e9; border:1px solid #d0d9e0; margin:0 0 6px -8px; padding:7px 5px; } +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} /* * Styles for page layout containers. */ -main { +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { clear:both; padding:10px 20px; position:relative; } -dl.notes > dt { - font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif; +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { font-size:12px; font-weight:bold; margin:10px 0 0 0; color:#4E4E4E; } -dl.notes > dd { - margin:5px 10px 10px 0; +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } -dl.name-value > dt { +.serializedFormContainer dl.nameValue dt { margin-left:1px; font-size:1.1em; display:inline; font-weight:bold; } -dl.name-value > dd { +.serializedFormContainer dl.nameValue dd { margin:0 0 0 1px; font-size:1.1em; display:inline; @@ -309,56 +366,70 @@ ul.horizontal li { display:inline; font-size:0.9em; } -div.inheritance { +ul.inheritance { margin:0; padding:0; } -div.inheritance div.inheritance { - margin-left:2em; +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; } -ul.block-list, -ul.details-list, -ul.member-list, -ul.summary-list { +ul.blockList, ul.blockListLast { margin:10px 0 10px 0; padding:0; } -ul.block-list > li, -ul.details-list > li, -ul.member-list > li, -ul.summary-list > li { +ul.blockList li.blockList, ul.blockListLast li.blockList { list-style:none; margin-bottom:15px; line-height:1.4; } -.summary-table dl, .summary-table dl dt, .summary-table dl dd { - margin-top:0; - margin-bottom:1px; +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; } -ul.see-list, ul.see-list-long { - padding-left: 0; - list-style: none; +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; } -ul.see-list li { - display: inline; +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; } -ul.see-list li:not(:last-child):after, -ul.see-list-long li:not(:last-child):after { - content: ", "; - white-space: pre-wrap; +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; } /* * Styles for tables. */ -.summary-table, .details-table { +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { width:100%; border-spacing:0; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; - padding:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; } -.caption { +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { position:relative; text-align:left; background-repeat:no-repeat; @@ -366,20 +437,38 @@ ul.see-list-long li:not(:last-child):after { font-weight:bold; clear:none; overflow:hidden; - padding:0; + padding:0px; padding-top:10px; padding-left:1px; - margin:0; + margin:0px; white-space:pre; } -.caption a:link, .caption a:visited { +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { color:#1f389c; } -.caption a:hover, -.caption a:active { +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { color:#FFFFFF; } -.caption span { +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { white-space:nowrap; padding-top:5px; padding-left:12px; @@ -391,150 +480,168 @@ ul.see-list-long li:not(:last-child):after { border: none; height:16px; } -div.table-tabs { - padding:10px 0 0 1px; - margin:0; +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; } -div.table-tabs > button { - border: none; - cursor: pointer; - padding: 5px 12px 7px 12px; - font-weight: bold; - margin-right: 3px; -} -div.table-tabs > button.active-table-tab { - background: #F8981D; - color: #253441; -} -div.table-tabs > button.table-tab { - background: #4D7A97; - color: #FFFFFF; -} -.two-column-summary { - display: grid; - grid-template-columns: minmax(15%, max-content) minmax(15%, auto); -} -.three-column-summary { - display: grid; - grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto); -} -.four-column-summary { - display: grid; - grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto); -} -@media screen and (max-width: 600px) { - .two-column-summary { - display: grid; - grid-template-columns: 1fr; - } -} -@media screen and (max-width: 800px) { - .three-column-summary { - display: grid; - grid-template-columns: minmax(10%, max-content) minmax(25%, auto); - } - .three-column-summary .col-last { - grid-column-end: span 2; - } -} -@media screen and (max-width: 1000px) { - .four-column-summary { - display: grid; - grid-template-columns: minmax(15%, max-content) minmax(15%, auto); - } -} -.summary-table > div, .details-table > div { +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { text-align:left; - padding: 8px 3px 3px 7px; + padding:0px 0px 12px 10px; } -.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name { +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { vertical-align:top; - padding-right:0; + padding-right:0px; padding-top:8px; padding-bottom:3px; } -.table-header { +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { background:#dee3e9; - font-weight: bold; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; } -.col-first, .col-first { +.constantsSummary th, .packagesSummary th { font-size:13px; } -.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last { +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; font-size:13px; } -.col-first, .col-second, .col-constructor-name { +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { vertical-align:top; - overflow: auto; } -.col-last { +.packagesSummary th.colLast, .packagesSummary td.colLast { white-space:normal; } -.col-first a:link, .col-first a:visited, -.col-second a:link, .col-second a:visited, -.col-first a:link, .col-first a:visited, -.col-second a:link, .col-second a:visited, -.col-constructor-name a:link, .col-constructor-name a:visited, -.col-summary-item-name a:link, .col-summary-item-name a:visited, -.constant-values-container a:link, .constant-values-container a:visited, -.all-classes-container a:link, .all-classes-container a:visited, -.all-packages-container a:link, .all-packages-container a:visited { +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { font-weight:bold; } -.table-sub-heading-color { +.tableSubHeadingColor { background-color:#EEEEFF; } -.even-row-color, .even-row-color .table-header { +.altColor, .altColor th { background-color:#FFFFFF; } -.odd-row-color, .odd-row-color .table-header { +.rowColor, .rowColor th { background-color:#EEEEEF; } /* * Styles for contents. */ -.deprecated-content { +.description pre { + margin-top:0; +} +.deprecatedContent { margin:0; padding:10px 0; } +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} div.block { font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; } -.col-last div { - padding-top:0; +td.colLast div { + padding-top:0px; } -.col-last a { +td.colLast a { padding-bottom:3px; } -.module-signature, -.package-signature, -.type-signature, -.member-signature { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - margin:14px 0; - white-space: pre-wrap; -} -.module-signature, -.package-signature, -.type-signature { - margin-top: 0; -} -.member-signature .type-parameters-long, -.member-signature .parameters, -.member-signature .exceptions { - display: inline-block; - vertical-align: top; - white-space: pre; -} -.member-signature .type-parameters { - white-space: normal; -} /* * Styles for formatting effect. */ -.source-line-no { +.sourceLineNo { color:green; padding:0 30px 0 0; } @@ -545,29 +652,19 @@ h1.hidden { } .block { display:block; - margin:0 10px 5px 0; + margin:3px 10px 2px 0px; color:#474747; } -.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link, -.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type, -.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label { +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { font-weight:bold; } -.deprecation-comment, .help-footnote, .preview-comment { +.deprecationComment, .emphasizedPhrase, .interfaceName { font-style:italic; } -.deprecation-block { - font-size:14px; - font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; - border-style:solid; - border-width:thin; - border-radius:10px; - padding:10px; - margin-bottom:10px; - margin-right:10px; - display:inline-block; -} -.preview-block { +.deprecationBlock { font-size:14px; font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; border-style:solid; @@ -578,9 +675,68 @@ h1.hidden { margin-right:10px; display:inline-block; } -div.block div.deprecation-comment { +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { font-style:normal; } +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} /* * Styles specific to HTML5 elements. */ @@ -597,7 +753,7 @@ main, nav, header, footer, section { background-color:#4D7A97; color:#FFFFFF; } -.result-item { +.resultItem { font-size:13px; } .ui-autocomplete { @@ -611,16 +767,20 @@ main, nav, header, footer, section { ul.ui-autocomplete { position:fixed; z-index:999999; + background-color: #FFFFFF; } ul.ui-autocomplete li { float:left; clear:both; width:100%; } -.result-highlight { +.resultHighlight { font-weight:bold; } -#search-input { +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { background-image:url('resources/glass.png'); background-size:13px; background-repeat:no-repeat; @@ -628,9 +788,8 @@ ul.ui-autocomplete li { padding-left:20px; position:relative; right:-18px; - width:400px; } -#reset-button { +#reset { background-color: rgb(255,255,255); background-image:url('resources/x.png'); background-position:center; @@ -638,7 +797,7 @@ ul.ui-autocomplete li { background-size:12px; border:0 none; width:16px; - height:16px; + height:17px; position:relative; left:-4px; top:-4px; @@ -647,85 +806,28 @@ ul.ui-autocomplete li { .watermark { color:#545454; } -.search-tag-desc-result { +.searchTagDescResult { font-style:italic; font-size:11px; } -.search-tag-holder-result { +.searchTagHolderResult { font-style:italic; font-size:12px; } -.search-tag-result:target { - background-color:yellow; +.searchTagResult:before, .searchTagResult:target { + color:red; } -.module-graph span { +.moduleGraph span { display:none; position:absolute; } -.module-graph:hover span { +.moduleGraph:hover span { display:block; margin: -100px 0 0 100px; z-index: 1; } -.inherited-list { - margin: 10px 0 10px 0; -} -section.class-description { - line-height: 1.4; -} -.summary section[class$="-summary"], .details section[class$="-details"], -.class-uses .detail, .serialized-class-details { - padding: 0px 20px 5px 10px; - border: 1px solid #ededed; - background-color: #f8f8f8; -} -.inherited-list, section[class$="-details"] .detail { - padding:0 0 5px 8px; - background-color:#ffffff; - border:none; -} -.vertical-separator { - padding: 0 5px; -} -ul.help-section-list { - margin: 0; -} -ul.help-subtoc > li { - display: inline-block; - padding-right: 5px; - font-size: smaller; -} -ul.help-subtoc > li::before { - content: "\2022" ; - padding-right:2px; -} -span.help-note { - font-style: italic; -} -/* - * Indicator icon for external links. - */ -main a[href*="://"]::after { - content:""; - display:inline-block; - background-image:url('data:image/svg+xml; utf8, \ - \ - \ - '); - background-size:100% 100%; - width:7px; - height:7px; - margin-left:2px; - margin-bottom:4px; -} -main a[href*="://"]:hover::after, -main a[href*="://"]:focus::after { - background-image:url('data:image/svg+xml; utf8, \ - \ - \ - '); +.methodSignature { + white-space:normal; } /* @@ -806,60 +908,3 @@ table.striped > tbody > tr > th, table.striped > tbody > tr > td { table.striped > tbody > tr > th { font-weight: normal; } -/** - * Tweak font sizes and paddings for small screens. - */ -@media screen and (max-width: 1050px) { - #search-input { - width: 300px; - } -} -@media screen and (max-width: 800px) { - #search-input { - width: 200px; - } - .top-nav, - .bottom-nav { - font-size: 11px; - padding-top: 6px; - } - .sub-nav { - font-size: 11px; - } - .about-language { - padding-right: 16px; - } - ul.nav-list li, - .sub-nav .nav-list-search { - padding: 6px; - } - ul.sub-nav-list li { - padding-top: 5px; - } - main { - padding: 10px; - } - .summary section[class$="-summary"], .details section[class$="-details"], - .class-uses .detail, .serialized-class-details { - padding: 0 8px 5px 8px; - } - body { - -webkit-text-size-adjust: none; - } -} -@media screen and (max-width: 500px) { - #search-input { - width: 150px; - } - .top-nav, - .bottom-nav { - font-size: 10px; - } - .sub-nav { - font-size: 10px; - } - .about-language { - font-size: 10px; - padding-right: 12px; - } -} diff --git a/docs/site/apidocs/tag-search-index.js b/docs/site/apidocs/tag-search-index.js deleted file mode 100644 index bf10aaf6..00000000 --- a/docs/site/apidocs/tag-search-index.js +++ /dev/null @@ -1 +0,0 @@ -tagSearchIndex = [{"l":"Constant Field Values","h":"","u":"constant-values.html"},{"l":"Serialized Form","h":"","u":"serialized-form.html"}];updateSearchResults(); \ No newline at end of file diff --git a/docs/site/apidocs/type-search-index.js b/docs/site/apidocs/type-search-index.js index 41defa10..6b2efeb8 100644 --- a/docs/site/apidocs/type-search-index.js +++ b/docs/site/apidocs/type-search-index.js @@ -1 +1 @@ -typeSearchIndex = [{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"org.openpreservation.format.xml","l":"Attribute"},{"p":"org.openpreservation.odf.apps","l":"BuildVersionProvider"},{"p":"org.openpreservation.odf.validation","l":"Check"},{"p":"org.openpreservation.odf.validation","l":"CheckImpl"},{"p":"org.openpreservation.utils","l":"Checks"},{"p":"org.openpreservation.odf.apps","l":"ConsoleFormatter"},{"p":"org.openpreservation.odf.fmt","l":"Constants"},{"p":"org.openpreservation.odf.pkg","l":"Constants"},{"p":"org.openpreservation.odf.xml","l":"Constants"},{"p":"org.openpreservation.odf.apps","l":"DebugInfo"},{"p":"org.openpreservation.odf.document","l":"Documents"},{"p":"org.openpreservation.odf.xml","l":"DocumentType"},{"p":"org.openpreservation.odf.validation.rules","l":"EmbeddedObjectsRule"},{"p":"org.openpreservation.format.xml","l":"Encodings"},{"p":"org.openpreservation.odf.xml","l":"ExtendedConformanceFilter"},{"p":"org.openpreservation.format.zip","l":"ZipProcessor.Factory"},{"p":"org.openpreservation.odf.pkg","l":"FileEntry"},{"p":"org.openpreservation.odf.document","l":"FileType"},{"p":"org.openpreservation.odf.validation","l":"ValidationReports.FormatOption"},{"p":"org.openpreservation.odf.fmt","l":"Formats"},{"p":"org.openpreservation.odf.fmt","l":"FormatSniffer"},{"p":"org.openpreservation.odf.pkg","l":"Manifest"},{"p":"org.openpreservation.odf.validation.messages","l":"Message"},{"p":"org.openpreservation.odf.validation.messages","l":"MessageFactory"},{"p":"org.openpreservation.format.xml","l":"MessageHandler"},{"p":"org.openpreservation.odf.validation.messages","l":"MessageLog"},{"p":"org.openpreservation.odf.validation.messages","l":"Messages"},{"p":"org.openpreservation.odf.xml","l":"Metadata"},{"p":"org.openpreservation.format.xml","l":"Namespace"},{"p":"org.openpreservation.odf.document","l":"OdfDocument"},{"p":"org.openpreservation.odf.fmt","l":"OdfFormats"},{"p":"org.openpreservation.odf.xml","l":"OdfNamespaces"},{"p":"org.openpreservation.odf.pkg","l":"OdfPackage"},{"p":"org.openpreservation.odf.pkg","l":"OdfPackageDocument"},{"p":"org.openpreservation.odf.pkg","l":"OdfPackages"},{"p":"org.openpreservation.odf.xml","l":"OdfSchemaFactory"},{"p":"org.openpreservation.odf.validation","l":"OdfValidator"},{"p":"org.openpreservation.odf.validation","l":"OdfValidators"},{"p":"org.openpreservation.odf.xml","l":"OdfXmlDocument"},{"p":"org.openpreservation.odf.xml","l":"OdfXmlDocuments"},{"p":"org.openpreservation.odf.document","l":"OpenDocument"},{"p":"org.openpreservation.odf.pkg","l":"PackageParser"},{"p":"org.openpreservation.odf.validation.messages","l":"Parameter"},{"p":"org.openpreservation.odf.validation.messages","l":"Parameter.ParameterList"},{"p":"org.openpreservation.odf.pkg","l":"PackageParser.ParseException"},{"p":"org.openpreservation.format.xml","l":"ParseResult"},{"p":"org.openpreservation.format.xml","l":"ParsingHandler"},{"p":"org.openpreservation.odf.validation","l":"Profile"},{"p":"org.openpreservation.odf.validation","l":"Rule"},{"p":"org.openpreservation.odf.validation.rules","l":"Rules"},{"p":"org.openpreservation.odf.validation.messages","l":"Message.Severity"},{"p":"org.openpreservation.odf.fmt","l":"Signatures"},{"p":"org.openpreservation.odf","l":"Source"},{"p":"org.openpreservation.odf.xml","l":"Metadata.UserDefinedField"},{"p":"org.openpreservation.odf.fmt","l":"Utils"},{"p":"org.openpreservation.odf.validation","l":"ValidatingParser"},{"p":"org.openpreservation.odf.validation","l":"ValidationReport"},{"p":"org.openpreservation.odf.validation","l":"ValidationReports"},{"p":"org.openpreservation.odf.validation","l":"ValidationResult"},{"p":"org.openpreservation.odf.validation","l":"ValidationResultImpl"},{"p":"org.openpreservation.odf.xml","l":"Version"},{"p":"org.openpreservation.format.xml","l":"XmlParser"},{"p":"org.openpreservation.format.xml","l":"XmlParsers"},{"p":"org.openpreservation.format.xml","l":"XmlValidationResult"},{"p":"org.openpreservation.format.xml","l":"XmlValidationResults"},{"p":"org.openpreservation.format.xml","l":"XmlValidator"},{"p":"org.openpreservation.format.zip","l":"ZipArchive"},{"p":"org.openpreservation.format.zip","l":"ZipArchiveCache"},{"p":"org.openpreservation.format.zip","l":"ZipEntry"},{"p":"org.openpreservation.format.zip","l":"ZipEntryImpl"},{"p":"org.openpreservation.format.zip","l":"ZipEntryProcessor"},{"p":"org.openpreservation.format.zip","l":"ZipFileProcessor"},{"p":"org.openpreservation.format.zip","l":"ZipProcessor"},{"p":"org.openpreservation.format.zip","l":"Zips"}];updateSearchResults(); \ No newline at end of file +typeSearchIndex = [{"l":"All Classes","url":"allclasses-index.html"},{"p":"org.openpreservation.format.xml","l":"Attribute"},{"p":"org.openpreservation.odf.apps","l":"BuildVersionProvider"},{"p":"org.openpreservation.odf.validation","l":"Check"},{"p":"org.openpreservation.odf.validation","l":"CheckImpl"},{"p":"org.openpreservation.utils","l":"Checks"},{"p":"org.openpreservation.odf.apps","l":"ConsoleFormatter"},{"p":"org.openpreservation.odf.fmt","l":"Constants"},{"p":"org.openpreservation.odf.pkg","l":"Constants"},{"p":"org.openpreservation.odf.xml","l":"Constants"},{"p":"org.openpreservation.odf.apps","l":"DebugInfo"},{"p":"org.openpreservation.odf.document","l":"Documents"},{"p":"org.openpreservation.odf.xml","l":"DocumentType"},{"p":"org.openpreservation.odf.validation.rules","l":"EmbeddedObjectsRule"},{"p":"org.openpreservation.format.xml","l":"Encodings"},{"p":"org.openpreservation.odf.xml","l":"ExtendedConformanceFilter"},{"p":"org.openpreservation.format.zip","l":"ZipProcessor.Factory"},{"p":"org.openpreservation.odf.pkg","l":"FileEntry"},{"p":"org.openpreservation.odf.document","l":"FileType"},{"p":"org.openpreservation.odf.validation","l":"ValidationReports.FormatOption"},{"p":"org.openpreservation.odf.fmt","l":"Formats"},{"p":"org.openpreservation.odf.apps","l":"FormatsConverter"},{"p":"org.openpreservation.odf.fmt","l":"FormatSniffer"},{"p":"org.openpreservation.odf.pkg","l":"Manifest"},{"p":"org.openpreservation.odf.validation.messages","l":"Message"},{"p":"org.openpreservation.odf.validation.messages","l":"MessageFactory"},{"p":"org.openpreservation.format.xml","l":"MessageHandler"},{"p":"org.openpreservation.odf.validation.messages","l":"MessageLog"},{"p":"org.openpreservation.odf.validation.messages","l":"Messages"},{"p":"org.openpreservation.odf.xml","l":"Metadata"},{"p":"org.openpreservation.format.xml","l":"Namespace"},{"p":"org.openpreservation.odf.document","l":"OdfDocument"},{"p":"org.openpreservation.odf.fmt","l":"OdfFormats"},{"p":"org.openpreservation.odf.xml","l":"OdfNamespaces"},{"p":"org.openpreservation.odf.pkg","l":"OdfPackage"},{"p":"org.openpreservation.odf.pkg","l":"OdfPackageDocument"},{"p":"org.openpreservation.odf.pkg","l":"OdfPackages"},{"p":"org.openpreservation.odf.xml","l":"OdfSchemaFactory"},{"p":"org.openpreservation.odf.validation","l":"OdfValidator"},{"p":"org.openpreservation.odf.validation","l":"OdfValidators"},{"p":"org.openpreservation.odf.xml","l":"OdfXmlDocument"},{"p":"org.openpreservation.odf.xml","l":"OdfXmlDocuments"},{"p":"org.openpreservation.odf.validation","l":"OdfXmlValidator"},{"p":"org.openpreservation.odf.document","l":"OpenDocument"},{"p":"org.openpreservation.odf.pkg","l":"PackageParser"},{"p":"org.openpreservation.odf.validation.messages","l":"Parameter"},{"p":"org.openpreservation.odf.validation.messages","l":"Parameter.ParameterList"},{"p":"org.openpreservation.odf.pkg","l":"PackageParser.ParseException"},{"p":"org.openpreservation.format.xml","l":"ParseResult"},{"p":"org.openpreservation.format.xml","l":"ParsingHandler"},{"p":"org.openpreservation.odf.validation","l":"Profile"},{"p":"org.openpreservation.odf.validation","l":"Rule"},{"p":"org.openpreservation.odf.validation.rules","l":"Rules"},{"p":"org.openpreservation.odf.validation.messages","l":"Message.Severity"},{"p":"org.openpreservation.odf.fmt","l":"Signatures"},{"p":"org.openpreservation.odf","l":"Source"},{"p":"org.openpreservation.odf.xml","l":"Metadata.UserDefinedField"},{"p":"org.openpreservation.odf.fmt","l":"Utils"},{"p":"org.openpreservation.odf.validation","l":"ValidatingParser"},{"p":"org.openpreservation.odf.validation","l":"ValidationReport"},{"p":"org.openpreservation.odf.validation","l":"ValidationReports"},{"p":"org.openpreservation.odf.validation","l":"ValidationResult"},{"p":"org.openpreservation.odf.validation","l":"ValidationResultImpl"},{"p":"org.openpreservation.odf.xml","l":"Version"},{"p":"org.openpreservation.format.xml","l":"XmlParser"},{"p":"org.openpreservation.format.xml","l":"XmlParsers"},{"p":"org.openpreservation.format.xml","l":"XmlValidationResult"},{"p":"org.openpreservation.format.xml","l":"XmlValidationResults"},{"p":"org.openpreservation.format.xml","l":"XmlValidator"},{"p":"org.openpreservation.format.zip","l":"ZipArchive"},{"p":"org.openpreservation.format.zip","l":"ZipArchiveCache"},{"p":"org.openpreservation.format.zip","l":"ZipEntry"},{"p":"org.openpreservation.format.zip","l":"ZipEntryImpl"},{"p":"org.openpreservation.format.zip","l":"ZipEntryProcessor"},{"p":"org.openpreservation.format.zip","l":"ZipFileProcessor"},{"p":"org.openpreservation.format.zip","l":"ZipProcessor"},{"p":"org.openpreservation.format.zip","l":"Zips"}] \ No newline at end of file diff --git a/docs/site/apidocs/type-search-index.zip b/docs/site/apidocs/type-search-index.zip new file mode 100644 index 00000000..ea9c5255 Binary files /dev/null and b/docs/site/apidocs/type-search-index.zip differ diff --git a/docs/site/dependency-convergence.html b/docs/site/dependency-convergence.html index dabb9789..96144959 100644 --- a/docs/site/dependency-convergence.html +++ b/docs/site/dependency-convergence.html @@ -1,6 +1,6 @@ @@ -9,7 +9,7 @@ - ODF spreadsheet validator. – Reactor Dependency Convergence + ODF Document validator. – Reactor Dependency Convergence @@ -17,7 +17,7 @@