Sonar issues

+ fixed a small issue for PAM

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: haraldk

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,53 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: Reported bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Version information**
+1. The version of the TwelveMonkeys ImageIO library in use.
+For example:  4.0.0
+
+2. The *exact* output of `java --version` (or `java -version` for older Java releases). 
+For example: 
+
+    java version "1.8.0_271"
+    Java(TM) SE Runtime Environment (build 1.8.0_271-b09)
+    Java HotSpot(TM) 64-Bit Server VM (build 25.271-b09, mixed mode)
+
+3. Extra information about OS version, server version, standalone program or web application packaging, executable wrapper, etc. Please state exact version numbers where applicable.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Compile the below sample code
+2. Download the sample image file
+3. Run the code with the sample file
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Example code**
+Preferably as a failing JUnit test, or a standalone program with a `main` method that showcases the problem. 
+
+Less is more. Don't add your entire project, only the code required to reproduce the problem. 😀 
+
+**Sample file(s)**
+Attach any sample files needed to reproduce the problem. Use a ZIP-file if the format is not directly supported by GitHub.
+
+**Stak trace**
+Always include the stack trace you experience.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+Do not add screenshots of code or stack traces. 😀 
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: New feature
+assignees: ''
+
+---
+
+**Is your feature request related to a use case or a problem you are working on? Please describe.**
+A clear and concise description of what the problem or use case is. Understanding the rationale is key, to be able to implemeent the right solution. 
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've already considered, and why they won't work.
+
+**Additional context**
+Add any other context or screenshots about the feature request here, like links to specifications or sample files.

.github/ISSUE_TEMPLATE/trouble_shooting_and_programming_help.md

@@ -0,0 +1,13 @@
+---
+name: Trouble shooting and programming help
+about: "General programming issues will reach a wider audience at StackOverflow. Tag
+  questions with javax-imageio and/or twelvemonkeys \U0001F600 "
+title: ''
+labels: Trouble-shooting
+assignees: ''
+
+---
+
+General programming issues and problems will reach a much wider audience at StackOverflow, we suggest you ask them there. This will offload our work with maintaining the library, and make sure you get better help sooner.
+
+Tag the question with `javax-imageio` and/or `twelvemonkeys` and we'll find them there.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,11 @@
+**What is fixed** Add link to the issue this PR fixes. 
+
+Example: Fixes #42. 
+
+**Why is this change proposed** If this change does *not* fix an open issue, briefly describe the rationale for this PR.
+
+**What is changed** Briefly describe the changes proposed in this pull request: 
+
+* Fixed rare exception happening in `x >= 42` case
+* Small optimization of `decompress()` method
+* Corrected API doc for `compress()` method to reflect current implementation 

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  # Maven/Java library updates
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 7
+    open-pull-requests-limit: 10
+  # GitHub actions updates
+  - package-ecosystem: "github-actions"
+    directory: "/.github/workflows"
+    schedule:
+      interval: "daily"
+    cooldown:
+      default-days: 7

.github/workflows/ci.yml

@@ -0,0 +1,143 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - '**'
+      - '!dependabot/**'
+  pull_request:
+    branches: [ 'master' ]
+
+permissions: read-all
+
+jobs:
+  test:
+    name: Test OpenJDK ${{ matrix.java }} on ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        java: [ 8, 11, 17, 21, 25 ]
+        exclude:
+          - os: macos-latest
+            java: 8
+    runs-on: ${{ matrix.os }}
+    permissions:
+      checks: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
+          java-package: jdk
+          cache: 'maven'
+      - name: Run Tests
+        run: mvn --batch-mode --no-transfer-progress test
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@74626db7353a25a20a72816467ebf035f674c5f8 # v5
+        if: ${{ !cancelled() }}
+        with:
+          report_paths: "**/target/surefire-reports/TEST*.xml"
+          check_name: Unit Test Results for OpenJDK ${{ matrix.java }} on ${{ matrix.os }}
+
+  test-jdk8-macos:
+    name: Test OpenJDK 8 on macos-14
+    runs-on: macos-14
+    permissions:
+      checks: write
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          distribution: 'zulu'
+          java-version: '8'
+          java-package: jdk
+          cache: 'maven'
+      - name: Run Tests
+        run: mvn --batch-mode --no-transfer-progress test
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@74626db7353a25a20a72816467ebf035f674c5f8 # v5
+        if: ${{ !cancelled() }}
+        with:
+          report_paths: "**/target/surefire-reports/TEST*.xml"
+          check_name: Unit Test Results for OpenJDK ${{ matrix.java }} on ${{ matrix.os }}
+
+  test-oracle:
+    name: Test Oracle JDK 8 with KCMS=${{ matrix.kcms }}
+    runs-on: ubuntu-latest
+    permissions:
+      checks: write
+    strategy:
+      matrix:
+        kcms: [ true, false ]
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - run: |
+          download_url="https://javadl.oracle.com/webapps/download/AutoDL?BundleId=245038_d3c52aa6bfa54d3ca74e617f18309292"
+          wget -O $RUNNER_TEMP/java_package.tar.gz $download_url
+      - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          distribution: 'jdkfile'
+          jdkFile: ${{ runner.temp }}/java_package.tar.gz
+          java-version: '8'
+          cache: 'maven'
+      - name: Set MAVEN_OPTS
+        if: ${{ matrix.kcms }}
+        run: |
+          echo "MAVEN_OPTS=-Dsun.java2d.cmm=sun.java2d.cmm.kcms.KcmsServiceProvider" >> $GITHUB_ENV
+      - name: Display Java version
+        run: java -version
+      - name: Run Tests
+        run: mvn --batch-mode --no-transfer-progress test
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@74626db7353a25a20a72816467ebf035f674c5f8 # v5
+        if: ${{ !cancelled() }}
+        with:
+          report_paths: "**/target/surefire-reports/TEST*.xml"
+          check_name: Unit Test Results for Oracle JDK 8 with KCMS=${{ matrix.kcms }}
+
+  javadoc:
+    name: Build JavaDoc on OpenJDK ${{ matrix.java }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [8, 11, 25 ] # We only need a few versions here
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with:
+          distribution: 'temurin'
+          java-version: ${{ matrix.java }}
+          java-package: jdk
+          cache: 'maven'
+      - name: Create JavaDoc
+        run: mvn --batch-mode --no-transfer-progress -DskipTests package javadoc:javadoc
+
+  release:
+    name: Deploy
+    needs: [ test, test-jdk8-macos, test-oracle, javadoc ]
+    if: github.ref == 'refs/heads/master' # only perform on latest master
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+      - name: Set up Maven Central
+        uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0
+        with: # running setup-java again overwrites the settings.xml
+          distribution: 'temurin'
+          java-version: '8'
+          java-package: jdk
+          server-id: central # Value of the distributionManagement/repository/id field of the pom.xml
+          server-username: MAVEN_CENTRAL_USERNAME # env variable for username in deploy (1)
+          server-password: MAVEN_CENTRAL_PASSWORD # env variable for token in deploy (2)
+      - name: Get Project Version
+        run: |
+          echo "PROJECT_VERSION=$(mvn --batch-mode help:evaluate -Dexpression=project.version -q -DforceStdout)" >> $GITHUB_ENV
+      - name: Publish to Maven Central
+        if: ${{ endsWith(env.PROJECT_VERSION, '-SNAPSHOT') }}
+        run: mvn --batch-mode --no-transfer-progress deploy -P release -DskipTests -Dgpg.signer=bc
+        env:
+          MAVEN_CENTRAL_USERNAME: ${{ secrets.CENTRAL_USERNAME }} # must be the same env variable name as (1)
+          MAVEN_CENTRAL_PASSWORD: ${{ secrets.CENTRAL_PASSWORD }} # must be the same env variable name as (2)
+          MAVEN_GPG_KEY: ${{ secrets.GPG_KEY }}                    # Value of the GPG private key to import
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}

.github/workflows/codeql.yml

@@ -0,0 +1,69 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "master" ]
+  schedule:
+    - cron: '26 13 * * 6'
+
+permissions: {}
+
+jobs:
+  analyze:
+    name: Analyze
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners
+    # Consider using larger runners for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'java' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/scorecard.yml

@@ -0,0 +1,62 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '38 8 * * 2'
+  push:
+    branches: [ "master" ]
+
+permissions: read-all # Declare default permissions as read only.
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write  # to upload the results to code-scanning dashboard.
+      id-token: write # to publish results and get a badge
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # you want to enable the Branch-Protection check on the repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-fine-grained-pat-optional.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Publish Results:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      - name: "Upload artifact"
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+        with:
+          name: SARIF file
+          path: results.sarif
+          retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard.
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@89a39a4e59826350b863aa6b6252a07ad50cf83e # v4.32.4
+        with:
+          sarif_file: results.sarif

.gitignore

@@ -15,3 +15,4 @@ private
 profiles.xml
 Thumbs.db
 .DS_Store
+/.metadata/

.travis.yml

@@ -1,13 +0,0 @@
-language: java
-jdk:
-  - oraclejdk8
-# Oracle JDK 7 no longer supported, we use env matrix to test various CMM providers
-#  - oraclejdk7
-# Some JPEGImageReader tests fail on OpenJDK, need to investigate/fix before enabling
-#  - openjdk7
-env:
-  - MAVEN_OPTS=-Dsun.java2d.cmm=sun.java2d.cmm.kcms.KcmsServiceProvider
-  - MAVEN_OPTS=""
-cache:
-  directories:
-  - $HOME/.m2

LICENSE.txt

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2017, Harald Kuhr
+Copyright (c) 2008-2020, Harald Kuhr
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,261 +1,85 @@
-## Latest
+[![CI](https://github.com/haraldk/TwelveMonkeys/actions/workflows/ci.yml/badge.svg)](https://github.com/haraldk/TwelveMonkeys/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/haraldk/TwelveMonkeys/actions/workflows/codeql.yml/badge.svg)](https://github.com/haraldk/TwelveMonkeys/actions/workflows/codeql.yml)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/haraldk/TwelveMonkeys/badge)](https://securityscorecards.dev/viewer/?uri=github.com/haraldk/TwelveMonkeys)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7900/badge)](https://www.bestpractices.dev/projects/7900)
 
-Master branch build status: [![Build Status](https://travis-ci.org/haraldk/TwelveMonkeys.svg?branch=master)](https://travis-ci.org/haraldk/TwelveMonkeys)
+[![Maven Central](https://img.shields.io/maven-central/v/com.twelvemonkeys.imageio/imageio?color=slateblue)](https://search.maven.org/search?q=g:com.twelvemonkeys.imageio)
+[![Maven Snapshot](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fcentral.sonatype.com%2Frepository%2Fmaven-snapshots%2Fcom%2Ftwelvemonkeys%2Fimageio%2Fimageio%2Fmaven-metadata.xml&label=development&server=https%3A%2F%2Foss.sonatype.org&color=slateblue)](https://central.sonatype.com/repository/maven-snapshots/com/twelvemonkeys/imageio/imageio/maven-metadata.xml)
+[![StackOverflow](https://img.shields.io/badge/stack_overflow-twelvemonkeys-orange.svg)](https://stackoverflow.com/questions/tagged/twelvemonkeys)
+[![Donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://paypal.me/haraldk76/100)
 
-Latest release is TwelveMonkeys ImageIO [3.3.2](http://search.maven.org/#search%7Cga%7C1%7Cg%3Acom.twelvemonkeys*%20AND%20v%3A%223.3.2%22) (Feb. 2nd, 2017).
-[Release notes](https://github.com/haraldk/TwelveMonkeys/releases/latest).
+![Logo](logo.png)
 
 ## About
 
-TwelveMonkeys ImageIO is a collection of plugins and extensions for Java's ImageIO.
+TwelveMonkeys ImageIO provides extended image file format support for the Java platform, through plugins for the `javax.imageio.*` package.
 
-These plugins extends the number of image file formats supported in Java, using the javax.imageio.* package.
-The main purpose of this project is to provide support for formats not covered by the JRE itself.
-
-Support for formats is important, both to be able to read data found
+The main goal of this project is to provide support for file formats not covered by the JDK. 
+Support for these formats is important, to be able to read data found
 "in the wild", as well as to maintain access to data in legacy formats.
-Because there is lots of legacy data out there, we see the need for open implementations of readers for popular formats.
-The goal is to create a set of efficient and robust ImageIO plug-ins, that can be distributed independently.
+As there is lots of legacy data out there, we see the need for open implementations of readers for popular formats.
 
 ----
 
-## Features
+## File formats supported
 
-Mainstream format support
+| Plugin | Format   | Description                                             | R |  W  | Metadata | Notes |
+| ------ | -------- |---------------------------------------------------------|:---:|:---:| -------- | ----- |
+| Batik  | **SVG**  | Scalable Vector Graphics                                | ✔ |  -  | - | Requires [Batik](https://xmlgraphics.apache.org/batik/) |
+|        | WMF      | MS Windows Metafile                                     | ✔ |  -  | - | Requires [Batik](https://xmlgraphics.apache.org/batik/) |
+| [BMP](https://github.com/haraldk/TwelveMonkeys/wiki/BMP-Plugin)    | **BMP**  | MS Windows and IBM OS/2 Device Independent Bitmap       | ✔  |  ✔  | [Native](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/bmp_metadata.html), [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) |
+|        | CUR      | MS Windows Cursor Format                                | ✔  |  -  | - |
+|        | ICO      | MS Windows Icon Format                                  | ✔  |  ✔  | - |
+| [DDS](https://github.com/haraldk/TwelveMonkeys/wiki/DDS-Plugin)   | DDS           | MS Direct Draw Surface Format                           | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) |
+| [HDR](https://github.com/haraldk/TwelveMonkeys/wiki/HDR-Plugin)    | HDR      | Radiance High Dynamic Range RGBE Format                 | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [ICNS](https://github.com/haraldk/TwelveMonkeys/wiki/ICNS-Plugin)   | ICNS     | Apple Icon Image                                        | ✔  |  ✔  | -  | 
+| [IFF](https://github.com/haraldk/TwelveMonkeys/wiki/IFF-Plugin)    | IFF      | Commodore Amiga/Electronic Arts Interchange File Format | ✔  |  ✔  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [JPEG](https://github.com/haraldk/TwelveMonkeys/wiki/JPEG-Plugin)   | **JPEG** | Joint Photographers Expert Group                        | ✔  |  ✔  | [Native](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/jpeg_metadata.html#image), [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|   | JPEG Lossless |                                                         | ✔  |  -  | [Native](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/jpeg_metadata.html#image), [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [PCX](https://github.com/haraldk/TwelveMonkeys/wiki/PCX-Plugin)    | PCX      | ZSoft Paintbrush Format                                 | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | DCX      | Multi-page PCX fax document                             | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [PICT](https://github.com/haraldk/TwelveMonkeys/wiki/PICT-Plugin)   | PICT     | Apple QuickTime Picture Format                          | ✔  |  ✔  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | PNTG     | Apple MacPaint Picture Format                           | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [PNM](https://github.com/haraldk/TwelveMonkeys/wiki/PNM-Plugin)    | PAM      | NetPBM Portable Any Map                                 | ✔  |  ✔  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | PBM      | NetPBM Portable Bit Map                                 | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | PGM      | NetPBM Portable Grey Map                                | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | PPM      | NetPBM Portable Pix Map                                 | ✔  |  ✔  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | PFM      | Portable Float Map                                      | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [PSD](https://github.com/haraldk/TwelveMonkeys/wiki/PSD-Plugin)    | **PSD**  | Adobe Photoshop Document                                | ✔  | (✔) | Native, [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) |  
+|        |  PSB     | Adobe Photoshop Large Document                          | ✔  |  -  | Native, [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [SGI](https://github.com/haraldk/TwelveMonkeys/wiki/SGI-Plugin)    | SGI      | Silicon Graphics Image Format                           | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+| [TGA](https://github.com/haraldk/TwelveMonkeys/wiki/TGA-Plugin)    | TGA      | Truevision TGA Image Format                             | ✔  |  ✔  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|ThumbsDB| Thumbs.db| MS Windows Thumbs DB                                    | ✔  |  -  | - | OLE2 Compound Document based format only |
+| [TIFF](https://github.com/haraldk/TwelveMonkeys/wiki/TIFF-Plugin)   | **TIFF** | Aldus/Adobe Tagged Image File Format                    | ✔  |  ✔  | [Native](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/tiff_metadata.html#ImageMetadata), [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
+|        | BigTIFF  |                                                         | ✔  |  ✔  | [Native](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/tiff_metadata.html#ImageMetadata), [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) |  
+| [WebP](https://github.com/haraldk/TwelveMonkeys/wiki/WebP-Plugin)   | **WebP** | Google WebP Format                                      | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) |  
+| XWD    | XWD      | X11 Window Dump Format                                  | ✔  |  -  | [Standard](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/metadata/doc-files/standard_metadata.html) | 
 
-#### BMP - MS Windows/IBM OS/2 Device Independent Bitmap
- 
-* Read support for all known versions of the DIB/BMP format
-  * Indexed color, 1, 4 and 8 bit, including 4 and 8 bit RLE
-  * RGB, 16, 24 and 32 bit
-  * Embedded PNG and JPEG data
-  * Windows and OS/2 versions
-* Native and standard metadata format
 
-#### JPEG
-
-* Read support for the following JPEG "flavors":
-  * All JFIF compliant JPEGs
-  * All Exif compliant JPEGs
-  * YCbCr JPEGs without JFIF segment (converted to RGB, using embedded ICC profile)
-  * CMYK JPEGs (converted to RGB by default or as CMYK, using embedded ICC profile)
-  * Adobe YCCK JPEGs (converted to RGB by default or as CMYK, using embedded ICC profile)
-  * JPEGs containing ICC profiles with interpretation other than 'Perceptual' or class other than 'Display'
-  * JPEGs containing ICC profiles that are incompatible with stream data, corrupted ICC profiles or corrupted `ICC_PROFILE` segments
-  * JPEGs using non-standard color spaces, unsupported by Java 2D
-  * JPEGs with APP14/Adobe segments with length other than 14 bytes
-  * 8 bit JPEGs with 16 bit DQT segments
-  * Issues warnings instead of throwing exceptions in cases of corrupted or non-conformant data where ever the image 
-  data can still be read in a reasonable way
-* Thumbnail support:
-  * JFIF thumbnails (even if stream contains "inconsistent metadata")
-  * JFXX thumbnails (JPEG, Indexed and RGB)
-  * EXIF thumbnails (JPEG, RGB and YCbCr)
-* Metadata support:
-  * JPEG metadata in both standard and native formats (even if stream contains "inconsistent metadata")
-  * `javax_imageio_jpeg_image_1.0` format (currently as native format, may change in the future)
-  * Non-conforming combinations of JFIF, Exif and Adobe markers, using "unknown" segments in the
-   "MarkerSequence" tag for the unsupported segments (for `javax_imageio_jpeg_image_1.0` format)
-* Extended write support in progress:
-  * CMYK JPEGs
-  * YCCK JPEGs
-
-#### JPEG-2000
-
-* Possibly coming in the future, pending some license issues.
-
-If you are one of the authors, or know one of the authors and/or the current license holders of either the original
-jj2000 package or the JAI ImageIO project, please contact me (I've tried to get in touch in various ways, 
-without success so far).
-
-Alternatively, if you have or know of a JPEG-2000 implementation in Java with a suitable license, get in touch. :-)
-
-#### PNM - NetPBM Portable Any Map
-
-* Read support for the following file types:
-  * PBM in 'P1' (ASCII) and 'P4' (binary) formats, 1 bit per pixel
-  * PGM in 'P2' (ASCII) and 'P5' (binary) formats, up to 16/32 bits per pixel
-  * PPM in 'P3' (ASCII) and 'P6' (binary) formats, up to 16/32 bits per pixel component
-  * PAM in 'P7' (binary) format up to 32 bits per pixel component
-  * Limited support for PFM in 'Pf' (gray) and 'PF' (RGB) formats, 32 bits floating point
-* Write support for the following formats:
-  * PPM in 'P6' (binary) format
-  * PAM in 'P7' (binary) format
-* Standard metadata support
-
-#### PSD - Adobe Photoshop Document
-
-* Read support for the following file types:
-  * Monochrome, 1 channel, 1 bit
-  * Indexed, 1 channel, 8 bit
-  * Gray, 1 channel, 8, 16 and 32 bit
-  * Duotone, 1 channel, 8, 16 and 32 bit
-  * RGB, 3-4 channels, 8, 16 and 32 bit
-  * CMYK, 4-5 channels, 8, 16 and 32 bit
-* Read support for the following compression types:
-  * Uncompressed
-  * RLE (PackBits)
-* Layer support
-  * Image layers only, in all of the above types
-* Thumbnail support
-  * JPEG
-  * RAW (RGB)
-* Support for "Large Document Format" (PSB)
-* Native and Standard metadata support
-
-#### TIFF - Aldus/Adobe Tagged Image File Format
-
-* Read support for the following "Baseline" TIFF file types:
-  * Class B (Bi-level), all relevant compression types, 1 bit per sample
-  * Class G (Gray), all relevant compression types, 2, 4, 8, 16 or 32 bits per sample, unsigned integer
-  * Class P (Palette/indexed color), all relevant compression types, 1, 2, 4, 8 or 16 bits per sample, unsigned integer
-  * Class R (RGB), all relevant compression types, 8 or 16 bits per sample, unsigned integer
-* Read support for the following TIFF extensions:
-  * Tiling
-  * Class F (Facsimile), CCITT Modified Huffman RLE, T4 and T6 (type 2, 3 and 4) compressions.
-  * LZW Compression (type 5)
-  * "Old-style" JPEG Compression (type 6), as a best effort, as the spec is not well-defined
-  * JPEG Compression (type 7)
-  * ZLib (aka Adobe-style Deflate) Compression (type 8)
-  * Deflate Compression (type 32946)
-  * Horizontal differencing Predictor (type 2) for LZW, ZLib, Deflate and PackBits compression
-  * Alpha channel (ExtraSamples type 1/Associated Alpha and type 2/Unassociated Alpha)
-  * CMYK data (PhotometricInterpretation type 5/Separated)
-  * YCbCr data (PhotometricInterpretation type 6/YCbCr) for JPEG
-  * CIELab data in TIFF, ITU and ICC variants (PhotometricInterpretation type 9, 10 and 11)
-  * Planar data (PlanarConfiguration type 2/Planar)
-  * ICC profiles (ICCProfile)
-  * BitsPerSample values up to 16 for most PhotometricInterpretations
-  * Multiple images (pages) in one file
-* Write support for most "Baseline" TIFF options
-  * Uncompressed, PackBits, ZLib and Deflate 
-  * Additional support for CCITT T4 and and T6 compressions.
-  * Additional support for LZW and JPEG (type 7) compressions
-  * Horizontal differencing Predictor (type 2) for LZW, ZLib, Deflate
-* Native and Standard metadata support
-
-Legacy formats
-
-#### HDR - Radiance High Dynamic Range RGBE Format
-
-* Read support for the most common RGBE (.hdr) format
-* Samples are converted to 32 bit floating point (`float`) and normalized using a global tone mapper by default.
-  * Support for custom global tone mappers
-  * Alternatively, use a "null-tone mapper", for unnormalized data (allows local tone mapping)
-* Unconverted RGBE samples accessible using `readRaster`
-* Standard metadata support
-
-#### IFF - Commodore Amiga/Electronic Arts Interchange File Format
-
-* Legacy format, allows reading popular image format from the Commodore Amiga computer.
-* Read support for the following file types:
-  * ILBM Indexed color, 1-8 interleaved bit planes, including 6 bit EHB
-  * ILBM  Gray, 8 bit interleaved bit planes
-  * ILBM RGB, 24 and 32 bit interleaved bit planes
-  * ILBM HAM6 and HAM8
-  * PBM Indexed color, 1-8 bit,
-  * PBM Gray, 8 bit
-  * PBM RGB, 24 and 32 bit
-  * PBM HAM6 and HAM8
-* Write support
-  * ILBM Indexed color, 1-8 bits per sample, 8 bit gray, 24 and 32 bit true color.
-* Support for the following compression types (read/write):
-  * Uncompressed
-  * RLE (PackBits)
-
-#### PCX - ZSoft Paintbrush Format
-
-* Read support for the following file types:
-  * Indexed color, 1, 2, 4 or 8 bits per pixel, bit planes or interleaved
-  * Grayscale, 8 bits per pixel
-  * Color (RGB), 8 bits per pixel component
-* Read support for DCX (multi-page) fax format, containing any of the above types
-* Support for the following compression types:
-  * Uncompressed (experimental)
-  * RLE compressed
-* Standard metadata support
-
-#### PICT - Apple Mac Paint Picture Format
-
-* Legacy format, especially useful for reading OS X clipboard data.
-* Read support for the following file types:
-  * QuickDraw (format support is not complete, but supports most OS X clipboard data as well as RGB pixel data)
-  * QuickDraw bitmap
-  * QuickDraw pixmap
-  * QuickTime stills
-* Write support for RGB pixel data:
-  * QuickDraw pixmap
-
-#### SGI - Silicon Graphics Image Format
-
-* Read support for the following file types:
-  * 1, 2, 3 or 4 channel image data
-  * 8 or 16 bits per pixel component
-* Support for the following compression types:
-  * Uncompressed
-  * RLE compressed
-* Standard metadata support
-
-#### TGA - Truevision TGA Image Format
-
-* Read support for the following file types:
-  * ColorMapped
-  * Monochrome
-  * TrueColor
-* Support for the following compression types:
-  * Uncompressed
-  * RLE compressed
-* Standard metadata support
-
-Icon/other formats
-
-#### ICNS - Apple Icon Image
-
-* Read support for the following icon types:
-  * All known "native" icon types
-  * Large PNG encoded icons
-  * Large JPEG 2000 encoded icons (requires JPEG 2000 ImageIO plugin or fallback to `sips` command line tool)
-
-#### ICO & CUR - MS Windows Icon and Cursor Formats
-
-* Read support for the following file types:
-  * ICO Indexed color, 1, 4 and 8 bit
-  * ICO RGB, 16, 24 and 32 bit
-  * CUR Indexed color, 1, 4 and 8 bit
-  * CUR RGB, 16, 24 and 32 bit
-* *3.1* Note: These formats are now part of the BMP plugin
-
-#### Thumbs.db - MS Windows Thumbs DB
-
-* Read support
-
-Other formats, using 3rd party libraries
-
-#### SVG - Scalable Vector Graphics
-
-* Read-only support using Batik
-
-#### WMF - MS Windows MetaFile
-
-* Limited read-only support using Batik
-
-**Important note on using Batik:** *Please read [The Apache™ XML Graphics Project - Security](http://xmlgraphics.apache.org/security.html), and make sure you use
-either version 1.6.1, 1.7.1 or 1.8+.*
+**Important note on using Batik:** *Please read [The Apache™ XML Graphics Project - Security](https://xmlgraphics.apache.org/security.html), 
+and make sure you use an updated and secure version.*
 
+Note that GIF, PNG and WBMP formats are already supported through the ImageIO API, using the
+[JDK standard plugins](https://docs.oracle.com/en/java/javase/11/docs/api/java.desktop/javax/imageio/package-summary.html).
+For BMP, JPEG, and TIFF formats the TwelveMonkeys plugins provides extended format support and additional features.
 
 ## Basic usage
 
 Most of the time, all you need to do is simply include the plugins in your project and write:
 
-    BufferedImage image = ImageIO.read(file);
+```java
+BufferedImage image = ImageIO.read(file);
+```
 
 This will load the first image of the file, entirely into memory.
 
 The basic and simplest form of writing is:
 
-    if (!ImageIO.write(image, format, file)) {
-       // Handle image not written case
-    }
+```java
+if (!ImageIO.write(image, format, file)) {
+   // Handle image not written case
+}
+```
 
 This will write the entire image into a single file, using the default settings for the given format.
 
@@ -265,50 +89,46 @@ The plugins are discovered automatically at run time. See the [FAQ](#faq) for mo
 
 If you need more control of read parameters and the reading process, the common idiom for reading is something like:
 
-    // Create input stream
-    ImageInputStream input = ImageIO.createImageInputStream(file);
+```java
+// Create input stream (in try-with-resource block to avoid leaks)
+try (ImageInputStream input = ImageIO.createImageInputStream(file)) {
+    // Get the reader
+    Iterator<ImageReader> readers = ImageIO.getImageReaders(input);
+
+    if (!readers.hasNext()) {
+        throw new IllegalArgumentException("No reader for: " + file);
+    }
+
+    ImageReader reader = readers.next();
 
     try {
-        // Get the reader
-        Iterator<ImageReader> readers = ImageIO.getImageReaders(input);
+        reader.setInput(input);
 
-        if (!readers.hasNext()) {
-            throw new IllegalArgumentException("No reader for: " + file);
-        }
+        // Optionally, listen for read warnings, progress, etc.
+        reader.addIIOReadWarningListener(...);
+        reader.addIIOReadProgressListener(...);
 
-        ImageReader reader = readers.next();
+        ImageReadParam param = reader.getDefaultReadParam();
 
-        try {
-            reader.setInput(input);
+        // Optionally, control read settings like sub sampling, source region or destination etc.
+        param.setSourceSubsampling(...);
+        param.setSourceRegion(...);
+        param.setDestination(...);
+        // ...
 
-            // Optionally, listen for read warnings, progress, etc.
-            reader.addIIOReadWarningListener(...);
-            reader.addIIOReadProgressListener(...);
+        // Finally read the image, using settings from param
+        BufferedImage image = reader.read(0, param);
 
-            ImageReadParam param = reader.getDefaultReadParam();
-
-            // Optionally, control read settings like sub sampling, source region or destination etc.
-            param.setSourceSubsampling(...);
-            param.setSourceRegion(...);
-            param.setDestination(...);
-            // ...
-
-            // Finally read the image, using settings from param
-            BufferedImage image = reader.read(0, param);
-
-            // Optionally, read thumbnails, meta data, etc...
-            int numThumbs = reader.getNumThumbnails(0);
-            // ...
-        }
-        finally {
-            // Dispose reader in finally block to avoid memory leaks
-            reader.dispose();
-        }
+        // Optionally, read thumbnails, meta data, etc...
+        int numThumbs = reader.getNumThumbnails(0);
+        // ...
     }
     finally {
-        // Close stream in finally block to avoid resource leaks
-        input.close();
+        // Dispose reader in finally block to avoid memory leaks
+        reader.dispose();
     }
+}
+```
 
 Query the reader for source image dimensions using `reader.getWidth(n)` and `reader.getHeight(n)` without reading the
 entire image into memory first.
@@ -318,129 +138,142 @@ It's also possible to read multiple images from the same file in a loop, using `
 
 If you need more control of write parameters and the writing process, the common idiom for writing is something like:
 
-    // Get the writer
-    Iterator<ImageWriter> writers = ImageIO.getImageWritersByFormatName(format);
+```java
+// Get the writer
+Iterator<ImageWriter> writers = ImageIO.getImageWritersByFormatName(format);
 
-    if (!writers.hasNext()) {
-        throw new IllegalArgumentException("No writer for: " + format);
-    }
-
-    ImageWriter writer = writers.next();
-
-    try {
-        // Create output stream
-        ImageOutputStream output = ImageIO.createImageOutputStream(file);
-
-        try {
-            writer.setOutput(output);
-
-            // Optionally, listen to progress, warnings, etc.
-
-            ImageWriteParam param = writer.getDefaultWriteParam();
-
-            // Optionally, control format specific settings of param (requires casting), or
-            // control generic write settings like sub sampling, source region, output type etc.
-
-            // Optionally, provide thumbnails and image/stream metadata
-            writer.write(..., new IIOImage(..., image, ...), param);
-        }
-        finally {
-            // Close stream in finally block to avoid resource leaks
-            output.close();
-        }
-    }
-    finally {
-        // Dispose writer in finally block to avoid memory leaks
-        writer.dispose();
+if (!writers.hasNext()) {
+    throw new IllegalArgumentException("No writer for: " + format);
+}
+
+ImageWriter writer = writers.next();
+
+try {
+    // Create output stream (in try-with-resource block to avoid leaks)
+    try (ImageOutputStream output = ImageIO.createImageOutputStream(file)) {
+        writer.setOutput(output);
+
+        // Optionally, listen to progress, warnings, etc.
+
+        ImageWriteParam param = writer.getDefaultWriteParam();
+
+        // Optionally, control format specific settings of param (requires casting), or
+        // control generic write settings like sub sampling, source region, output type etc.
+
+        // Optionally, provide thumbnails and image/stream metadata
+        writer.write(..., new IIOImage(..., image, ...), param);
     }
+}
+finally {
+    // Dispose writer in finally block to avoid memory leaks
+    writer.dispose();
+}
+```
 
 For more advanced usage, and information on how to use the ImageIO API, I suggest you read the
-[Java Image I/O API Guide](http://docs.oracle.com/javase/7/docs/technotes/guides/imageio/spec/imageio_guideTOC.fm.html)
+[Java Image I/O API Guide](https://docs.oracle.com/javase/7/docs/technotes/guides/imageio/spec/imageio_guideTOC.fm.html)
 from Oracle.
 
+#### Adobe Clipping Path support
 
-#### Deploying the plugins in a web app
+```java
+import com.twelvemonkeys.imageio.path.Paths;
 
-Because the `ImageIO` plugin registry (the `IIORegistry`) is "VM global", it doesn't by default work well with
-servlet contexts. This is especially evident if you load plugins from the `WEB-INF/lib` or `classes` folder.
-Unless you add `ImageIO.scanForPlugins()` somewhere in your code, the plugins might never be available at all.
+...
 
-In addition, servlet contexts dynamically loads and unloads classes (using a new class loader per context).
-If you restart your application, old classes will by default remain in memory forever (because the next time
-`scanForPlugins` is called, it's another `ClassLoader` that scans/loads classes, and thus they will be new instances
-in the registry). If a read is attempted using one of the remaining "old" readers, weird exceptions
-(like `NullPointerException`s when accessing `static final` initialized fields or `NoClassDefFoundError`s 
-for uninitialized inner classes) may occur.
+try (ImageInputStream stream = ImageIO.createImageInputStream(new File("image_with_path.jpg")) {
+    BufferedImage image = Paths.readClipped(stream);
 
-To work around both the discovery problem and the resource leak,
-it is *strongly recommended* to use the `IIOProviderContextListener` that implements
-dynamic loading and unloading of ImageIO plugins for web applications.
+    // Do something with the clipped image...
+}
+```
+See [Adobe Clipping Path support on the Wiki](https://github.com/haraldk/TwelveMonkeys/wiki/Photoshop-Clipping-Path-support) for more details and example code.
 
-    <web-app ...>
-
-    ...
-
-        <listener>
-            <display-name>ImageIO service provider loader/unloader</display-name>
-            <listener-class>com.twelvemonkeys.servlet.image.IIOProviderContextListener</listener-class>
-        </listener>
-
-    ...
-
-    </web-app>
-
-Loading plugins from `WEB-INF/lib` without the context listener installed is unsupported and will not work correctly.
-
-The context listener has no dependencies to the TwelveMonkeys ImageIO plugins, and may be used with JAI ImageIO 
-or other ImageIO plugins as well.
-
-Another safe option, is to place the JAR files in the application server's shared or common lib folder. 
 
 #### Using the ResampleOp
 
 The library comes with a resampling (image resizing) operation, that contains many different algorithms
 to provide excellent results at reasonable speed.
 
-    import com.twelvemonkeys.image.ResampleOp;
+```java
+import com.twelvemonkeys.image.ResampleOp;
 
-    ...
+...
 
-    BufferedImage input = ...; // Image to resample
-    int width, height = ...; // new width/height
-
-    BufferedImageOp resampler = new ResampleOp(width, height, ResampleOp.FILTER_LANCZOS); // A good default filter, see class documentation for more info
-    BufferedImage output = resampler.filter(input, null);
+BufferedImage input = ...; // Image to resample
+int width, height = ...; // new width/height
 
+BufferedImageOp resampler = new ResampleOp(width, height, ResampleOp.FILTER_LANCZOS); // A good default filter, see class documentation for more info
+BufferedImage output = resampler.filter(input, null);
+```
 
 #### Using the DiffusionDither
 
 The library comes with a dithering operation, that can be used to convert `BufferedImage`s to `IndexColorModel` using
 Floyd-Steinberg error-diffusion dither.
 
-    import com.twelvemonkeys.image.DiffusionDither;
+```java
+import com.twelvemonkeys.image.DiffusionDither;
 
-    ...
+...
 
-    BufferedImage input = ...; // Image to dither
+BufferedImage input = ...; // Image to dither
 
-    BufferedImageOp ditherer = new DiffusionDither();
-    BufferedImage output = ditherer.filter(input, null);
+BufferedImageOp ditherer = new DiffusionDither();
+BufferedImage output = ditherer.filter(input, null);
+```
 
+#### Working with damaged images
+
+When using the normal patterns for loading images, trying to load a damaged image will result in an `IOException` being thrown.
+
+```java
+BufferedImage image = null;
+try {
+    image = ImageIO.read(file);
+} catch (IOException exception) {
+    // Handle, log a warning/error etc
+}
+```
+
+In this scenario, if the image is damaged, and `ImageIO.read` throws an exception, `image` is still `null` - it's not possible for a function to both return a value and throw an exception.
+
+However, in some cases it may be possible to get usable image data from a damaged image. The way to do this is use an `ImageReadParam` to set a `BufferedImage` as a destination.
+
+```java
+int width = reader.getWidth(0);
+int height = reader.getHeight(0);
+ImageTypeSpecifier imageType = reader.getRawImageType(0);
+BufferedImage image = imageType.createBufferedImage(width, height);
+
+ImageReadParam param = reader.getDefaultReadParam();
+param.setDestination(image);
+
+try {
+    reader.read(0, param);
+}
+catch (IOException e) {
+    // Handle, log a warning/error etc
+}
+```
+
+In theory this should work for all plugins, but the result is very much plugin/implementation specific. With some formats and some forms of damaged file, you may get an image that is mostly useful.
+However, you should be prepared for the possibility this just gives a blank or empty image.
 
 ## Building
 
-Download the project (using [Git](http://git-scm.com/downloads)):
+Download the project (using [Git](https://git-scm.com/downloads)):
 
     $ git clone git@github.com:haraldk/TwelveMonkeys.git
 
 This should create a folder named `TwelveMonkeys` in your current directory. Change directory to the `TwelveMonkeys`
 folder, and issue the command below to build.
 
-Build the project (using [Maven](http://maven.apache.org/download.cgi)):
+Build the project (using [Maven](https://maven.apache.org/download.cgi)):
 
     $ mvn package
 
-Currently, the recommended JDK for making a build is Oracle JDK 7.x or 8.x. 
+Currently, the recommended JDK for making a build is Oracle JDK 8.x. 
 
 It's possible to build using OpenJDK, but some tests might fail due to some minor differences between the color management systems used. You will need to either disable the tests in question, or build without tests altogether.
 
@@ -461,10 +294,12 @@ The ImageIO registry and service lookup mechanism will make sure the plugins are
 
 To verify that the JPEG plugin is installed and used at run-time, you could use the following code:
 
-    Iterator<ImageReader> readers = ImageIO.getImageReadersByFormatName("JPEG");
-    while (readers.hasNext()) {
-        System.out.println("reader: " + readers.next());
-    }
+```java
+Iterator<ImageReader> readers = ImageIO.getImageReadersByFormatName("JPEG");
+while (readers.hasNext()) {
+    System.out.println("reader: " + readers.next());
+}
+```
 
 The first line should print:
 
@@ -474,143 +309,209 @@ The first line should print:
 
 To depend on the JPEG and TIFF plugin using Maven, add the following to your POM:
 
+```xml
+...
+<dependencies>
     ...
-    <dependencies>
-        ...
-        <dependency>
-            <groupId>com.twelvemonkeys.imageio</groupId>
-            <artifactId>imageio-jpeg</artifactId>
-            <version>3.3.2</version> <!-- Alternatively, build your own version -->
-        </dependency>
-        <dependency>
-            <groupId>com.twelvemonkeys.imageio</groupId>
-            <artifactId>imageio-tiff</artifactId>
-            <version>3.3.2</version> <!-- Alternatively, build your own version -->
-        </dependency>
-    </dependencies>
+    <dependency>
+        <groupId>com.twelvemonkeys.imageio</groupId>
+        <artifactId>imageio-jpeg</artifactId>
+        <version>3.13.1</version>
+    </dependency>
+    <dependency>
+        <groupId>com.twelvemonkeys.imageio</groupId>
+        <artifactId>imageio-tiff</artifactId>
+        <version>3.13.1</version>
+    </dependency>
+
+    <!--
+    Optional dependency. Needed only if you deploy ImageIO plugins as part of a web app.
+    Make sure you add the IIOProviderContextListener to your web.xml, see above.
+    -->
+    <dependency>
+        <groupId>com.twelvemonkeys.servlet</groupId>
+        <artifactId>servlet</artifactId>
+        <version>3.13.1</version>
+    </dependency>
+
+    <!--
+    Or Jakarta version, for Servlet API 5.0
+    -->
+    <dependency>
+        <groupId>com.twelvemonkeys.servlet</groupId>
+        <artifactId>servlet</artifactId>
+        <version>3.13.1</version>
+        <classifier>jakarta</classifier>
+    </dependency>
+</dependencies>
+```
 
 #### Manual dependency example
 
 To depend on the JPEG and TIFF plugin in your IDE or program, add all of the following JARs to your class path:
 
-    twelvemonkeys-common-lang-3.3.2.jar
-    twelvemonkeys-common-io-3.3.2.jar
-    twelvemonkeys-common-image-3.3.2.jar
-    twelvemonkeys-imageio-core-3.3.2.jar
-    twelvemonkeys-imageio-metadata-3.3.2.jar
-    twelvemonkeys-imageio-jpeg-3.3.2.jar
-    twelvemonkeys-imageio-tiff-3.3.2.jar
+    twelvemonkeys-common-lang-3.13.1.jar
+    twelvemonkeys-common-io-3.13.1.jar
+    twelvemonkeys-common-image-3.13.1.jar
+    twelvemonkeys-imageio-core-3.13.1.jar
+    twelvemonkeys-imageio-metadata-3.13.1.jar
+    twelvemonkeys-imageio-jpeg-3.13.1.jar
+    twelvemonkeys-imageio-tiff-3.13.1.jar
+
+#### Deploying the plugins in a web app
+
+Because the `ImageIO` plugin registry (the `IIORegistry`) is "VM global", it does not work well with
+servlet contexts as-is. This is especially evident if you load plugins from the `WEB-INF/lib` or `classes` folder.
+Unless you add `ImageIO.scanForPlugins()` somewhere in your code, the plugins might never be available at all.
+
+In addition, servlet contexts dynamically loads and unloads classes (using a new class loader per context).
+If you restart your application, old classes will by default remain in memory forever (because the next time
+`scanForPlugins` is called, it's another `ClassLoader` that scans/loads classes, and thus they will be new instances
+in the registry). If a read is attempted using one of the remaining "old" readers, weird exceptions
+(like `NullPointerException`s when accessing `static final` initialized fields or `NoClassDefFoundError`s 
+for uninitialized inner classes) may occur.
+
+To work around both the discovery problem and the resource leak,
+it is *strongly recommended* to use the `IIOProviderContextListener` that implements
+dynamic loading and unloading of ImageIO plugins for web applications.
+
+```xml
+<web-app ...>
+
+...
+
+    <listener>
+        <display-name>ImageIO service provider loader/unloader</display-name>
+        <listener-class>com.twelvemonkeys.servlet.image.IIOProviderContextListener</listener-class>
+    </listener>
+
+...
+
+</web-app>
+```
+
+Loading plugins from `WEB-INF/lib` without the context listener installed is unsupported and will not work correctly.
+
+The context listener has no dependencies to the TwelveMonkeys ImageIO plugins, and may be used with JAI ImageIO 
+or other ImageIO plugins as well.
+
+Another safe option, is to place the JAR files in the application server's shared or common lib folder. 
+
+##### Jakarta Servlet Support
+
+For those transitioning from the old `javax.servlet` to the new `jakarta.servlet` package, there is a separate 
+dependency available. It contains exactly the same servlet classes as mentioned above, but built against the new Jakarta EE
+packages. The dependency has the same group name and identifier as before, but a `jakarta` *classifier* appended, to 
+distinguish it from the non-Jakarta package.
+
+See the [Maven dependency example](#maven-dependency-example) for how to enable it with Maven. 
+Gradle or other build tools will have similar options.
+
+#### Including the plugins in a "fat" JAR
+
+The recommended way to use the plugins, is just to include the JARs as-is in your project, through a Maven dependency or similar. 
+Re-packaging is not necessary to use the library, and not recommended. 
+ 
+However, if you like to create a "fat" 
+JAR, or otherwise like to re-package the JARs for some reason, it's important to remember that automatic discovery of 
+the plugins by ImageIO depends on the 
+[Service Provider Interface (SPI)](https://docs.oracle.com/javase/tutorial/sound/SPI-intro.html) mechanism. 
+In short, each JAR contains a special folder, named `META-INF/services` containing one or more files, 
+typically `javax.imageio.spi.ImageReaderSpi` and `javax.imageio.spi.ImageWriterSpi`. 
+These files exist *with the same name in every JAR*, 
+so if you simply unpack everything to a single folder or create a JAR, files will be overwritten and behavior be 
+unspecified (most likely you will end up with a single plugin being installed). 
+
+The solution is to make sure all files with the same name, are merged to a single file, 
+containing all the SPI information of each type. If using the Maven Shade plugin, you should use the 
+[ServicesResourceTransformer](https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html#ServicesResourceTransformer)
+to properly merge these files. You may also want to use the 
+[ManifestResourceTransforme](https://maven.apache.org/plugins/maven-shade-plugin/examples/resource-transformers.html#ManifestResourceTransformer) 
+to get the correct vendor name, version info etc. 
+Other "fat" JAR bundlers will probably have similar mechanisms to merge entries with the same name.
 
 ### Links to prebuilt binaries
 
-##### Latest version (3.2.x)
+##### Latest version (3.13.1)
 
-Requires Java 7 or later.
+The latest version that will run on Java 7 is 3.9.4. Later versions will require Java 8 or later.
  
 Common dependencies
-* [common-lang-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-lang/3.3.2/common-lang-3.3.2.jar)
-* [common-io-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-io/3.3.2/common-io-3.3.2.jar)
-* [common-image-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-image/3.3.2/common-image-3.3.2.jar)
+* [common-lang-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-lang/3.13.1/common-lang-3.13.1.jar)
+* [common-io-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-io/3.13.1/common-io-3.13.1.jar)
+* [common-image-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-image/3.13.1/common-image-3.13.1.jar)
 
 ImageIO dependencies
-* [imageio-core-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-core/3.3.2/imageio-core-3.3.2.jar)
-* [imageio-metadata-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-metadata/3.3.2/imageio-metadata-3.3.2.jar)
+* [imageio-core-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-core/3.13.1/imageio-core-3.13.1.jar)
+* [imageio-metadata-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-metadata/3.13.1/imageio-metadata-3.13.1.jar)
 
 ImageIO plugins
-* [imageio-bmp-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-bmp/3.3.2/imageio-bmp-3.3.2.jar)
-* [imageio-jpeg-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-jpeg/3.3.2/imageio-jpeg-3.3.2.jar)
-* [imageio-tiff-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-tiff/3.3.2/imageio-tiff-3.3.2.jar)
-* [imageio-pnm-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pnm/3.3.2/imageio-pnm-3.3.2.jar)
-* [imageio-psd-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-psd/3.3.2/imageio-psd-3.3.2.jar)
-* [imageio-hdr-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-hdr/3.3.2/imageio-hdr-3.3.2.jar)
-* [imageio-iff-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-iff/3.3.2/imageio-iff-3.3.2.jar)
-* [imageio-pcx-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pcx/3.3.2/imageio-pcx-3.3.2.jar)
-* [imageio-pict-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pict/3.3.2/imageio-pict-3.3.2.jar)
-* [imageio-sgi-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-sgi/3.3.2/imageio-sgi-3.3.2.jar)
-* [imageio-tga-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-tga/3.3.2/imageio-tga-3.3.2.jar)
-* [imageio-icns-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-icns/3.3.2/imageio-icns-3.3.2.jar)
-* [imageio-thumbsdb-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-thumbsdb/3.3.2/imageio-thumbsdb-3.3.2.jar)
+* [imageio-bmp-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-bmp/3.13.1/imageio-bmp-3.13.1.jar)
+* [imageio-dds-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-dds/3.13.1/imageio-dds-3.13.1.jar)
+* [imageio-hdr-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-hdr/3.13.1/imageio-hdr-3.13.1.jar)
+* [imageio-icns-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-icns/3.13.1/imageio-icns-3.13.1.jar)
+* [imageio-iff-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-iff/3.13.1/imageio-iff-3.13.1.jar)
+* [imageio-jpeg-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-jpeg/3.13.1/imageio-jpeg-3.13.1.jar)
+* [imageio-pcx-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pcx/3.13.1/imageio-pcx-3.13.1.jar)
+* [imageio-pict-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pict/3.13.1/imageio-pict-3.13.1.jar)
+* [imageio-pnm-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pnm/3.13.1/imageio-pnm-3.13.1.jar)
+* [imageio-psd-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-psd/3.13.1/imageio-psd-3.13.1.jar)
+* [imageio-sgi-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-sgi/3.13.1/imageio-sgi-3.13.1.jar)
+* [imageio-tga-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-tga/3.13.1/imageio-tga-3.13.1.jar)
+* [imageio-thumbsdb-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-thumbsdb/3.13.1/imageio-thumbsdb-3.13.1.jar)
+* [imageio-tiff-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-tiff/3.13.1/imageio-tiff-3.13.1.jar)
+* [imageio-webp-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-webp/3.13.1/imageio-webp-3.13.1.jar)
+* [imageio-xwd-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-xwd/3.13.1/imageio-xwd-3.13.1.jar)
 
 ImageIO plugins requiring 3rd party libs
-* [imageio-batik-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-batik/3.3.2/imageio-batik-3.3.2.jar)
+* [imageio-batik-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-batik/3.13.1/imageio-batik-3.13.1.jar)
 
 Photoshop Path support for ImageIO
-* [imageio-clippath-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-clippath/3.3.2/imageio-clippath-3.3.2.jar)
+* [imageio-clippath-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-clippath/3.13.1/imageio-clippath-3.13.1.jar)
 
 Servlet support
-* [servlet-3.3.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/servlet/servlet/3.3.2/servlet-3.3.2.jar)
-
-##### Old version (3.0.x)
-
-Use this version for projects that requires Java 6 or need the JMagick support. *Does not support Java 8 or later*.
-
-Common dependencies
-* [common-lang-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-lang/3.0.2/common-lang-3.0.2.jar)
-* [common-io-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-io/3.0.2/common-io-3.0.2.jar)
-* [common-image-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/common/common-image/3.0.2/common-image-3.0.2.jar)
- 
-ImageIO dependencies
-* [imageio-core-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-core/3.0.2/imageio-core-3.0.2.jar)
-* [imageio-metadata-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-metadata/3.0.2/imageio-metadata-3.0.2.jar)
- 
-ImageIO plugins
-* [imageio-jpeg-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-jpeg/3.0.2/imageio-jpeg-3.0.2.jar)
-* [imageio-tiff-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-tiff/3.0.2/imageio-tiff-3.0.2.jar)
-* [imageio-psd-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-psd/3.0.2/imageio-psd-3.0.2.jar)
-* [imageio-pict-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-pict/3.0.2/imageio-pict-3.0.2.jar)
-* [imageio-iff-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-iff/3.0.2/imageio-iff-3.0.2.jar)
-* [imageio-icns-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-icns/3.0.2/imageio-icns-3.0.2.jar)
-* [imageio-ico-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-ico/3.0.2/imageio-ico-3.0.2.jar)
-* [imageio-thumbsdb-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-thumbsdb/3.0.2/imageio-thumbsdb-3.0.2.jar)
- 
-ImageIO plugins requiring 3rd party libs
-* [imageio-batik-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-batik/3.0.2/imageio-batik-3.0.2.jar)
-* [imageio-jmagick-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/imageio/imageio-jmagick/3.0.2/imageio-jmagick-3.0.2.jar)
- 
-Servlet support
-* [servlet-3.0.2.jar](http://search.maven.org/remotecontent?filepath=com/twelvemonkeys/servlet/servlet/3.0.2/servlet-3.0.2.jar)
-
+* [servlet-3.13.1.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/servlet/servlet/3.13.1/servlet-3.13.1.jar) for legacy Java EE (javax.servlet)
+* [servlet-3.13.1-jakarta.jar](https://search.maven.org/remotecontent?filepath=com/twelvemonkeys/servlet/servlet/3.13.1/servlet-3.13.1-jakrta.jar) for Jakarta EE (jakarta.servlet)
 
 ## License
 
-The project is distributed under the OSI approved [BSD license](http://opensource.org/licenses/BSD-3-Clause):
+This project is provided under the OSI approved [BSD license](https://opensource.org/licenses/BSD-3-Clause):
 
-    Copyright (c) 2008-2015, Harald Kuhr
+    Copyright (c) 2008-2022, Harald Kuhr
     All rights reserved.
 
     Redistribution and use in source and binary forms, with or without
     modification, are permitted provided that the following conditions are met:
 
-    o Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
+    o Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
 
-    o Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
+    o Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
 
-    o Neither the name "TwelveMonkeys" nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+    o Neither the name of the copyright holder nor the names of its
+      contributors may be used to endorse or promote products derived from
+      this software without specific prior written permission.
 
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 ## FAQ
 
 q: How do I use it?
 
-a: The easiest way is to build your own project using Maven, and just add dependencies to the specific plug-ins you need.
- If you don't use Maven, make sure you have all the necessary JARs in classpath. See the Install section above.
+a: The easiest way is to build your own project using Maven, Gradle or other build tool with dependency management, 
+and just add dependencies to the specific plug-ins you need.
+ If you don't use such a build tool, make sure you have all the necessary JARs in classpath. See the Install section above.
 
 
 q: What changes do I have to make to my code in order to use the plug-ins?
@@ -628,28 +529,47 @@ q: How does it work?
 
 a: The TwelveMonkeys ImageIO project contains plug-ins for ImageIO. ImageIO uses a service lookup mechanism, to discover plug-ins at runtime. 
 
-All you have have to do, is to make sure you have the TwelveMonkeys JARs in your classpath.
+All you have to do, is to make sure you have the TwelveMonkeys ImageIO JARs in your classpath.
 
-You can read more about the registry and the lookup mechanism in the [IIORegistry API doc](http://docs.oracle.com/javase/7/docs/api/javax/imageio/spi/IIORegistry.html).
+You can read more about the registry and the lookup mechanism in the [IIORegistry API doc](https://docs.oracle.com/javase/7/docs/api/javax/imageio/spi/IIORegistry.html).
 
 The fine print: The TwelveMonkeys service providers for JPEG, BMP and TIFF, overrides the onRegistration method, and
 utilizes the pairwise partial ordering mechanism of the `IIOServiceRegistry` to make sure it is installed before
-the Sun/Oracle provided `JPEGImageReader` and `BMPImageReader`, and the Apple provided `TIFFImageReader` on OS X, 
+the Sun/Oracle provided `JPEGImageReader`, `BMPImageReader` `TIFFImageReader`, and the Apple provided `TIFFImageReader` on OS X, 
 respectively. Using the pairwise ordering will not remove any functionality form these implementations, but in most 
 cases you'll end up using the TwelveMonkeys plug-ins instead.
 
 
+q: Why is there no support for common formats like GIF or PNG?
+
+a: The short answer is simply that the built-in support in ImageIO for these formats are considered good enough as-is.
+If you are looking for better PNG write performance on Java 7 and 8, see [JDK9 PNG Writer Backport](https://github.com/gredler/jdk9-png-writer-backport).
+
+
+q: When is the next release? What is the current release schedule?
+
+a: The goal is to make monthly releases, containing bug fixes and minor new features. 
+And quarterly releases with more "major" features.
+
+
+q: I love this project! How can I help?
+
+a: Have a look at the open issues, and see if there are any issues you can help fix, or provide sample file or create test cases for.
+It is also possible for you or your organization to become a sponsor, through GitHub Sponsors. 
+Providing funding will allow us to spend more time on fixing bugs and implementing new features. 
+
+
 q: What about JAI? Several of the formats are already supported by JAI.
 
-a: While JAI (and jai-imageio in particular) have support for some of the formats, JAI has some major issues.
+a: While JAI (and jai-imageio in particular) have support for some of the same formats, JAI has some major issues.
 The most obvious being:
-- It's not actively developed. No issues has been fixed for years.
+- It's not actively developed. No issue has been fixed for years.
 - To get full format support, you need native libs.
 Native libs does not exist for several popular platforms/architectures, and further the native libs are not open source.
 Some environments may also prevent deployment of native libs, which brings us back to square one.
 
 
-q: What about JMagick or IM4Java? Can't you just use what´s already available?
+q: What about JMagick or IM4Java? Can't you just use what's already available?
 
 a: While great libraries with a wide range of formats support, the ImageMagick-based libraries has some disadvantages
 compared to ImageIO.

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+To report a security issue, please disclose it at [security advisory](https://github.com/haraldk/TwelveMonkeys/security/advisories/new).
+
+Vulnerabilities will be disclosed in a best effort base.

bom/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.twelvemonkeys</groupId>
         <artifactId>twelvemonkeys</artifactId>
-        <version>3.4</version>
+        <version>3.13.2-SNAPSHOT</version>
     </parent>
 
     <groupId>com.twelvemonkeys.bom</groupId>
@@ -63,6 +63,11 @@
                 <artifactId>imageio-hdr</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>com.twelvemonkeys.imageio</groupId>
+                <artifactId>imageio-dds</artifactId>
+                <version>${project.version}</version>
+            </dependency>
             <dependency>
                 <groupId>com.twelvemonkeys.imageio</groupId>
                 <artifactId>imageio-icns</artifactId>
@@ -123,6 +128,16 @@
                 <artifactId>imageio-tiff</artifactId>
                 <version>${project.version}</version>
             </dependency>
+            <dependency>
+                <groupId>com.twelvemonkeys.imageio</groupId>
+                <artifactId>imageio-webp</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>com.twelvemonkeys.imageio</groupId>
+                <artifactId>imageio-xwd</artifactId>
+                <version>${project.version}</version>
+            </dependency>
 
             <!-- ImageIO 3rd party dependent plugins -->
             <dependency>

common/common-image/pom.xml

@@ -4,15 +4,19 @@
     <parent>
         <groupId>com.twelvemonkeys.common</groupId>
         <artifactId>common</artifactId>
-        <version>3.4</version>
+        <version>3.13.2-SNAPSHOT</version>
     </parent>
     <artifactId>common-image</artifactId>
     <packaging>jar</packaging>
     <name>TwelveMonkeys :: Common :: Image</name>
     <description>
-        The TwelveMonkeys Common Image support
+        TwelveMonkeys Common image support classes.
     </description>
 
+    <properties>
+        <project.jpms.module.name>com.twelvemonkeys.common.image</project.jpms.module.name>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.groupId}</groupId>
@@ -24,12 +28,14 @@
             <artifactId>common-io</artifactId>
         </dependency>
 
-        <dependency>
-            <groupId>jmagick</groupId>
-            <artifactId>jmagick</artifactId>
-            <version>6.2.4</version>
-            <optional>true</optional>
-            <scope>provided</scope>
-        </dependency>
     </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
 </project>

common/common-image/src/main/java/com/twelvemonkeys/image/AbstractImageSource.java

@@ -1,110 +1,109 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import java.awt.image.ImageConsumer;
-import java.awt.image.ImageProducer;
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * AbstractImageSource
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/AbstractImageSource.java#1 $
- */
-public abstract class AbstractImageSource implements ImageProducer {
-    private List<ImageConsumer> consumers = new ArrayList<ImageConsumer>();
-    protected int width;
-    protected int height;
-    protected int xOff;
-    protected int yOff;
-
-    // ImageProducer interface
-    public void addConsumer(final ImageConsumer pConsumer) {
-        if (consumers.contains(pConsumer)) {
-            return;
-        }
-
-        consumers.add(pConsumer);
-
-        try {
-            initConsumer(pConsumer);
-            sendPixels(pConsumer);
-
-            if (isConsumer(pConsumer)) {
-                pConsumer.imageComplete(ImageConsumer.STATICIMAGEDONE);
-
-                // Get rid of "sticky" consumers...
-                if (isConsumer(pConsumer)) {
-                    pConsumer.imageComplete(ImageConsumer.IMAGEERROR);
-                    removeConsumer(pConsumer);
-                }
-            }
-        }
-        catch (Exception e) {
-            e.printStackTrace();
-
-            if (isConsumer(pConsumer)) {
-                pConsumer.imageComplete(ImageConsumer.IMAGEERROR);
-            }
-        }
-    }
-
-    public void removeConsumer(final ImageConsumer pConsumer) {
-        consumers.remove(pConsumer);
-    }
-
-    /**
-     * This implementation silently ignores this instruction. If pixel data is
-     * not in TDLR order by default, subclasses must override this method.
-     *
-     * @param pConsumer the consumer that requested the resend
-     *
-     * @see ImageProducer#requestTopDownLeftRightResend(java.awt.image.ImageConsumer)
-     */
-    public void requestTopDownLeftRightResend(final ImageConsumer pConsumer) {
-        // ignore
-    }
-
-    public void startProduction(final ImageConsumer pConsumer) {
-        addConsumer(pConsumer);
-    }
-
-    public boolean isConsumer(final ImageConsumer pConsumer) {
-        return consumers.contains(pConsumer);
-    }
-
-    protected abstract void initConsumer(ImageConsumer pConsumer);
-
-    protected abstract void sendPixels(ImageConsumer pConsumer);
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import java.awt.image.ImageConsumer;
+import java.awt.image.ImageProducer;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * AbstractImageSource
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/AbstractImageSource.java#1 $
+ */
+public abstract class AbstractImageSource implements ImageProducer {
+    private List<ImageConsumer> consumers = new ArrayList<ImageConsumer>();
+    protected int width;
+    protected int height;
+    protected int xOff;
+    protected int yOff;
+
+    // ImageProducer interface
+    public void addConsumer(final ImageConsumer pConsumer) {
+        if (consumers.contains(pConsumer)) {
+            return;
+        }
+
+        consumers.add(pConsumer);
+
+        try {
+            initConsumer(pConsumer);
+            sendPixels(pConsumer);
+
+            if (isConsumer(pConsumer)) {
+                pConsumer.imageComplete(ImageConsumer.STATICIMAGEDONE);
+
+                // Get rid of "sticky" consumers...
+                if (isConsumer(pConsumer)) {
+                    pConsumer.imageComplete(ImageConsumer.IMAGEERROR);
+                    removeConsumer(pConsumer);
+                }
+            }
+        }
+        catch (Exception e) {
+            e.printStackTrace();
+
+            if (isConsumer(pConsumer)) {
+                pConsumer.imageComplete(ImageConsumer.IMAGEERROR);
+            }
+        }
+    }
+
+    public void removeConsumer(final ImageConsumer pConsumer) {
+        consumers.remove(pConsumer);
+    }
+
+    /**
+     * This implementation silently ignores this instruction. If pixel data is
+     * not in TDLR order by default, subclasses must override this method.
+     *
+     * @param pConsumer the consumer that requested the resend
+     *
+     * @see ImageProducer#requestTopDownLeftRightResend(java.awt.image.ImageConsumer)
+     */
+    public void requestTopDownLeftRightResend(final ImageConsumer pConsumer) {
+        // ignore
+    }
+
+    public void startProduction(final ImageConsumer pConsumer) {
+        addConsumer(pConsumer);
+    }
+
+    public boolean isConsumer(final ImageConsumer pConsumer) {
+        return consumers.contains(pConsumer);
+    }
+
+    protected abstract void initConsumer(ImageConsumer pConsumer);
+
+    protected abstract void sendPixels(ImageConsumer pConsumer);
+}

common/common-image/src/main/java/com/twelvemonkeys/image/AffineTransformOp.java

@@ -34,7 +34,13 @@ import java.awt.*;
 import java.awt.geom.AffineTransform;
 import java.awt.geom.Point2D;
 import java.awt.geom.Rectangle2D;
-import java.awt.image.*;
+import java.awt.image.BufferedImage;
+import java.awt.image.BufferedImageOp;
+import java.awt.image.ColorModel;
+import java.awt.image.ImagingOpException;
+import java.awt.image.Raster;
+import java.awt.image.RasterOp;
+import java.awt.image.WritableRaster;
 
 /**
  * This is a drop-in replacement for {@link java.awt.image.AffineTransformOp}.
@@ -70,6 +76,7 @@ public class AffineTransformOp implements BufferedImageOp, RasterOp {
         delegate = new java.awt.image.AffineTransformOp(xform, interpolationType);
     }
 
+    @SuppressWarnings("ConstantConditions")
     @Override
     public BufferedImage filter(final BufferedImage src, BufferedImage dst) {
         try {
@@ -80,10 +87,9 @@ public class AffineTransformOp implements BufferedImageOp, RasterOp {
                 dst = createCompatibleDestImage(src, src.getColorModel());
             }
 
-            Graphics2D g2d = null;
+            Graphics2D g2d = dst.createGraphics();
 
             try {
-                g2d = dst.createGraphics();
                 int interpolationType = delegate.getInterpolationType();
 
                 if (interpolationType > 0) {
@@ -109,9 +115,7 @@ public class AffineTransformOp implements BufferedImageOp, RasterOp {
                 return dst;
             }
             finally {
-                if (g2d != null) {
-                    g2d.dispose();
-                }
+                g2d.dispose();
             }
         }
     }

common/common-image/src/main/java/com/twelvemonkeys/image/BrightnessContrastFilter.java

@@ -1,170 +1,173 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import java.awt.image.RGBImageFilter;
-
-
-/**
- * Adjusts the contrast and brightness of an image.
- * <p/>
- * For brightness, the valid range is {@code -2.0,..,0.0,..,2.0}.
- * A value of {@code 0.0} means no change.
- * Negative values will make the pixels darker.
- * Maximum negative value ({@code -2}) will make all filtered pixels black.
- * Positive values will make the pixels brighter.
- * Maximum positive value ({@code 2}) will make all filtered pixels white.
- * <p/>
- * For contrast, the valid range is {@code -1.0,..,0.0,..,1.0}.
- * A value of {@code 0.0} means no change.
- * Negative values will reduce contrast.
- * Maximum negative value ({@code -1}) will make all filtered pixels grey
- * (no contrast).
- * Positive values will increase contrast.
- * Maximum positive value ({@code 1}) will make all filtered pixels primary
- * colors (either black, white, cyan, magenta, yellow, red, blue or green).
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- *
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/BrightnessContrastFilter.java#1 $
- *
- * @todo consider doing something similar to http://archives.java.sun.com/cgi-bin/wa?A2=ind0302&L=jai-interest&F=&S=&P=15947
- */
-
-public class BrightnessContrastFilter extends RGBImageFilter {
-
-    // TODO: Replace with RescaleOp?
-
-    // This filter can filter IndexColorModel, as it is does not depend on
-    // the pixels' location
-    {
-        canFilterIndexColorModel = true;
-    }
-
-    // Use a pre-calculated lookup table for performance
-    private final int[] LUT;
-
-    /**
-     * Creates a BrightnessContrastFilter with default values
-     * ({@code brightness=0.3, contrast=0.3}).
-     * <p/>
-     * This will slightly increase both brightness and contrast.
-     */
-    public BrightnessContrastFilter() {
-        this(0.3f, 0.3f);
-    }
-
-    /**
-     * Creates a BrightnessContrastFilter with the given values for brightness
-     * and contrast.
-     * <p/>
-     * For brightness, the valid range is {@code -2.0,..,0.0,..,2.0}.
-     * A value of {@code 0.0} means no change.
-     * Negative values will make the pixels darker.
-     * Maximum negative value ({@code -2}) will make all filtered pixels black.
-     * Positive values will make the pixels brighter.
-     * Maximum positive value ({@code 2}) will make all filtered pixels white.
-     * <p/>
-     * For contrast, the valid range is {@code -1.0,..,0.0,..,1.0}.
-     * A value of {@code 0.0} means no change.
-     * Negative values will reduce contrast.
-     * Maximum negative value ({@code -1}) will make all filtered pixels grey
-     * (no contrast).
-     * Positive values will increase contrast.
-     * Maximum positive value ({@code 1}) will make all filtered pixels primary
-     * colors (either black, white, cyan, magenta, yellow, red, blue or green).
-     *
-     * @param pBrightness adjust the brightness of the image, in the range
-     * {@code -2.0,..,0.0,..,2.0}.
-     * @param pContrast adjust the contrast of the image, in the range
-     * {@code -1.0,..,0.0,..,1.0}.
-     */
-    public BrightnessContrastFilter(float pBrightness, float pContrast) {
-        LUT = createLUT(pBrightness, pContrast);
-    }
-
-    private static int[] createLUT(float pBrightness, float pContrast) {
-        int[] lut = new int[256];
-
-        // Hmmm.. This approximates Photoshop values.. Not good though..
-        double contrast = pContrast > 0 ? Math.pow(pContrast, 7.0) * 127.0 : pContrast;
-
-        // Convert range [-1,..,0,..,1] -> [0,..,1,..,2]
-        double brightness = pBrightness + 1.0;
-
-        for (int i = 0; i < 256; i++) {
-            lut[i] = clamp((int) (127.5 * brightness + (i - 127) * (contrast + 1.0)));
-        }
-
-        // Special case, to ensure only primary colors for max contrast
-        if (pContrast == 1f) {
-            lut[127] = lut[126];
-        }
-
-        return lut;
-    }
-
-    private static int clamp(int i) {
-        if (i < 0) {
-            return 0;
-        }
-        if (i > 255) {
-            return 255;
-        }
-        return i;
-    }
-
-    /**
-     * Filters one pixel, adjusting brightness and contrast according to this
-     * filter.
-     *
-     * @param pX x
-     * @param pY y
-     * @param pARGB pixel value in default color space
-     *
-     * @return the filtered pixel value in the default color space
-     */
-    public int filterRGB(int pX, int pY, int pARGB) {
-        // Get color components
-        int r = pARGB >> 16 & 0xFF;
-        int g = pARGB >> 8 & 0xFF;
-        int b = pARGB & 0xFF;
-
-        // Scale to new contrast
-        r = LUT[r];
-        g = LUT[g];
-        b = LUT[b];
-
-        // Return ARGB pixel, leave transparency as is
-        return (pARGB & 0xFF000000) | (r << 16) | (g << 8) | b;
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import java.awt.image.RGBImageFilter;
+
+
+/**
+ * Adjusts the contrast and brightness of an image.
+ * <p>
+ * For brightness, the valid range is {@code -2.0,..,0.0,..,2.0}.
+ * A value of {@code 0.0} means no change.
+ * Negative values will make the pixels darker.
+ * Maximum negative value ({@code -2}) will make all filtered pixels black.
+ * Positive values will make the pixels brighter.
+ * Maximum positive value ({@code 2}) will make all filtered pixels white.
+ * </p>
+ * <p>
+ * For contrast, the valid range is {@code -1.0,..,0.0,..,1.0}.
+ * A value of {@code 0.0} means no change.
+ * Negative values will reduce contrast.
+ * Maximum negative value ({@code -1}) will make all filtered pixels grey
+ * (no contrast).
+ * Positive values will increase contrast.
+ * Maximum positive value ({@code 1}) will make all filtered pixels primary
+ * colors (either black, white, cyan, magenta, yellow, red, blue or green).
+ * </p>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ *
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/BrightnessContrastFilter.java#1 $
+ */
+// TODO: consider doing something similar to http://archives.java.sun.com/cgi-bin/wa?A2=ind0302&L=jai-interest&F=&S=&P=15947
+public class BrightnessContrastFilter extends RGBImageFilter {
+
+    // TODO: Replace with RescaleOp?
+
+    // This filter can filter IndexColorModel, as it is does not depend on
+    // the pixels' location
+    {
+        canFilterIndexColorModel = true;
+    }
+
+    // Use a pre-calculated lookup table for performance
+    private final int[] LUT;
+
+    /**
+     * Creates a BrightnessContrastFilter with default values
+     * ({@code brightness=0.3, contrast=0.3}).
+     * <p>
+     * This will slightly increase both brightness and contrast.
+     * </p>
+     */
+    public BrightnessContrastFilter() {
+        this(0.3f, 0.3f);
+    }
+
+    /**
+     * Creates a BrightnessContrastFilter with the given values for brightness
+     * and contrast.
+     * <p>
+     * For brightness, the valid range is {@code -2.0,..,0.0,..,2.0}.
+     * A value of {@code 0.0} means no change.
+     * Negative values will make the pixels darker.
+     * Maximum negative value ({@code -2}) will make all filtered pixels black.
+     * Positive values will make the pixels brighter.
+     * Maximum positive value ({@code 2}) will make all filtered pixels white.
+     * </p>
+     * <p>
+     * For contrast, the valid range is {@code -1.0,..,0.0,..,1.0}.
+     * A value of {@code 0.0} means no change.
+     * Negative values will reduce contrast.
+     * Maximum negative value ({@code -1}) will make all filtered pixels grey
+     * (no contrast).
+     * Positive values will increase contrast.
+     * Maximum positive value ({@code 1}) will make all filtered pixels primary
+     * colors (either black, white, cyan, magenta, yellow, red, blue or green).
+     * </p>
+     *
+     * @param pBrightness adjust the brightness of the image, in the range
+     * {@code -2.0,..,0.0,..,2.0}.
+     * @param pContrast adjust the contrast of the image, in the range
+     * {@code -1.0,..,0.0,..,1.0}.
+     */
+    public BrightnessContrastFilter(float pBrightness, float pContrast) {
+        LUT = createLUT(pBrightness, pContrast);
+    }
+
+    private static int[] createLUT(float pBrightness, float pContrast) {
+        int[] lut = new int[256];
+
+        // Hmmm.. This approximates Photoshop values.. Not good though..
+        double contrast = pContrast > 0 ? Math.pow(pContrast, 7.0) * 127.0 : pContrast;
+
+        // Convert range [-1,..,0,..,1] -> [0,..,1,..,2]
+        double brightness = pBrightness + 1.0;
+
+        for (int i = 0; i < 256; i++) {
+            lut[i] = clamp((int) (127.5 * brightness + (i - 127) * (contrast + 1.0)));
+        }
+
+        // Special case, to ensure only primary colors for max contrast
+        if (pContrast == 1f) {
+            lut[127] = lut[126];
+        }
+
+        return lut;
+    }
+
+    private static int clamp(int i) {
+        if (i < 0) {
+            return 0;
+        }
+        if (i > 255) {
+            return 255;
+        }
+        return i;
+    }
+
+    /**
+     * Filters one pixel, adjusting brightness and contrast according to this
+     * filter.
+     *
+     * @param pX x
+     * @param pY y
+     * @param pARGB pixel value in default color space
+     *
+     * @return the filtered pixel value in the default color space
+     */
+    public int filterRGB(int pX, int pY, int pARGB) {
+        // Get color components
+        int r = pARGB >> 16 & 0xFF;
+        int g = pARGB >> 8 & 0xFF;
+        int b = pARGB & 0xFF;
+
+        // Scale to new contrast
+        r = LUT[r];
+        g = LUT[g];
+        b = LUT[b];
+
+        // Return ARGB pixel, leave transparency as is
+        return (pARGB & 0xFF000000) | (r << 16) | (g << 8) | b;
+    }
+}

common/common-image/src/main/java/com/twelvemonkeys/image/BufferedImageFactory.java

@@ -44,14 +44,16 @@ import java.util.concurrent.CopyOnWriteArrayList;
  * A faster, lighter and easier way to convert an {@code Image} to a
  * {@code BufferedImage} than using a {@code PixelGrabber}.
  * Clients may provide progress listeners to monitor conversion progress.
- * <p/>
+ * <p>
  * Supports source image subsampling and source region extraction.
  * Supports source images with 16 bit {@link ColorModel} and
  * {@link DataBuffer#TYPE_USHORT} transfer type, without converting to
  * 32 bit/TYPE_INT.
- * <p/>
+ * </p>
+ * <p>
  * NOTE: Does not support images with more than one {@code ColorModel} or
  * different types of pixel data. This is not very common.
+ * </p>
  *
  * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
  * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/BufferedImageFactory.java#1 $
@@ -77,7 +79,7 @@ public final class BufferedImageFactory {
     private int scanSize;
 
     private ColorModel sourceColorModel;
-    private Hashtable sourceProperties; // ImageConsumer API dictates Hashtable
+    private Hashtable<?, ?> sourceProperties; // ImageConsumer API dictates Hashtable
 
     private Object sourcePixels;
 
@@ -89,21 +91,21 @@ public final class BufferedImageFactory {
 
     /**
      * Creates a {@code BufferedImageFactory}.
-     * @param pSource the source image
-     * @throws IllegalArgumentException if {@code pSource == null}
+     * @param source the source image
+     * @throws IllegalArgumentException if {@code source == null}
      */
-    public BufferedImageFactory(final Image pSource) {
-        this(pSource != null ? pSource.getSource() : null);
+    public BufferedImageFactory(final Image source) {
+        this(source != null ? source.getSource() : null);
     }
 
     /**
      * Creates a {@code BufferedImageFactory}.
-     * @param pSource the source image producer
-     * @throws IllegalArgumentException if {@code pSource == null}
+     * @param source the source image producer
+     * @throws IllegalArgumentException if {@code source == null}
      */
-    public BufferedImageFactory(final ImageProducer pSource) {
-        Validate.notNull(pSource, "source");
-        producer = pSource;
+    public BufferedImageFactory(final ImageProducer source) {
+        Validate.notNull(source, "source");
+        producer = source;
     }
 
     /**
@@ -153,44 +155,44 @@ public final class BufferedImageFactory {
     /**
      * Sets the source region (AOI) for the new image.
      *
-     * @param pRegion the source region
+     * @param region the source region
      */
-    public void setSourceRegion(final Rectangle pRegion) {
+    public void setSourceRegion(final Rectangle region) {
         // Re-fetch everything, if region changed
-        if (x != pRegion.x || y != pRegion.y || width != pRegion.width || height != pRegion.height) {
+        if (x != region.x || y != region.y || width != region.width || height != region.height) {
             dispose();
         }
 
-        x = pRegion.x;
-        y = pRegion.y;
-        width = pRegion.width;
-        height = pRegion.height;
+        x = region.x;
+        y = region.y;
+        width = region.width;
+        height = region.height;
     }
 
     /**
      * Sets the source subsampling for the new image.
      *
-     * @param pXSub horizontal subsampling factor
-     * @param pYSub vertical subsampling factor
+     * @param xSubsampling horizontal subsampling factor
+     * @param ySubsampling vertical subsampling factor
      */
-    public void setSourceSubsampling(int pXSub, int pYSub) {
+    public void setSourceSubsampling(int xSubsampling, int ySubsampling) {
         // Re-fetch everything, if subsampling changed
-        if (xSub != pXSub || ySub != pYSub) {
+        if (xSub != xSubsampling || ySub != ySubsampling) {
             dispose();
         }
 
-        if (pXSub > 1) {
-            xSub = pXSub;
+        if (xSubsampling > 1) {
+            xSub = xSubsampling;
         }
-        if (pYSub > 1) {
-            ySub = pYSub;
+        if (ySubsampling > 1) {
+            ySub = ySubsampling;
         }
     }
 
-    private synchronized void doFetch(boolean pColorModelOnly) throws ImageConversionException {
-        if (!fetching && (!pColorModelOnly && buffered == null || buffered == null && sourceColorModel == null)) {
+    private synchronized void doFetch(final boolean colorModelOnly) throws ImageConversionException {
+        if (!fetching && (!colorModelOnly && buffered == null || buffered == null && sourceColorModel == null)) {
             // NOTE: Subsampling is only applied if extracting full image
-            if (!pColorModelOnly && (xSub > 1 || ySub > 1)) {
+            if (!colorModelOnly && (xSub > 1 || ySub > 1)) {
                 // If only sampling a region, the region must be scaled too
                 if (width > 0 && height > 0) {
                     width = (width + xSub - 1) / xSub;
@@ -205,38 +207,41 @@ public final class BufferedImageFactory {
 
             // Start fetching
             fetching = true;
-            readColorModelOnly = pColorModelOnly;
+            readColorModelOnly = colorModelOnly;
 
             producer.startProduction(consumer); // Note: If single-thread (synchronous), this call will block
 
             // Wait until the producer wakes us up, by calling imageComplete
             while (fetching) {
                 try {
-                    wait(200l);
+                    wait(200L);
                 }
                 catch (InterruptedException e) {
                     throw new ImageConversionException("Image conversion aborted: " + e.getMessage(), e);
                 }
             }
 
-            if (consumerException != null) {
-                throw new ImageConversionException("Image conversion failed: " + consumerException.getMessage(), consumerException);
-            }
+            try {
+                if (consumerException != null) {
+                    throw new ImageConversionException("Image conversion failed: " + consumerException.getMessage(), consumerException);
+                }
 
-            if (pColorModelOnly) {
-                createColorModel();
+                if (colorModelOnly) {
+                    createColorModel();
+                }
+                else {
+                    createBuffered();
+                }
             }
-            else {
-                createBuffered();
+            finally {
+                // Clean up, in case any objects are copied/cloned, so we can free resources
+                freeResources();
             }
         }
     }
 
     private void createColorModel() {
         colorModel = sourceColorModel;
-
-        // Clean up, in case any objects are copied/cloned, so we can free resources
-        freeResources();
     }
 
     private void createBuffered() {
@@ -251,8 +256,9 @@ public final class BufferedImageFactory {
             }
         }
 
-        // Clean up, in case any objects are copied/cloned, so we can free resources
-        freeResources();
+        if (buffered == null) {
+            throw new ImageConversionException("Could not create BufferedImage");
+        }
     }
 
     private void freeResources() {
@@ -278,27 +284,27 @@ public final class BufferedImageFactory {
     /**
      * Adds a progress listener to this factory.
      *
-     * @param pListener the progress listener
+     * @param listener the progress listener
      */
-    public void addProgressListener(ProgressListener pListener) {
-        if (pListener == null) {
+    public void addProgressListener(ProgressListener listener) {
+        if (listener == null) {
             return;
         }
 
         if (listeners == null) {
-            listeners = new CopyOnWriteArrayList<ProgressListener>();
+            listeners = new CopyOnWriteArrayList<>();
         }
 
-        listeners.add(pListener);
+        listeners.add(listener);
     }
 
     /**
      * Removes a progress listener from this factory.
      *
-     * @param pListener the progress listener
+     * @param listener the progress listener
      */
-    public void removeProgressListener(ProgressListener pListener) {
-        if (pListener == null) {
+    public void removeProgressListener(ProgressListener listener) {
+        if (listener == null) {
             return;
         }
 
@@ -306,7 +312,7 @@ public final class BufferedImageFactory {
             return;
         }
 
-        listeners.remove(pListener);
+        listeners.remove(listener);
     }
 
     /**
@@ -322,21 +328,22 @@ public final class BufferedImageFactory {
      * Converts an array of {@code int} pixels to an array of {@code short}
      * pixels. The conversion is done, by masking out the
      * <em>higher 16 bits</em> of the {@code int}.
-     *
+     * <p>
      * For any given {@code int}, the {@code short} value is computed as
      * follows:
      * <blockquote>{@code
      * short value = (short) (intValue & 0x0000ffff);
      * }</blockquote>
+     * </p>
      *
-     * @param pPixels the pixel data to convert
-     * @return an array of {@code short}s, same lenght as {@code pPixels}
+     * @param inputPixels the pixel data to convert
+     * @return an array of {@code short}s, same length as {@code inputPixels}
      */
-    private static short[] toShortPixels(int[] pPixels) {
-        short[] pixels = new short[pPixels.length];
+    private static short[] toShortPixels(int[] inputPixels) {
+        short[] pixels = new short[inputPixels.length];
 
         for (int i = 0; i < pixels.length; i++) {
-            pixels[i] = (short) (pPixels[i] & 0xffff);
+            pixels[i] = (short) (inputPixels[i] & 0xffff);
         }
 
         return pixels;
@@ -349,17 +356,17 @@ public final class BufferedImageFactory {
      * @see BufferedImageFactory#addProgressListener
      * @see BufferedImageFactory#removeProgressListener
      */
-    public static interface ProgressListener extends EventListener {
+    public interface ProgressListener extends EventListener {
 
         /**
          * Reports progress to this listener.
          * Invoked by the {@code BufferedImageFactory} to report progress in
          * the image decoding.
          *
-         * @param pFactory the factory reporting the progress
-         * @param pPercentage the percentage of progress
+         * @param factory the factory reporting the progress
+         * @param percentage the percentage of progress
          */
-        void progress(BufferedImageFactory pFactory, float pPercentage);
+        void progress(BufferedImageFactory factory, float percentage);
     }
 
     private class Consumer implements ImageConsumer {
@@ -444,18 +451,18 @@ public final class BufferedImageFactory {
             processProgress(pY + pHeight);
         }
 
-        public void setPixels(int pX, int pY, int pWidth, int pHeight, ColorModel pModel, short[] pPixels, int pOffset, int pScanSize) {
-            setPixelsImpl(pX, pY, pWidth, pHeight, pModel, pPixels, pOffset, pScanSize);
+        public void setPixels(int x, int y, int width, int height, ColorModel colorModel, short[] pixels, int offset, int scanSize) {
+            setPixelsImpl(x, y, width, height, colorModel, pixels, offset, scanSize);
         }
 
-        private void setColorModelOnce(final ColorModel pModel) {
+        private void setColorModelOnce(final ColorModel colorModel) {
             // NOTE: There seems to be a "bug" in AreaAveragingScaleFilter, as it
             // first passes the original color model through in setColorModel, then
             // later replaces it with the default RGB in the first setPixels call
             // (this is probably allowed according to the spec, but it's a waste of time and space).
-            if (sourceColorModel != pModel) {
-                if (/*sourceColorModel == null ||*/ sourcePixels == null) {
-                    sourceColorModel = pModel;
+            if (sourceColorModel != colorModel) {
+                if (sourcePixels == null) {
+                    sourceColorModel = colorModel;
                 }
                 else {
                     throw new IllegalStateException("Change of ColorModel after pixel delivery not supported");
@@ -468,17 +475,16 @@ public final class BufferedImageFactory {
             }
         }
 
-        public void imageComplete(int pStatus) {
+        @Override
+        public void imageComplete(int status) {
             fetching = false;
 
             if (producer != null) {
                 producer.removeConsumer(this);
             }
 
-            switch (pStatus) {
-                case ImageConsumer.IMAGEERROR:
-                    consumerException = new ImageConversionException("ImageConsumer.IMAGEERROR");
-                break;
+            if (status == ImageConsumer.IMAGEERROR) {
+                consumerException = new ImageConversionException("ImageConsumer.IMAGEERROR");
             }
 
             synchronized (BufferedImageFactory.this) {
@@ -486,16 +492,18 @@ public final class BufferedImageFactory {
             }
         }
 
-        public void setColorModel(ColorModel pModel) {
-            setColorModelOnce(pModel);
+        @Override
+        public void setColorModel(ColorModel colorModel) {
+            setColorModelOnce(colorModel);
         }
 
-        public void setDimensions(int pWidth, int pHeight) {
+        @Override
+        public void setDimensions(int w, int h) {
             if (width < 0) {
-                width = pWidth - x;
+                width = w - x;
             }
             if (height < 0) {
-                height = pHeight - y;
+                height = h - y;
             }
 
             // Hmm.. Special case, but is it a good idea?
@@ -504,27 +512,31 @@ public final class BufferedImageFactory {
             }
         }
 
-        public void setHints(int pHintflags) {
+        @Override
+        public void setHints(int hintFlags) {
            // ignore
         }
 
-        public void setPixels(int pX, int pY, int pWidth, int pHeight, ColorModel pModel, byte[] pPixels, int pOffset, int pScanSize) {
-            setPixelsImpl(pX, pY, pWidth, pHeight, pModel, pPixels, pOffset, pScanSize);
+        @Override
+        public void setPixels(int x, int y, int width, int height, ColorModel colorModel, byte[] pixels, int offset, int scanSize) {
+            setPixelsImpl(x, y, width, height, colorModel, pixels, offset, scanSize);
         }
 
-        public void setPixels(int pX, int pY, int pWeigth, int pHeight, ColorModel pModel, int[] pPixels, int pOffset, int pScanSize) {
-            if (pModel.getTransferType() == DataBuffer.TYPE_USHORT) {
+        @Override
+        public void setPixels(int x, int y, int width, int height, ColorModel colorModel, int[] pixels, int offset, int scanSize) {
+            if (colorModel.getTransferType() == DataBuffer.TYPE_USHORT) {
                 // NOTE: Workaround for limitation in ImageConsumer API
                 // Convert int[] to short[], to be compatible with the ColorModel
-                setPixelsImpl(pX, pY, pWeigth, pHeight, pModel, toShortPixels(pPixels), pOffset, pScanSize);
+                setPixelsImpl(x, y, width, height, colorModel, toShortPixels(pixels), offset, scanSize);
             }
             else {
-                setPixelsImpl(pX, pY, pWeigth, pHeight, pModel, pPixels, pOffset, pScanSize);
+                setPixelsImpl(x, y, width, height, colorModel, pixels, offset, scanSize);
             }
         }
 
-        public void setProperties(Hashtable pProperties) {
-            sourceProperties = pProperties;
+        @Override
+        public void setProperties(Hashtable properties) {
+            sourceProperties = properties;
         }
     }
 

common/common-image/src/main/java/com/twelvemonkeys/image/BufferedImageIcon.java

@@ -1,92 +1,90 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import com.twelvemonkeys.lang.Validate;
-
-import javax.swing.*;
-import java.awt.*;
-import java.awt.geom.AffineTransform;
-import java.awt.image.BufferedImage;
-
-/**
- * An {@code Icon} implementation backed by a {@code BufferedImage}.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/BufferedImageIcon.java#2 $
- */
-public class BufferedImageIcon implements Icon {
-    private final BufferedImage image;
-    private int width;
-    private int height;
-    private final boolean fast;
-
-    public BufferedImageIcon(BufferedImage pImage) {
-        this(pImage, pImage != null ? pImage.getWidth() : 0, pImage != null ? pImage.getHeight() : 0);
-    }
-
-    public BufferedImageIcon(BufferedImage pImage, int pWidth, int pHeight) {
-        this(pImage, pWidth, pHeight, pImage.getWidth() == pWidth && pImage.getHeight() == pHeight);
-    }
-
-    public BufferedImageIcon(BufferedImage pImage, int pWidth, int pHeight, boolean useFastRendering) {
-        image = Validate.notNull(pImage, "image");
-        width = Validate.isTrue(pWidth > 0, pWidth, "width must be positive: %d");
-        height = Validate.isTrue(pHeight > 0, pHeight, "height must be positive: %d");
-
-        fast = useFastRendering;
-    }
-
-    public int getIconHeight() {
-        return height;
-    }
-
-    public int getIconWidth() {
-        return width;
-    }
-
-    public void paintIcon(Component c, Graphics g, int x, int y) {
-        if (fast || !(g instanceof Graphics2D)) {
-            //System.out.println("Scaling fast");
-            g.drawImage(image, x, y, width, height, null);
-        }
-        else {
-            //System.out.println("Scaling using interpolation");
-            Graphics2D g2 = (Graphics2D) g;
-            AffineTransform xform = AffineTransform.getTranslateInstance(x, y);
-            xform.scale(width / (double) image.getWidth(), height / (double) image.getHeight());
-            g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
-                                RenderingHints.VALUE_INTERPOLATION_BILINEAR);
-            g2.drawImage(image, xform, null);
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import com.twelvemonkeys.lang.Validate;
+
+import javax.swing.*;
+import java.awt.*;
+import java.awt.geom.AffineTransform;
+import java.awt.image.BufferedImage;
+
+/**
+ * An {@code Icon} implementation backed by a {@code BufferedImage}.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/BufferedImageIcon.java#2 $
+ */
+public class BufferedImageIcon implements Icon {
+    private final BufferedImage image;
+    private final int width;
+    private final int height;
+    private final boolean fast;
+
+    public BufferedImageIcon(BufferedImage pImage) {
+        this(pImage, pImage != null ? pImage.getWidth() : 0, pImage != null ? pImage.getHeight() : 0);
+    }
+
+    public BufferedImageIcon(BufferedImage pImage, int pWidth, int pHeight) {
+        this(pImage, pWidth, pHeight, pImage.getWidth() == pWidth && pImage.getHeight() == pHeight);
+    }
+
+    public BufferedImageIcon(BufferedImage pImage, int pWidth, int pHeight, boolean useFastRendering) {
+        image = Validate.notNull(pImage, "image");
+        width = Validate.isTrue(pWidth > 0, pWidth, "width must be positive: %d");
+        height = Validate.isTrue(pHeight > 0, pHeight, "height must be positive: %d");
+
+        fast = useFastRendering;
+    }
+
+    public int getIconHeight() {
+        return height;
+    }
+
+    public int getIconWidth() {
+        return width;
+    }
+
+    public void paintIcon(Component c, Graphics g, int x, int y) {
+        if (fast || !(g instanceof Graphics2D)) {
+            //System.out.println("Scaling fast");
+            g.drawImage(image, x, y, width, height, null);
+        }
+        else {
+            //System.out.println("Scaling using interpolation");
+            Graphics2D g2 = (Graphics2D) g;
+            AffineTransform transform = AffineTransform.getTranslateInstance(x, y);
+            transform.scale(width / (double) image.getWidth(), height / (double) image.getHeight());
+            g2.setRenderingHint(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR);
+            g2.drawImage(image, transform, null);
+        }
+    }
+}

common/common-image/src/main/java/com/twelvemonkeys/image/DiffusionDither.java

@@ -1,483 +1,485 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import java.awt.*;
-import java.awt.geom.Point2D;
-import java.awt.geom.Rectangle2D;
-import java.awt.image.*;
-import java.util.Random;
-
-/**
- * This {@code BufferedImageOp/RasterOp} implements basic
- * Floyd-Steinberg error-diffusion algorithm for dithering.
- * <P/>
- * The weights used are 7/16, 3/16, 5/16 and 1/16, distributed like this:
- * <!-- - -
- *  | |x|7|
- *  - - - -
- *  |3|5|1|
- *   - - -->
- * <P/>
- * <TABLE border="1" cellpadding="4" cellspacing="0">
- *  <TR><TD bgcolor="#000000">&nbsp;</TD><TD class="TableHeadingColor"
- *          align="center">X</TD><TD>7/16</TD></TR>
- *  <TR><TD>3/16</TD><TD>5/16</TD><TD>1/16</TD></TR>
- * </TABLE>
- * <P/>
- * See <A href="http://www.awprofessional.com/bookstore/product.asp?isbn=0201848406&rl=1">Computer Graphics (Foley et al.)</a>
- * for more information.
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- *
- * @version $Id: DiffusionDither.java#1 $
- */
-public class DiffusionDither implements BufferedImageOp, RasterOp {
-
-    private static final int FS_SCALE = 1 << 8;
-    private static final Random RANDOM = new Random();
-
-    protected final IndexColorModel indexColorModel;
-    private boolean alternateScans = true;
-
-    /**
-     * Creates a {@code DiffusionDither}, using the given
-     * {@code IndexColorModel} for dithering into.
-     *
-     * @param pICM an IndexColorModel.
-     */
-    public DiffusionDither(final IndexColorModel pICM) {
-        // Store color model
-        indexColorModel = pICM;
-    }
-
-    /**
-     * Creates a {@code DiffusionDither}, with no fixed
-     * {@code IndexColorModel}. The color model will be generated for each
-     * filtering, unless the destination image already has an
-     * {@code IndexColorModel}.
-     */
-    public DiffusionDither() {
-        this(null);
-    }
-
-    /**
-     * Sets the scan mode. If the parameter is true, error distribution for
-     * every even line will be left-to-right, while odd lines will be
-     * right-to-left.
-     * The default is {@code true}.
-     *
-     * @param pUse {@code true} if scan mode should be alternating left/right
-     */
-    public void setAlternateScans(boolean pUse) {
-        alternateScans = pUse;
-    }
-
-    /**
-     * Creates a compatible {@code BufferedImage} to dither into.
-     * Only {@code IndexColorModel} allowed.
-     *
-     * @return a compatible {@code BufferedImage}
-     *
-     * @throws ImageFilterException if {@code pDestCM} is not {@code null} or
-     * an instance of {@code IndexColorModel}.
-     */
-    public final BufferedImage createCompatibleDestImage(BufferedImage pSource, ColorModel pDestCM) {
-        if (pDestCM == null) {
-            return new BufferedImage(pSource.getWidth(), pSource.getHeight(),
-                                     BufferedImage.TYPE_BYTE_INDEXED,
-                                     getICM(pSource));
-        }
-        else if (pDestCM instanceof IndexColorModel) {
-            return new BufferedImage(pSource.getWidth(), pSource.getHeight(),
-                                     BufferedImage.TYPE_BYTE_INDEXED,
-                                     (IndexColorModel) pDestCM);
-        }
-        else {
-            throw new ImageFilterException("Only IndexColorModel allowed.");
-        }
-    }
-
-    /**
-     * Creates a compatible {@code Raster} to dither into.
-     * Only {@code IndexColorModel} allowed.
-     *
-     * @param pSrc the source raster
-     *
-     * @return a {@code WritableRaster}
-     */
-    public final WritableRaster createCompatibleDestRaster(Raster pSrc) {
-        return createCompatibleDestRaster(pSrc, getICM(pSrc));
-    }
-
-    /**
-     * Creates a compatible {@code Raster} to dither into.
-     *
-     * @param pSrc the source raster.
-     * @param pIndexColorModel the index color model used to create a {@code Raster}.
-     *
-     * @return a {@code WritableRaster}
-     */
-    public final WritableRaster createCompatibleDestRaster(Raster pSrc, IndexColorModel pIndexColorModel) {
-        return pIndexColorModel.createCompatibleWritableRaster(pSrc.getWidth(), pSrc.getHeight());
-    }
-
-
-    /**
-     * Returns the bounding box of the filtered destination image.  Since
-     * this is not a geometric operation, the bounding box does not
-     * change.
-     * @param pSrc the {@code BufferedImage} to be filtered
-     * @return the bounds of the filtered definition image.
-     */
-    public final Rectangle2D getBounds2D(BufferedImage pSrc) {
-        return getBounds2D(pSrc.getRaster());
-    }
-
-    /**
-     * Returns the bounding box of the filtered destination Raster.  Since
-     * this is not a geometric operation, the bounding box does not
-     * change.
-     * @param pSrc the {@code Raster} to be filtered
-     * @return the bounds of the filtered definition {@code Raster}.
-     */
-    public final Rectangle2D getBounds2D(Raster pSrc) {
-        return pSrc.getBounds();
-    }
-
-    /**
-     * Returns the location of the destination point given a
-     * point in the source.  If {@code dstPt} is not
-     * {@code null}, it will be used to hold the return value.
-     * Since this is not a geometric operation, the {@code srcPt}
-     * will equal the {@code dstPt}.
-     * @param pSrcPt a {@code Point2D} that represents a point
-     *        in the source image
-     * @param pDstPt a {@code Point2D}that represents the location
-     *        in the destination
-     * @return the {@code Point2D} in the destination that
-     *         corresponds to the specified point in the source.
-     */
-    public final Point2D getPoint2D(Point2D pSrcPt, Point2D pDstPt) {
-        // Create new Point, if needed
-        if (pDstPt == null) {
-            pDstPt = new Point2D.Float();
-        }
-
-        // Copy location
-        pDstPt.setLocation(pSrcPt.getX(), pSrcPt.getY());
-
-        // Return dest
-        return pDstPt;
-    }
-
-    /**
-     * Returns the rendering mHints for this op.
-     * @return the {@code RenderingHints} object associated
-     *         with this op.
-     */
-    public final RenderingHints getRenderingHints() {
-        return null;
-    }
-
-    /**
-     * Converts an int ARGB to int triplet.
-     */
-    private static int[] toRGBArray(int pARGB, int[] pBuffer) {
-        pBuffer[0] = ((pARGB & 0x00ff0000) >> 16);
-        pBuffer[1] = ((pARGB & 0x0000ff00) >> 8);
-        pBuffer[2] = ((pARGB & 0x000000ff));
-        //pBuffer[3] = ((pARGB & 0xff000000) >> 24); // alpha
-
-        return pBuffer;
-    }
-
-    /**
-     * Converts a int triplet to int ARGB.
-     */
-    private static int toIntARGB(int[] pRGB) {
-        return 0xff000000 // All opaque
-                | (pRGB[0] << 16)
-                | (pRGB[1] << 8)
-                | (pRGB[2]);
-        /*
-          | ((int) (pRGB[0] << 16) & 0x00ff0000)
-          | ((int) (pRGB[1] <<  8) & 0x0000ff00)
-          | ((int) (pRGB[2]      ) & 0x000000ff);
-        */
-    }
-
-
-    /**
-     * Performs a single-input/single-output dither operation, applying basic
-     * Floyd-Steinberg error-diffusion to the image.
-     *
-     * @param pSource the source image
-     * @param pDest the destination image
-     *
-     * @return the destination image, or a new image, if {@code pDest} was
-     * {@code null}.
-     */
-    public final BufferedImage filter(BufferedImage pSource, BufferedImage pDest) {
-        // Create destination image, if none provided
-        if (pDest == null) {
-            pDest = createCompatibleDestImage(pSource, getICM(pSource));
-        }
-        else if (!(pDest.getColorModel() instanceof IndexColorModel)) {
-            throw new ImageFilterException("Only IndexColorModel allowed.");
-        }
-
-        // Filter rasters
-        filter(pSource.getRaster(), pDest.getRaster(), (IndexColorModel) pDest.getColorModel());
-
-        return pDest;
-    }
-
-    /**
-     * Performs a single-input/single-output dither operation, applying basic
-     * Floyd-Steinberg error-diffusion to the image.
-     *
-     * @param pSource the source raster, assumed to be in sRGB
-     * @param pDest the destination raster, may be {@code null}
-     *
-     * @return the destination raster, or a new raster, if {@code pDest} was
-     * {@code null}.
-     */
-    public final WritableRaster filter(final Raster pSource, WritableRaster pDest) {
-        return filter(pSource, pDest, getICM(pSource));
-    }
-
-    private IndexColorModel getICM(BufferedImage pSource) {
-        return (indexColorModel != null ? indexColorModel : IndexImage.getIndexColorModel(pSource, 256, IndexImage.TRANSPARENCY_BITMASK));
-    }
-    private IndexColorModel getICM(Raster pSource) {
-        return (indexColorModel != null ? indexColorModel : createIndexColorModel(pSource));
-    }
-
-    private IndexColorModel createIndexColorModel(Raster pSource) {
-        BufferedImage image = new BufferedImage(pSource.getWidth(), pSource.getHeight(),
-                                                BufferedImage.TYPE_INT_ARGB);
-        image.setData(pSource);
-        return IndexImage.getIndexColorModel(image, 256, IndexImage.TRANSPARENCY_BITMASK);
-    }
-
-    /**
-     * Performs a single-input/single-output dither operation, applying basic
-     * Floyd-Steinberg error-diffusion to the image.
-     *
-     * @param pSource the source raster, assumed to be in sRGB
-     * @param pDest the destination raster, may be {@code null}
-     * @param pColorModel the indexed color model to use
-     *
-     * @return the destination raster, or a new raster, if {@code pDest} was
-     * {@code null}.
-     */
-    public final WritableRaster filter(final Raster pSource, WritableRaster pDest, IndexColorModel pColorModel) {
-        int width = pSource.getWidth();
-        int height = pSource.getHeight();
-
-        // Create destination raster if needed
-        if (pDest == null) {
-            pDest = createCompatibleDestRaster(pSource, pColorModel);
-        }
-
-        // Initialize Floyd-Steinberg error vectors.
-        // +2 to handle the previous pixel and next pixel case minimally
-        // When reference for column, add 1 to reference as this buffer is
-        // offset from actual column position by one to allow FS to not check
-        // left/right edge conditions
-        int[][] currErr = new int[width + 2][3];
-        int[][] nextErr = new int[width + 2][3];
-
-        // Random errors in [-1 .. 1] - for first row
-        for (int i = 0; i < width + 2; i++) {
-            // Note: This is broken for the strange cases where nextInt returns Integer.MIN_VALUE
-            currErr[i][0] = RANDOM.nextInt(FS_SCALE * 2) - FS_SCALE;
-            currErr[i][1] = RANDOM.nextInt(FS_SCALE * 2) - FS_SCALE;
-            currErr[i][2] = RANDOM.nextInt(FS_SCALE * 2) - FS_SCALE;
-        }
-
-        // Temp buffers
-        final int[] diff = new int[3]; // No alpha
-        final int[] inRGB = new int[4];
-        final int[] outRGB = new int[4];
-        Object pixel = null;
-        boolean forward = true;
-
-        // Loop through image data
-        for (int y = 0; y < height; y++) {
-            // Clear out next error rows for colour errors
-            for (int i = nextErr.length; --i >= 0;) {
-                nextErr[i][0] = 0;
-                nextErr[i][1] = 0;
-                nextErr[i][2] = 0;
-            }
-
-            // Set up start column and limit
-            int x;
-            int limit;
-            if (forward) {
-                x = 0;
-                limit = width;
-            }
-            else {
-                x = width - 1;
-                limit = -1;
-            }
-
-            // TODO: Use getPixels instead of getPixel for better performance?            
-
-            // Loop over row
-            while (true) {
-                // Get RGB from original raster
-                // DON'T KNOW IF THIS WILL WORK FOR ALL TYPES.
-                pSource.getPixel(x, y, inRGB);
-
-                // Get error for this pixel & add error to rgb
-                for (int i = 0; i < 3; i++) {
-                    // Make a 28.4 FP number, add Error (with fraction),
-                    // rounding and truncate to int
-                    inRGB[i] = ((inRGB[i] << 4) + currErr[x + 1][i] + 0x08) >> 4;
-
-                    // Clamp
-                    if (inRGB[i] > 255) {
-                        inRGB[i] = 255;
-                    }
-                    else if (inRGB[i] < 0) {
-                        inRGB[i] = 0;
-                    }
-                }
-
-                // Get pixel value...
-                // It is VERY important that we are using a IndexColorModel that
-                // support reverse color lookup for speed.
-                pixel = pColorModel.getDataElements(toIntARGB(inRGB), pixel);
-
-                // ...set it...
-                pDest.setDataElements(x, y, pixel);
-
-                // ..and get back the closet match
-                pDest.getPixel(x, y, outRGB);
-
-                // Convert the value to default sRGB
-                // Should work for all transfertypes supported by IndexColorModel
-                toRGBArray(pColorModel.getRGB(outRGB[0]), outRGB);
-
-                // Find diff
-                diff[0] = inRGB[0] - outRGB[0];
-                diff[1] = inRGB[1] - outRGB[1];
-                diff[2] = inRGB[2] - outRGB[2];
-
-                // Apply F-S error diffusion
-                // Serpentine scan: left-right
-                if (forward) {
-                    // Row 1 (y)
-                    // Update error in this pixel (x + 1)
-                    currErr[x + 2][0] += diff[0] * 7;
-                    currErr[x + 2][1] += diff[1] * 7;
-                    currErr[x + 2][2] += diff[2] * 7;
-
-                    // Row 2 (y + 1)
-                    // Update error in this pixel (x - 1)
-                    nextErr[x][0] += diff[0] * 3;
-                    nextErr[x][1] += diff[1] * 3;
-                    nextErr[x][2] += diff[2] * 3;
-                    // Update error in this pixel (x)
-                    nextErr[x + 1][0] += diff[0] * 5;
-                    nextErr[x + 1][1] += diff[1] * 5;
-                    nextErr[x + 1][2] += diff[2] * 5;
-                    // Update error in this pixel (x + 1)
-                    // TODO: Consider calculating this using
-                    // error term = error - sum(error terms 1, 2 and 3)
-                    // See Computer Graphics (Foley et al.), p. 573
-                    nextErr[x + 2][0] += diff[0]; // * 1;
-                    nextErr[x + 2][1] += diff[1]; // * 1;
-                    nextErr[x + 2][2] += diff[2]; // * 1;
-
-                    // Next
-                    x++;
-
-                    // Done?
-                    if (x >= limit) {
-                        break;
-                    }
-
-                }
-                else {
-                    // Row 1 (y)
-                    // Update error in this pixel (x - 1)
-                    currErr[x][0] += diff[0] * 7;
-                    currErr[x][1] += diff[1] * 7;
-                    currErr[x][2] += diff[2] * 7;
-
-                    // Row 2 (y + 1)
-                    // Update error in this pixel (x + 1)
-                    nextErr[x + 2][0] += diff[0] * 3;
-                    nextErr[x + 2][1] += diff[1] * 3;
-                    nextErr[x + 2][2] += diff[2] * 3;
-                    // Update error in this pixel (x)
-                    nextErr[x + 1][0] += diff[0] * 5;
-                    nextErr[x + 1][1] += diff[1] * 5;
-                    nextErr[x + 1][2] += diff[2] * 5;
-                    // Update error in this pixel (x - 1)
-                    // TODO: Consider calculating this using
-                    // error term = error - sum(error terms 1, 2 and 3)
-                    // See Computer Graphics (Foley et al.), p. 573
-                    nextErr[x][0] += diff[0]; // * 1;
-                    nextErr[x][1] += diff[1]; // * 1;
-                    nextErr[x][2] += diff[2]; // * 1;
-
-                    // Previous
-                    x--;
-
-                    // Done?
-                    if (x <= limit) {
-                        break;
-                    }
-                }
-            }
-
-            // Make next error info current for next iteration
-            int[][] temperr;
-            temperr = currErr;
-            currErr = nextErr;
-            nextErr = temperr;
-
-            // Toggle direction
-            if (alternateScans) {
-                forward = !forward;
-            }
-        }
-
-        return pDest;
-    }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import java.awt.*;
+import java.awt.geom.Point2D;
+import java.awt.geom.Rectangle2D;
+import java.awt.image.*;
+import java.util.Random;
+
+/**
+ * This {@code BufferedImageOp/RasterOp} implements basic
+ * Floyd-Steinberg error-diffusion algorithm for dithering.
+ * <p>
+ * The weights used are 7/16, 3/16, 5/16 and 1/16, distributed like this:
+ * <!-- - -
+ *  | |x|7|
+ *  - - - -
+ *  |3|5|1|
+ *   - - -->
+ * </p>
+ * <table border="1">
+ *     <caption>Floyd-Steinberg error-diffusion weights</caption>
+ *     <tr><td style="background:#000000">&nbsp;</td><td class="TableHeadingColor"
+ *          style="text-align:center">x</td><td>7/16</td></tr>
+ *     <tr><td>3/16</td><td>5/16</td><td>1/16</td></tr>
+ * </table>
+ * <p>
+ * See <A href="http://www.awprofessional.com/bookstore/product.asp?isbn=0201848406&rl=1">Computer Graphics (Foley et al.)</a>
+ * for more information.
+ * </p>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ *
+ * @version $Id: DiffusionDither.java#1 $
+ */
+public class DiffusionDither implements BufferedImageOp, RasterOp {
+
+    private static final int FS_SCALE = 1 << 8;
+    private static final Random RANDOM = new Random();
+
+    protected final IndexColorModel indexColorModel;
+    private boolean alternateScans = true;
+
+    /**
+     * Creates a {@code DiffusionDither}, using the given
+     * {@code IndexColorModel} for dithering into.
+     *
+     * @param pICM an IndexColorModel.
+     */
+    public DiffusionDither(final IndexColorModel pICM) {
+        // Store color model
+        indexColorModel = pICM;
+    }
+
+    /**
+     * Creates a {@code DiffusionDither}, with no fixed
+     * {@code IndexColorModel}. The color model will be generated for each
+     * filtering, unless the destination image already has an
+     * {@code IndexColorModel}.
+     */
+    public DiffusionDither() {
+        this(null);
+    }
+
+    /**
+     * Sets the scan mode. If the parameter is true, error distribution for
+     * every even line will be left-to-right, while odd lines will be
+     * right-to-left.
+     * The default is {@code true}.
+     *
+     * @param pUse {@code true} if scan mode should be alternating left/right
+     */
+    public void setAlternateScans(boolean pUse) {
+        alternateScans = pUse;
+    }
+
+    /**
+     * Creates a compatible {@code BufferedImage} to dither into.
+     * Only {@code IndexColorModel} allowed.
+     *
+     * @return a compatible {@code BufferedImage}
+     *
+     * @throws ImageFilterException if {@code pDestCM} is not {@code null} or
+     * an instance of {@code IndexColorModel}.
+     */
+    public final BufferedImage createCompatibleDestImage(BufferedImage pSource, ColorModel pDestCM) {
+        if (pDestCM == null) {
+            return new BufferedImage(pSource.getWidth(), pSource.getHeight(),
+                                     BufferedImage.TYPE_BYTE_INDEXED,
+                                     getICM(pSource));
+        }
+        else if (pDestCM instanceof IndexColorModel) {
+            return new BufferedImage(pSource.getWidth(), pSource.getHeight(),
+                                     BufferedImage.TYPE_BYTE_INDEXED,
+                                     (IndexColorModel) pDestCM);
+        }
+        else {
+            throw new ImageFilterException("Only IndexColorModel allowed.");
+        }
+    }
+
+    /**
+     * Creates a compatible {@code Raster} to dither into.
+     * Only {@code IndexColorModel} allowed.
+     *
+     * @param pSrc the source raster
+     *
+     * @return a {@code WritableRaster}
+     */
+    public final WritableRaster createCompatibleDestRaster(Raster pSrc) {
+        return createCompatibleDestRaster(pSrc, getICM(pSrc));
+    }
+
+    /**
+     * Creates a compatible {@code Raster} to dither into.
+     *
+     * @param pSrc the source raster.
+     * @param pIndexColorModel the index color model used to create a {@code Raster}.
+     *
+     * @return a {@code WritableRaster}
+     */
+    public final WritableRaster createCompatibleDestRaster(Raster pSrc, IndexColorModel pIndexColorModel) {
+        return pIndexColorModel.createCompatibleWritableRaster(pSrc.getWidth(), pSrc.getHeight());
+    }
+
+
+    /**
+     * Returns the bounding box of the filtered destination image.  Since
+     * this is not a geometric operation, the bounding box does not
+     * change.
+     * @param pSrc the {@code BufferedImage} to be filtered
+     * @return the bounds of the filtered definition image.
+     */
+    public final Rectangle2D getBounds2D(BufferedImage pSrc) {
+        return getBounds2D(pSrc.getRaster());
+    }
+
+    /**
+     * Returns the bounding box of the filtered destination Raster.  Since
+     * this is not a geometric operation, the bounding box does not
+     * change.
+     * @param pSrc the {@code Raster} to be filtered
+     * @return the bounds of the filtered definition {@code Raster}.
+     */
+    public final Rectangle2D getBounds2D(Raster pSrc) {
+        return pSrc.getBounds();
+    }
+
+    /**
+     * Returns the location of the destination point given a
+     * point in the source.  If {@code dstPt} is not
+     * {@code null}, it will be used to hold the return value.
+     * Since this is not a geometric operation, the {@code srcPt}
+     * will equal the {@code dstPt}.
+     * @param pSrcPt a {@code Point2D} that represents a point
+     *        in the source image
+     * @param pDstPt a {@code Point2D}that represents the location
+     *        in the destination
+     * @return the {@code Point2D} in the destination that
+     *         corresponds to the specified point in the source.
+     */
+    public final Point2D getPoint2D(Point2D pSrcPt, Point2D pDstPt) {
+        // Create new Point, if needed
+        if (pDstPt == null) {
+            pDstPt = new Point2D.Float();
+        }
+
+        // Copy location
+        pDstPt.setLocation(pSrcPt.getX(), pSrcPt.getY());
+
+        // Return dest
+        return pDstPt;
+    }
+
+    /**
+     * Returns the rendering mHints for this op.
+     * @return the {@code RenderingHints} object associated
+     *         with this op.
+     */
+    public final RenderingHints getRenderingHints() {
+        return null;
+    }
+
+    /**
+     * Converts an int ARGB to int triplet.
+     */
+    private static int[] toRGBArray(int pARGB, int[] pBuffer) {
+        pBuffer[0] = ((pARGB & 0x00ff0000) >> 16);
+        pBuffer[1] = ((pARGB & 0x0000ff00) >> 8);
+        pBuffer[2] = ((pARGB & 0x000000ff));
+        //pBuffer[3] = ((pARGB & 0xff000000) >> 24); // alpha
+
+        return pBuffer;
+    }
+
+    /**
+     * Converts a int triplet to int ARGB.
+     */
+    private static int toIntARGB(int[] pRGB) {
+        return 0xff000000 // All opaque
+                | (pRGB[0] << 16)
+                | (pRGB[1] << 8)
+                | (pRGB[2]);
+        /*
+          | ((int) (pRGB[0] << 16) & 0x00ff0000)
+          | ((int) (pRGB[1] <<  8) & 0x0000ff00)
+          | ((int) (pRGB[2]      ) & 0x000000ff);
+        */
+    }
+
+
+    /**
+     * Performs a single-input/single-output dither operation, applying basic
+     * Floyd-Steinberg error-diffusion to the image.
+     *
+     * @param pSource the source image
+     * @param pDest the destination image
+     *
+     * @return the destination image, or a new image, if {@code pDest} was
+     * {@code null}.
+     */
+    public final BufferedImage filter(BufferedImage pSource, BufferedImage pDest) {
+        // Create destination image, if none provided
+        if (pDest == null) {
+            pDest = createCompatibleDestImage(pSource, getICM(pSource));
+        }
+        else if (!(pDest.getColorModel() instanceof IndexColorModel)) {
+            throw new ImageFilterException("Only IndexColorModel allowed.");
+        }
+
+        // Filter rasters
+        filter(pSource.getRaster(), pDest.getRaster(), (IndexColorModel) pDest.getColorModel());
+
+        return pDest;
+    }
+
+    /**
+     * Performs a single-input/single-output dither operation, applying basic
+     * Floyd-Steinberg error-diffusion to the image.
+     *
+     * @param pSource the source raster, assumed to be in sRGB
+     * @param pDest the destination raster, may be {@code null}
+     *
+     * @return the destination raster, or a new raster, if {@code pDest} was
+     * {@code null}.
+     */
+    public final WritableRaster filter(final Raster pSource, WritableRaster pDest) {
+        return filter(pSource, pDest, getICM(pSource));
+    }
+
+    private IndexColorModel getICM(BufferedImage pSource) {
+        return (indexColorModel != null ? indexColorModel : IndexImage.getIndexColorModel(pSource, 256, IndexImage.TRANSPARENCY_BITMASK));
+    }
+    private IndexColorModel getICM(Raster pSource) {
+        return (indexColorModel != null ? indexColorModel : createIndexColorModel(pSource));
+    }
+
+    private IndexColorModel createIndexColorModel(Raster pSource) {
+        BufferedImage image = new BufferedImage(pSource.getWidth(), pSource.getHeight(),
+                                                BufferedImage.TYPE_INT_ARGB);
+        image.setData(pSource);
+        return IndexImage.getIndexColorModel(image, 256, IndexImage.TRANSPARENCY_BITMASK);
+    }
+
+    /**
+     * Performs a single-input/single-output dither operation, applying basic
+     * Floyd-Steinberg error-diffusion to the image.
+     *
+     * @param pSource the source raster, assumed to be in sRGB
+     * @param pDest the destination raster, may be {@code null}
+     * @param pColorModel the indexed color model to use
+     *
+     * @return the destination raster, or a new raster, if {@code pDest} was
+     * {@code null}.
+     */
+    public final WritableRaster filter(final Raster pSource, WritableRaster pDest, IndexColorModel pColorModel) {
+        int width = pSource.getWidth();
+        int height = pSource.getHeight();
+
+        // Create destination raster if needed
+        if (pDest == null) {
+            pDest = createCompatibleDestRaster(pSource, pColorModel);
+        }
+
+        // Initialize Floyd-Steinberg error vectors.
+        // +2 to handle the previous pixel and next pixel case minimally
+        // When reference for column, add 1 to reference as this buffer is
+        // offset from actual column position by one to allow FS to not check
+        // left/right edge conditions
+        int[][] currErr = new int[width + 2][3];
+        int[][] nextErr = new int[width + 2][3];
+
+        // Random errors in [-1 .. 1] - for first row
+        for (int i = 0; i < width + 2; i++) {
+            // Note: This is broken for the strange cases where nextInt returns Integer.MIN_VALUE
+            currErr[i][0] = RANDOM.nextInt(FS_SCALE * 2) - FS_SCALE;
+            currErr[i][1] = RANDOM.nextInt(FS_SCALE * 2) - FS_SCALE;
+            currErr[i][2] = RANDOM.nextInt(FS_SCALE * 2) - FS_SCALE;
+        }
+
+        // Temp buffers
+        final int[] diff = new int[3]; // No alpha
+        final int[] inRGB = new int[4];
+        final int[] outRGB = new int[4];
+        Object pixel = null;
+        boolean forward = true;
+
+        // Loop through image data
+        for (int y = 0; y < height; y++) {
+            // Clear out next error rows for colour errors
+            for (int i = nextErr.length; --i >= 0;) {
+                nextErr[i][0] = 0;
+                nextErr[i][1] = 0;
+                nextErr[i][2] = 0;
+            }
+
+            // Set up start column and limit
+            int x;
+            int limit;
+            if (forward) {
+                x = 0;
+                limit = width;
+            }
+            else {
+                x = width - 1;
+                limit = -1;
+            }
+
+            // TODO: Use getPixels instead of getPixel for better performance?            
+
+            // Loop over row
+            while (true) {
+                // Get RGB from original raster
+                // DON'T KNOW IF THIS WILL WORK FOR ALL TYPES.
+                pSource.getPixel(x, y, inRGB);
+
+                // Get error for this pixel & add error to rgb
+                for (int i = 0; i < 3; i++) {
+                    // Make a 28.4 FP number, add Error (with fraction),
+                    // rounding and truncate to int
+                    inRGB[i] = ((inRGB[i] << 4) + currErr[x + 1][i] + 0x08) >> 4;
+
+                    // Clamp
+                    if (inRGB[i] > 255) {
+                        inRGB[i] = 255;
+                    }
+                    else if (inRGB[i] < 0) {
+                        inRGB[i] = 0;
+                    }
+                }
+
+                // Get pixel value...
+                // It is VERY important that we are using a IndexColorModel that
+                // support reverse color lookup for speed.
+                pixel = pColorModel.getDataElements(toIntARGB(inRGB), pixel);
+
+                // ...set it...
+                pDest.setDataElements(x, y, pixel);
+
+                // ..and get back the closet match
+                pDest.getPixel(x, y, outRGB);
+
+                // Convert the value to default sRGB
+                // Should work for all transfertypes supported by IndexColorModel
+                toRGBArray(pColorModel.getRGB(outRGB[0]), outRGB);
+
+                // Find diff
+                diff[0] = inRGB[0] - outRGB[0];
+                diff[1] = inRGB[1] - outRGB[1];
+                diff[2] = inRGB[2] - outRGB[2];
+
+                // Apply F-S error diffusion
+                // Serpentine scan: left-right
+                if (forward) {
+                    // Row 1 (y)
+                    // Update error in this pixel (x + 1)
+                    currErr[x + 2][0] += diff[0] * 7;
+                    currErr[x + 2][1] += diff[1] * 7;
+                    currErr[x + 2][2] += diff[2] * 7;
+
+                    // Row 2 (y + 1)
+                    // Update error in this pixel (x - 1)
+                    nextErr[x][0] += diff[0] * 3;
+                    nextErr[x][1] += diff[1] * 3;
+                    nextErr[x][2] += diff[2] * 3;
+                    // Update error in this pixel (x)
+                    nextErr[x + 1][0] += diff[0] * 5;
+                    nextErr[x + 1][1] += diff[1] * 5;
+                    nextErr[x + 1][2] += diff[2] * 5;
+                    // Update error in this pixel (x + 1)
+                    // TODO: Consider calculating this using
+                    // error term = error - sum(error terms 1, 2 and 3)
+                    // See Computer Graphics (Foley et al.), p. 573
+                    nextErr[x + 2][0] += diff[0]; // * 1;
+                    nextErr[x + 2][1] += diff[1]; // * 1;
+                    nextErr[x + 2][2] += diff[2]; // * 1;
+
+                    // Next
+                    x++;
+
+                    // Done?
+                    if (x >= limit) {
+                        break;
+                    }
+
+                }
+                else {
+                    // Row 1 (y)
+                    // Update error in this pixel (x - 1)
+                    currErr[x][0] += diff[0] * 7;
+                    currErr[x][1] += diff[1] * 7;
+                    currErr[x][2] += diff[2] * 7;
+
+                    // Row 2 (y + 1)
+                    // Update error in this pixel (x + 1)
+                    nextErr[x + 2][0] += diff[0] * 3;
+                    nextErr[x + 2][1] += diff[1] * 3;
+                    nextErr[x + 2][2] += diff[2] * 3;
+                    // Update error in this pixel (x)
+                    nextErr[x + 1][0] += diff[0] * 5;
+                    nextErr[x + 1][1] += diff[1] * 5;
+                    nextErr[x + 1][2] += diff[2] * 5;
+                    // Update error in this pixel (x - 1)
+                    // TODO: Consider calculating this using
+                    // error term = error - sum(error terms 1, 2 and 3)
+                    // See Computer Graphics (Foley et al.), p. 573
+                    nextErr[x][0] += diff[0]; // * 1;
+                    nextErr[x][1] += diff[1]; // * 1;
+                    nextErr[x][2] += diff[2]; // * 1;
+
+                    // Previous
+                    x--;
+
+                    // Done?
+                    if (x <= limit) {
+                        break;
+                    }
+                }
+            }
+
+            // Make next error info current for next iteration
+            int[][] temperr;
+            temperr = currErr;
+            currErr = nextErr;
+            nextErr = temperr;
+
+            // Toggle direction
+            if (alternateScans) {
+                forward = !forward;
+            }
+        }
+
+        return pDest;
+    }
 }

common/common-image/src/main/java/com/twelvemonkeys/image/GraphicsUtil.java

@@ -1,84 +1,86 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import java.awt.*;
-
-/**
- * GraphicsUtil
- *
- * @author <a href="mailto:harald.kuhr@gmail.no">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/GraphicsUtil.java#1 $
- */
-public final class GraphicsUtil {
-
-    /**
-     * Enables anti-aliasing in the {@code Graphics} object.
-     * <p/>
-     * Anti-aliasing is enabled by casting to {@code Graphics2D} and setting
-     * the rendering hint {@code RenderingHints.KEY_ANTIALIASING} to
-     * {@code RenderingHints.VALUE_ANTIALIAS_ON}.
-     *
-     * @param pGraphics the graphics object
-     * @throws ClassCastException if {@code pGraphics} is not an instance of
-     *         {@code Graphics2D}.
-     *
-     * @see java.awt.RenderingHints#KEY_ANTIALIASING
-     */
-    public static void enableAA(final Graphics pGraphics) {
-        ((Graphics2D) pGraphics).setRenderingHint(
-                RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON
-        );
-    }
-
-    /**
-     * Sets the alpha in the {@code Graphics} object.
-     * <p/>
-     * Alpha is set by casting to {@code Graphics2D} and setting the composite
-     * to the rule {@code AlphaComposite.SRC_OVER} multiplied by the given
-     * alpha.
-     *
-     * @param pGraphics the graphics object
-     * @param pAlpha the alpha level, {@code alpha} must be a floating point
-     *        number in the inclusive range [0.0,&nbsp;1.0].
-     * @throws ClassCastException if {@code pGraphics} is not an instance of
-     *         {@code Graphics2D}.
-     *
-     * @see java.awt.AlphaComposite#SRC_OVER
-     * @see java.awt.AlphaComposite#getInstance(int, float)
-     */
-    public static void setAlpha(final Graphics pGraphics, final float pAlpha) {
-        ((Graphics2D) pGraphics).setComposite(
-                AlphaComposite.getInstance(AlphaComposite.SRC_OVER, pAlpha)
-        );
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import java.awt.*;
+
+/**
+ * GraphicsUtil
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.no">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/GraphicsUtil.java#1 $
+ */
+public final class GraphicsUtil {
+
+    /**
+     * Enables anti-aliasing in the {@code Graphics} object.
+     * <p>
+     * Anti-aliasing is enabled by casting to {@code Graphics2D} and setting
+     * the rendering hint {@code RenderingHints.KEY_ANTIALIASING} to
+     * {@code RenderingHints.VALUE_ANTIALIAS_ON}.
+     * </p>
+     *
+     * @param pGraphics the graphics object
+     * @throws ClassCastException if {@code pGraphics} is not an instance of
+     *         {@code Graphics2D}.
+     *
+     * @see java.awt.RenderingHints#KEY_ANTIALIASING
+     */
+    public static void enableAA(final Graphics pGraphics) {
+        ((Graphics2D) pGraphics).setRenderingHint(
+                RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON
+        );
+    }
+
+    /**
+     * Sets the alpha in the {@code Graphics} object.
+     * <p>
+     * Alpha is set by casting to {@code Graphics2D} and setting the composite
+     * to the rule {@code AlphaComposite.SRC_OVER} multiplied by the given
+     * alpha.
+     * </p>
+     *
+     * @param pGraphics the graphics object
+     * @param pAlpha the alpha level, {@code alpha} must be a floating point
+     *        number in the inclusive range [0.0,&nbsp;1.0].
+     * @throws ClassCastException if {@code pGraphics} is not an instance of
+     *         {@code Graphics2D}.
+     *
+     * @see java.awt.AlphaComposite#SRC_OVER
+     * @see java.awt.AlphaComposite#getInstance(int, float)
+     */
+    public static void setAlpha(final Graphics pGraphics, final float pAlpha) {
+        ((Graphics2D) pGraphics).setComposite(
+                AlphaComposite.getInstance(AlphaComposite.SRC_OVER, pAlpha)
+        );
+    }
+}

common/common-image/src/main/java/com/twelvemonkeys/image/GrayFilter.java

@@ -1,131 +1,132 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import java.awt.image.RGBImageFilter;
-
-/**
- * This class can convert a color image to grayscale.
- * <P/>
- * Uses ITU standard conversion: (222 * Red + 707 * Green + 71 * Blue) / 1000.
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- *
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/GrayFilter.java#1 $
- *
- */
-public class GrayFilter extends RGBImageFilter {
-
-    // This filter can filter IndexColorModel
-    {
-        canFilterIndexColorModel = true;
-    }
-
-    private int low = 0;
-    private float range = 1.0f;
-
-    /**
-     * Constructs a GrayFilter using ITU color-conversion.
-     */
-    public GrayFilter() {
-    }
-
-    /**
-     * Constructs a GrayFilter using ITU color-conversion, and a dynamic range between
-     * pLow and pHigh.
-     *
-     * @param pLow float in the range  0..1
-     * @param pHigh float in the range 0..1 and >= pLow
-     */
-    public GrayFilter(float pLow, float pHigh) {
-        if (pLow > pHigh) {
-            pLow = 0f;
-        }
-        // Make sure high and low are inside range
-        if (pLow < 0f) {
-            pLow = 0f;
-        }
-        else if (pLow > 1f) {
-            pLow = 1f;
-        }
-        if (pHigh < 0f) {
-            pHigh = 0f;
-        }
-        else if (pHigh > 1f) {
-            pHigh = 1f;
-        }
-
-        low = (int) (pLow * 255f);
-        range = pHigh - pLow;
-
-    }
-
-    /**
-     * Constructs a GrayFilter using ITU color-conversion, and a dynamic
-     * range between pLow and pHigh.
-     *
-     * @param pLow integer in the range 0..255
-     * @param pHigh inteeger in the range 0..255 and >= pLow
-     */
-    public GrayFilter(int pLow, int pHigh) {
-        this(pLow / 255f, pHigh / 255f);
-    }
-
-    /**
-     * Filters one pixel using ITU color-conversion.
-     *
-     * @param pX x
-     * @param pY y
-     * @param pARGB pixel value in default color space
-     *
-     * @return the filtered pixel value in the default color space
-     */
-    public int filterRGB(int pX, int pY, int pARGB) {
-        // Get color components
-        int r = pARGB >> 16 & 0xFF;
-        int g = pARGB >>  8 & 0xFF;
-        int b = pARGB       & 0xFF;
-
-        // ITU standard:  Gray scale=(222*Red+707*Green+71*Blue)/1000
-        int gray = (222 * r + 707 * g + 71 * b) / 1000;
-
-        //int gray = (int) ((float) (r + g + b) / 3.0f);
-
-        if (range != 1.0f) {
-            // Apply range
-            gray =  low + (int) (gray * range);
-        }
-
-        // Return ARGB pixel
-        return  (pARGB & 0xFF000000) | (gray << 16) | (gray << 8) | gray;
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import java.awt.image.RGBImageFilter;
+
+/**
+ * This class can convert a color image to grayscale.
+ * <p>
+ * Uses ITU standard conversion: (222 * Red + 707 * Green + 71 * Blue) / 1000.
+ * </p>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ *
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/GrayFilter.java#1 $
+ *
+ */
+public class GrayFilter extends RGBImageFilter {
+
+    // This filter can filter IndexColorModel
+    {
+        canFilterIndexColorModel = true;
+    }
+
+    private int low = 0;
+    private float range = 1.0f;
+
+    /**
+     * Constructs a GrayFilter using ITU color-conversion.
+     */
+    public GrayFilter() {
+    }
+
+    /**
+     * Constructs a GrayFilter using ITU color-conversion, and a dynamic range between
+     * pLow and pHigh.
+     *
+     * @param pLow float in the range  0..1
+     * @param pHigh float in the range 0..1 and &gt;= pLow
+     */
+    public GrayFilter(float pLow, float pHigh) {
+        if (pLow > pHigh) {
+            pLow = 0f;
+        }
+        // Make sure high and low are inside range
+        if (pLow < 0f) {
+            pLow = 0f;
+        }
+        else if (pLow > 1f) {
+            pLow = 1f;
+        }
+        if (pHigh < 0f) {
+            pHigh = 0f;
+        }
+        else if (pHigh > 1f) {
+            pHigh = 1f;
+        }
+
+        low = (int) (pLow * 255f);
+        range = pHigh - pLow;
+
+    }
+
+    /**
+     * Constructs a GrayFilter using ITU color-conversion, and a dynamic
+     * range between pLow and pHigh.
+     *
+     * @param pLow integer in the range 0..255
+     * @param pHigh integer in the range 0..255 and &gt;= pLow
+     */
+    public GrayFilter(int pLow, int pHigh) {
+        this(pLow / 255f, pHigh / 255f);
+    }
+
+    /**
+     * Filters one pixel using ITU color-conversion.
+     *
+     * @param pX x
+     * @param pY y
+     * @param pARGB pixel value in default color space
+     *
+     * @return the filtered pixel value in the default color space
+     */
+    public int filterRGB(int pX, int pY, int pARGB) {
+        // Get color components
+        int r = pARGB >> 16 & 0xFF;
+        int g = pARGB >>  8 & 0xFF;
+        int b = pARGB       & 0xFF;
+
+        // ITU standard:  Gray scale=(222*Red+707*Green+71*Blue)/1000
+        int gray = (222 * r + 707 * g + 71 * b) / 1000;
+
+        //int gray = (int) ((float) (r + g + b) / 3.0f);
+
+        if (range != 1.0f) {
+            // Apply range
+            gray =  low + (int) (gray * range);
+        }
+
+        // Return ARGB pixel
+        return  (pARGB & 0xFF000000) | (gray << 16) | (gray << 8) | gray;
+    }
+}

common/common-image/src/main/java/com/twelvemonkeys/image/InverseColorMap.java

@@ -1,213 +1,214 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-/**
- * Inverse Colormap to provide efficient lookup of any given input color
- * to the closest match to the given color map.
- * <p/>
- * Based on "Efficient Inverse Color Map Computation" by Spencer W. Thomas
- * in "Graphics Gems Volume II"
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author Robin Luiten (Java port)
- * @author Spencer W. Thomas (original c version).
- *
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/InverseColorMap.java#1 $
- */
-class InverseColorMap {
-    /**
-     * Number of high bits of each color channel to use to lookup near match
-     */
-    final static int QUANTBITS = 5;
-
-    /**
-     * Truncated bits of each color channel
-     */
-    final static int TRUNCBITS = 8 - QUANTBITS;
-
-    /**
-     * BITMASK representing the bits for blue in the color lookup
-     */
-    final static int QUANTMASK_BLUE = (1 << 5) - 1;
-
-    /**
-     * BITMASK representing the bits for green in the color lookup
-     */
-    final static int QUANTMASK_GREEN = (QUANTMASK_BLUE << QUANTBITS);
-
-    /**
-     * BITMASK representing the bits for red in the color lookup
-     */
-    final static int QUANTMASK_RED = (QUANTMASK_GREEN << QUANTBITS);
-
-    /**
-     * Maximum value a quantised color channel can have
-     */
-    final static int MAXQUANTVAL = 1 << 5;
-
-    byte[] rgbMapByte;
-    int[] rgbMapInt;
-    int numColors;
-    int maxColor;
-    byte[] inverseRGB;   		// inverse rgb color map
-    int transparentIndex = -1;
-
-    /**
-     * @param pRGBColorMap the rgb color map to create inverse color map for.
-     */
-    InverseColorMap(byte[] pRGBColorMap) {
-        this(pRGBColorMap, -1);
-    }
-
-    /**
-     * @param pRGBColorMap the rgb color map to create inverse color map for.
-     */
-    // HaraldK 20040801: Added support for int[]
-    InverseColorMap(int[] pRGBColorMap) {
-        this(pRGBColorMap, -1);
-    }
-
-    /**
-     * @param pRGBColorMap the rgb color map to create inverse color map for.
-     * @param pTransparent the index of the transparent pixel in the map
-     */
-    InverseColorMap(byte[] pRGBColorMap, int pTransparent) {
-        rgbMapByte = pRGBColorMap;
-        numColors = rgbMapByte.length / 4;
-        transparentIndex = pTransparent;
-
-        inverseRGB = new byte[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL];
-        initIRGB(new int[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL]);
-    }
-
-    /**
-     * @param pRGBColorMap the rgb color map to create inverse color map for.
-     * @param pTransparent the index of the transparent pixel in the map
-     */
-    InverseColorMap(int[] pRGBColorMap, int pTransparent) {
-        rgbMapInt = pRGBColorMap;
-        numColors = rgbMapInt.length;
-        transparentIndex = pTransparent;
-
-        inverseRGB = new byte[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL];
-        initIRGB(new int[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL]);
-    }
-
-
-    /**
-     * Simple inverse color table creation method.
-     * @param pTemp temp array
-     */
-    void initIRGB(int[] pTemp) {
-        final int x = (1 << TRUNCBITS);        // 8 the size of 1 Dimension of each quantized cell
-        final int xsqr = 1 << (TRUNCBITS * 2); // 64 - twice the smallest step size vale of quantized colors
-        final int xsqr2 = xsqr + xsqr;
-
-        for (int i = 0; i < numColors; ++i) {
-            if (i == transparentIndex) {
-                // Skip the transparent pixel
-                continue;
-            }
-
-            int red, r, rdist, rinc, rxx;
-            int green, g, gdist, ginc, gxx;
-            int blue, b, bdist, binc, bxx;
-
-            // HaraldK 20040801: Added support for int[]
-            if (rgbMapByte != null) {
-                red = rgbMapByte[i * 4] & 0xFF;
-                green = rgbMapByte[i * 4 + 1] & 0xFF;
-                blue = rgbMapByte[i * 4 + 2] & 0xFF;
-            }
-            else if (rgbMapInt != null) {
-                red = (rgbMapInt[i] >> 16) & 0xFF;
-                green = (rgbMapInt[i] >> 8) & 0xFF;
-                blue = rgbMapInt[i] & 0xFF;
-            }
-            else {
-                throw new IllegalStateException("colormap == null");
-            }
-
-            rdist = red - x / 2;   // distance of red to center of current cell
-            gdist = green - x / 2; // green
-            bdist = blue - x / 2;  // blue
-            rdist = rdist * rdist + gdist * gdist + bdist * bdist;
-
-            rinc = 2 * (xsqr - (red << TRUNCBITS));
-            ginc = 2 * (xsqr - (green << TRUNCBITS));
-            binc = 2 * (xsqr - (blue << TRUNCBITS));
-
-            int rgbI = 0;
-            for (r = 0, rxx = rinc; r < MAXQUANTVAL; rdist += rxx, ++r, rxx += xsqr2) {
-                for (g = 0, gdist = rdist, gxx = ginc; g < MAXQUANTVAL; gdist += gxx, ++g, gxx += xsqr2) {
-                    for (b = 0, bdist = gdist, bxx = binc; b < MAXQUANTVAL; bdist += bxx, ++b, ++rgbI, bxx += xsqr2) {
-                        if (i == 0 || pTemp[rgbI] > bdist) {
-                            pTemp[rgbI] = bdist;
-                            inverseRGB[rgbI] = (byte) i;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-    /**
-     * Gets the index of the nearest color to from the color map.
-     *
-     * @param pColor the color to get the nearest color to from color map
-     *        color must be of format {@code 0x00RRGGBB} - standard default RGB
-     * @return index of color which closest matches input color by using the
-     *         created inverse color map.
-     */
-    public final int getIndexNearest(int pColor) {
-        return inverseRGB[((pColor >> (3 * TRUNCBITS)) & QUANTMASK_RED) +
-                ((pColor >> (2 * TRUNCBITS)) & QUANTMASK_GREEN) +
-                ((pColor >> (/* 1 * */ TRUNCBITS)) & QUANTMASK_BLUE)] & 0xFF;
-    }
-
-    /**
-     * Gets the index of the nearest color to from the color map.
-     *
-     * @param pRed red component of the color to get the nearest color to from color map
-     * @param pGreen green component of the color to get the nearest color to from color map
-     * @param pBlue blue component of the color to get the nearest color to from color map
-     * @return index of color which closest matches input color by using the
-     *         created inverse color map.
-     */
-    public final int getIndexNearest(int pRed, int pGreen, int pBlue) {
-        // NOTE: the third line in expression for blue is shifting DOWN not UP.
-        return inverseRGB[((pRed << (2 * QUANTBITS - TRUNCBITS)) & QUANTMASK_RED) +
-                ((pGreen << (/* 1 * */ QUANTBITS - TRUNCBITS)) & QUANTMASK_GREEN) +
-                ((pBlue >> (TRUNCBITS)) & QUANTMASK_BLUE)] & 0xFF;
-    }
-}
-
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+/**
+ * Inverse Colormap to provide efficient lookup of any given input color
+ * to the closest match to the given color map.
+ * <p>
+ * Based on "Efficient Inverse Color Map Computation" by Spencer W. Thomas
+ * in "Graphics Gems Volume II".
+ * </p>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author Robin Luiten (Java port)
+ * @author Spencer W. Thomas (original c version).
+ *
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/InverseColorMap.java#1 $
+ */
+class InverseColorMap {
+    /**
+     * Number of high bits of each color channel to use to lookup near match
+     */
+    final static int QUANTBITS = 5;
+
+    /**
+     * Truncated bits of each color channel
+     */
+    final static int TRUNCBITS = 8 - QUANTBITS;
+
+    /**
+     * BITMASK representing the bits for blue in the color lookup
+     */
+    final static int QUANTMASK_BLUE = (1 << 5) - 1;
+
+    /**
+     * BITMASK representing the bits for green in the color lookup
+     */
+    final static int QUANTMASK_GREEN = (QUANTMASK_BLUE << QUANTBITS);
+
+    /**
+     * BITMASK representing the bits for red in the color lookup
+     */
+    final static int QUANTMASK_RED = (QUANTMASK_GREEN << QUANTBITS);
+
+    /**
+     * Maximum value a quantised color channel can have
+     */
+    final static int MAXQUANTVAL = 1 << 5;
+
+    byte[] rgbMapByte;
+    int[] rgbMapInt;
+    int numColors;
+    int maxColor;
+    byte[] inverseRGB;   		// inverse rgb color map
+    int transparentIndex = -1;
+
+    /**
+     * @param pRGBColorMap the rgb color map to create inverse color map for.
+     */
+    InverseColorMap(byte[] pRGBColorMap) {
+        this(pRGBColorMap, -1);
+    }
+
+    /**
+     * @param pRGBColorMap the rgb color map to create inverse color map for.
+     */
+    // HaraldK 20040801: Added support for int[]
+    InverseColorMap(int[] pRGBColorMap) {
+        this(pRGBColorMap, -1);
+    }
+
+    /**
+     * @param pRGBColorMap the rgb color map to create inverse color map for.
+     * @param pTransparent the index of the transparent pixel in the map
+     */
+    InverseColorMap(byte[] pRGBColorMap, int pTransparent) {
+        rgbMapByte = pRGBColorMap;
+        numColors = rgbMapByte.length / 4;
+        transparentIndex = pTransparent;
+
+        inverseRGB = new byte[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL];
+        initIRGB(new int[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL]);
+    }
+
+    /**
+     * @param pRGBColorMap the rgb color map to create inverse color map for.
+     * @param pTransparent the index of the transparent pixel in the map
+     */
+    InverseColorMap(int[] pRGBColorMap, int pTransparent) {
+        rgbMapInt = pRGBColorMap;
+        numColors = rgbMapInt.length;
+        transparentIndex = pTransparent;
+
+        inverseRGB = new byte[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL];
+        initIRGB(new int[MAXQUANTVAL * MAXQUANTVAL * MAXQUANTVAL]);
+    }
+
+
+    /**
+     * Simple inverse color table creation method.
+     * @param pTemp temp array
+     */
+    void initIRGB(int[] pTemp) {
+        final int x = (1 << TRUNCBITS);        // 8 the size of 1 Dimension of each quantized cell
+        final int xsqr = 1 << (TRUNCBITS * 2); // 64 - twice the smallest step size vale of quantized colors
+        final int xsqr2 = xsqr + xsqr;
+
+        for (int i = 0; i < numColors; ++i) {
+            if (i == transparentIndex) {
+                // Skip the transparent pixel
+                continue;
+            }
+
+            int red, r, rdist, rinc, rxx;
+            int green, g, gdist, ginc, gxx;
+            int blue, b, bdist, binc, bxx;
+
+            // HaraldK 20040801: Added support for int[]
+            if (rgbMapByte != null) {
+                red = rgbMapByte[i * 4] & 0xFF;
+                green = rgbMapByte[i * 4 + 1] & 0xFF;
+                blue = rgbMapByte[i * 4 + 2] & 0xFF;
+            }
+            else if (rgbMapInt != null) {
+                red = (rgbMapInt[i] >> 16) & 0xFF;
+                green = (rgbMapInt[i] >> 8) & 0xFF;
+                blue = rgbMapInt[i] & 0xFF;
+            }
+            else {
+                throw new IllegalStateException("colormap == null");
+            }
+
+            rdist = red - x / 2;   // distance of red to center of current cell
+            gdist = green - x / 2; // green
+            bdist = blue - x / 2;  // blue
+            rdist = rdist * rdist + gdist * gdist + bdist * bdist;
+
+            rinc = 2 * (xsqr - (red << TRUNCBITS));
+            ginc = 2 * (xsqr - (green << TRUNCBITS));
+            binc = 2 * (xsqr - (blue << TRUNCBITS));
+
+            int rgbI = 0;
+            for (r = 0, rxx = rinc; r < MAXQUANTVAL; rdist += rxx, ++r, rxx += xsqr2) {
+                for (g = 0, gdist = rdist, gxx = ginc; g < MAXQUANTVAL; gdist += gxx, ++g, gxx += xsqr2) {
+                    for (b = 0, bdist = gdist, bxx = binc; b < MAXQUANTVAL; bdist += bxx, ++b, ++rgbI, bxx += xsqr2) {
+                        if (i == 0 || pTemp[rgbI] > bdist) {
+                            pTemp[rgbI] = bdist;
+                            inverseRGB[rgbI] = (byte) i;
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Gets the index of the nearest color to from the color map.
+     *
+     * @param pColor the color to get the nearest color to from color map
+     *        color must be of format {@code 0x00RRGGBB} - standard default RGB
+     * @return index of color which closest matches input color by using the
+     *         created inverse color map.
+     */
+    public final int getIndexNearest(int pColor) {
+        return inverseRGB[((pColor >> (3 * TRUNCBITS)) & QUANTMASK_RED) +
+                ((pColor >> (2 * TRUNCBITS)) & QUANTMASK_GREEN) +
+                ((pColor >> (/* 1 * */ TRUNCBITS)) & QUANTMASK_BLUE)] & 0xFF;
+    }
+
+    /**
+     * Gets the index of the nearest color to from the color map.
+     *
+     * @param pRed red component of the color to get the nearest color to from color map
+     * @param pGreen green component of the color to get the nearest color to from color map
+     * @param pBlue blue component of the color to get the nearest color to from color map
+     * @return index of color which closest matches input color by using the
+     *         created inverse color map.
+     */
+    public final int getIndexNearest(int pRed, int pGreen, int pBlue) {
+        // NOTE: the third line in expression for blue is shifting DOWN not UP.
+        return inverseRGB[((pRed << (2 * QUANTBITS - TRUNCBITS)) & QUANTMASK_RED) +
+                ((pGreen << (/* 1 * */ QUANTBITS - TRUNCBITS)) & QUANTMASK_GREEN) +
+                ((pBlue >> (TRUNCBITS)) & QUANTMASK_BLUE)] & 0xFF;
+    }
+}
+

common/common-image/src/main/java/com/twelvemonkeys/image/MagickAccelerator.java

@@ -1,187 +0,0 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-
-package com.twelvemonkeys.image;
-
-import com.twelvemonkeys.lang.SystemUtil;
-import magick.MagickImage;
-
-import java.awt.image.BufferedImage;
-import java.awt.image.BufferedImageOp;
-
-/**
- * This class accelerates certain graphics operations, using
- * JMagick and ImageMagick, if available.
- * If those libraries are not installed, this class silently does nothing.
- * <p/>
- * Set the system property {@code "com.twelvemonkeys.image.accel"} to
- * {@code false}, to disable, even if JMagick is installed.
- * Set the system property {@code "com.twelvemonkeys.image.magick.debug"} to
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/MagickAccelerator.java#3 $
- */
-final class MagickAccelerator {
-
-    private static final boolean DEBUG = Magick.DEBUG;
-    private static final boolean USE_MAGICK = useMagick();
-
-    private static final int RESAMPLE_OP = 0;
-
-    private static Class[] nativeOp = new Class[1];
-
-    static {
-        try {
-            nativeOp[RESAMPLE_OP] = Class.forName("com.twelvemonkeys.image.ResampleOp");
-        }
-        catch (ClassNotFoundException e) {
-            System.err.println("Could not find class: " + e);
-        }
-    }
-
-    private static boolean useMagick() {
-        try {
-            boolean available = SystemUtil.isClassAvailable("magick.MagickImage");
-
-            if (DEBUG && !available) {
-                System.err.print("ImageMagick bindings not available.");
-            }
-
-            boolean useMagick =
-                    available && !"FALSE".equalsIgnoreCase(System.getProperty("com.twelvemonkeys.image.accel"));
-
-            if (DEBUG) {
-                System.err.println(
-                        useMagick
-                                ? "Will use ImageMagick bindings to accelerate image resampling operations."
-                                : "Will not use ImageMagick to accelerate image resampling operations."
-                );
-            }
-
-            return useMagick;
-        }
-        catch (Throwable t) {
-            // Most probably in case of a SecurityManager
-            System.err.println("Could not enable ImageMagick bindings: " + t);
-            return false;
-        }
-    }
-
-    private static int getNativeOpIndex(Class pOpClass) {
-        for (int i = 0; i < nativeOp.length; i++) {
-            if (pOpClass == nativeOp[i]) {
-                return i;
-            }
-        }
-
-        return -1;
-    }
-
-    public static BufferedImage filter(BufferedImageOp pOperation, BufferedImage pInput, BufferedImage pOutput) {
-        if (!USE_MAGICK) {
-            return null;
-        }
-
-        BufferedImage result = null;
-        switch (getNativeOpIndex(pOperation.getClass())) {
-            case RESAMPLE_OP:
-                ResampleOp resample = (ResampleOp) pOperation;
-                result = resampleMagick(pInput, resample.width, resample.height, resample.filterType);
-
-                // NOTE: If output parameter is non-null, we have to return that
-                // image, instead of result
-                if (pOutput != null) {
-                    //pOutput.setData(result.getRaster()); // Fast, but less compatible
-                    // NOTE: For some reason, this is sometimes super-slow...?
-                    ImageUtil.drawOnto(pOutput, result);
-                    result = pOutput;
-                }
-
-                break;
-
-            default:
-                // Simply fall through, allowing acceleration to be added later
-                break;
-
-        }
-        
-        return result;
-    }
-
-    private static BufferedImage resampleMagick(BufferedImage pSrc, int pWidth, int pHeight, int pFilterType) {
-        // Convert to Magick, scale and convert back
-        MagickImage image = null;
-        MagickImage scaled = null;
-        try {
-            image = MagickUtil.toMagick(pSrc);
-
-            long start = 0;
-            if (DEBUG) {
-                start = System.currentTimeMillis();
-            }
-
-            // NOTE: setFilter affects zoomImage, NOT scaleImage
-            image.setFilter(pFilterType);
-            scaled = image.zoomImage(pWidth, pHeight);
-            //scaled = image.scaleImage(pWidth, pHeight); // AREA_AVERAGING
-
-            if (DEBUG) {
-                long time = System.currentTimeMillis() - start;
-                System.out.println("Filtered: " + time + " ms");
-            }
-
-            return MagickUtil.toBuffered(scaled);
-        }
-        //catch (MagickException e) {
-        catch (Exception e) {
-            // NOTE: Stupid workaround: If MagickException is caught, a
-            // NoClassDefFoundError is thrown, when MagickException class is
-            // unavailable...
-            if (e instanceof RuntimeException) {
-                throw (RuntimeException) e;
-            }
-
-            throw new ImageConversionException(e.getMessage(), e);
-        }
-        finally {
-            // NOTE: ImageMagick might be unstable after a while, if image data
-            // is not deallocated. The GC/finalize method handles this, but in
-            // special circumstances, it's not triggered often enough.
-            if (image != null) {
-                image.destroyImages();
-            }
-            if (scaled != null) {
-                scaled.destroyImages();
-            }
-        }
-    }
-}

common/common-image/src/main/java/com/twelvemonkeys/image/MagickUtil.java

@@ -1,616 +0,0 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import magick.ImageType;
-import magick.MagickException;
-import magick.MagickImage;
-import magick.PixelPacket;
-
-import java.awt.*;
-import java.awt.color.ColorSpace;
-import java.awt.color.ICC_ColorSpace;
-import java.awt.color.ICC_Profile;
-import java.awt.image.*;
-
-/**
- * Utility for converting JMagick {@code MagickImage}s to standard Java
- * {@code BufferedImage}s and back.
- * <p/>
- * <em>NOTE: This class is considered an implementation detail and not part of
- * the public API. This class is subject to change without further notice. 
- * You have been warned. :-)</em>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/MagickUtil.java#4 $
- */
-public final class MagickUtil {
-    // IMPORTANT NOTE: Disaster happens if any of these constants are used outside this class
-    // because you then have a dependency on MagickException (this is due to Java class loading
-    // and initialization magic).
-    // Do not use outside this class. If the constants need to be shared, move to Magick or ImageUtil.
-
-    /** Color Model usesd for bilevel (B/W) */
-    private static final IndexColorModel CM_MONOCHROME = MonochromeColorModel.getInstance();
-
-    /** Color Model usesd for raw ABGR */
-    private static final ColorModel CM_COLOR_ALPHA =
-            new ComponentColorModel(ColorSpace.getInstance(ColorSpace.CS_sRGB), new int[] {8, 8, 8, 8},
-                            true, true, Transparency.TRANSLUCENT, DataBuffer.TYPE_BYTE);
-
-    /** Color Model usesd for raw BGR */
-    private static final ColorModel CM_COLOR_OPAQUE =
-            new ComponentColorModel(ColorSpace.getInstance(ColorSpace.CS_sRGB), new int[] {8, 8, 8},
-                            false, false, Transparency.OPAQUE, DataBuffer.TYPE_BYTE);
-
-    /** Color Model usesd for raw RGB */
-    //private static final ColorModel CM_COLOR_RGB = new DirectColorModel(24, 0x00ff0000, 0x0000ff00, 0x000000ff, 0x0);
-
-    /** Color Model usesd for raw GRAY + ALPHA */
-    private static final ColorModel CM_GRAY_ALPHA =
-            new ComponentColorModel(ColorSpace.getInstance(ColorSpace.CS_GRAY),
-                            true, true, Transparency.TRANSLUCENT, DataBuffer.TYPE_BYTE);
-
-    /** Color Model usesd for raw GRAY */
-    private static final ColorModel CM_GRAY_OPAQUE =
-            new ComponentColorModel(ColorSpace.getInstance(ColorSpace.CS_GRAY),
-                            false, false, Transparency.OPAQUE, DataBuffer.TYPE_BYTE);
-
-    /** Band offsets for raw ABGR */
-    private static final int[] BAND_OFF_TRANS = new int[] {3, 2, 1, 0};
-
-    /** Band offsets for raw BGR */
-    private static final int[] BAND_OFF_OPAQUE = new int[] {2, 1, 0};
-
-    /** The point at {@code 0, 0} */
-    private static final Point LOCATION_UPPER_LEFT = new Point(0, 0);
-
-    private static final boolean DEBUG = Magick.DEBUG;
-
-    // Only static members and methods
-    private MagickUtil() {}
-
-    /**
-     * Converts a {@code MagickImage} to a {@code BufferedImage}.
-     * <p/>
-     * The conversion depends on {@code pImage}'s {@code ImageType}:
-     * <dl>
-     * <dt>{@code ImageType.BilevelType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_BYTE_BINARY}</dd>
-     *
-     * <dt>{@code ImageType.GrayscaleType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_BYTE_GRAY}</dd>
-     * <dt>{@code ImageType.GrayscaleMatteType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_USHORT_GRAY}</dd>
-     *
-     * <dt>{@code ImageType.PaletteType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_BYTE_BINARY} (for images
-     * with a palette of <= 16 colors) or {@code TYPE_BYTE_INDEXED}</dd>
-     * <dt>{@code ImageType.PaletteMatteType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_BYTE_BINARY} (for images
-     * with a palette of <= 16 colors) or {@code TYPE_BYTE_INDEXED}</dd>
-     *
-     * <dt>{@code ImageType.TrueColorType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_3BYTE_BGR}</dd>
-     * <dt>{@code ImageType.TrueColorPaletteType}</dt>
-     * <dd>{@code BufferedImage} of type {@code TYPE_4BYTE_ABGR}</dd>
-     *
-     * @param pImage the original {@code MagickImage}
-     * @return a new {@code BufferedImage}
-     *
-     * @throws IllegalArgumentException if {@code pImage} is {@code null}
-     * or if the {@code ImageType} is not one mentioned above.
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    public static BufferedImage toBuffered(MagickImage pImage) throws MagickException {
-        if (pImage == null) {
-            throw new IllegalArgumentException("image == null");
-        }
-
-        long start = 0L;
-        if (DEBUG) {
-            start = System.currentTimeMillis();
-        }
-
-        BufferedImage image = null;
-        try {
-            switch (pImage.getImageType()) {
-                case ImageType.BilevelType:
-                    image = bilevelToBuffered(pImage);
-                    break;
-                case ImageType.GrayscaleType:
-                    image = grayToBuffered(pImage, false);
-                    break;
-                case ImageType.GrayscaleMatteType:
-                    image = grayToBuffered(pImage, true);
-                    break;
-                case ImageType.PaletteType:
-                    image = paletteToBuffered(pImage, false);
-                    break;
-                case ImageType.PaletteMatteType:
-                    image = paletteToBuffered(pImage, true);
-                    break;
-                case ImageType.TrueColorType:
-                    image = rgbToBuffered(pImage, false);
-                    break;
-                case ImageType.TrueColorMatteType:
-                    image = rgbToBuffered(pImage, true);
-                    break;
-                case ImageType.ColorSeparationType:
-                    image = cmykToBuffered(pImage, false);
-                    break;
-                case ImageType.ColorSeparationMatteType:
-                    image = cmykToBuffered(pImage, true);
-                    break;
-                case ImageType.OptimizeType:
-                default:
-                    throw new IllegalArgumentException("Unknown JMagick image type: " + pImage.getImageType());
-            }
-
-        }
-        finally {
-            if (DEBUG) {
-                long time = System.currentTimeMillis() - start;
-                System.out.println("Converted JMagick image type: " + pImage.getImageType() + " to BufferedImage: " + image);
-                System.out.println("Conversion to BufferedImage: " + time + " ms");
-            }
-        }
-
-        return image;
-    }
-
-    /**
-     * Converts a {@code BufferedImage} to a {@code MagickImage}.
-     * <p/>
-     * The conversion depends on {@code pImage}'s {@code ColorModel}:
-     * <dl>
-     * <dt>{@code IndexColorModel} with 1 bit b/w</dt>
-     * <dd>{@code MagickImage} of type {@code ImageType.BilevelType}</dd>
-     * <dt>{@code IndexColorModel} &gt; 1 bit,</dt>
-     * <dd>{@code MagickImage} of type {@code ImageType.PaletteType}
-     * or {@code MagickImage} of type {@code ImageType.PaletteMatteType}
-     * depending on <tt>ColorModel.getAlpha()</dd>
-     *
-     * <dt>{@code ColorModel.getColorSpace().getType() == ColorSpace.TYPE_GRAY}</dt>
-     * <dd>{@code MagickImage} of type {@code ImageType.GrayscaleType}
-     * or {@code MagickImage} of type {@code ImageType.GrayscaleMatteType}
-     * depending on <tt>ColorModel.getAlpha()</dd>
-     *
-     * <dt>{@code ColorModel.getColorSpace().getType() == ColorSpace.TYPE_RGB}</dt>
-     * <dd>{@code MagickImage} of type {@code ImageType.TrueColorType}
-     * or {@code MagickImage} of type {@code ImageType.TrueColorPaletteType}</dd>
-     *
-     * @param pImage the original {@code BufferedImage}
-     * @return a new {@code MagickImage}
-     *
-     * @throws IllegalArgumentException if {@code pImage} is {@code null}
-     * or if the {@code ColorModel} is not one mentioned above.
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    public static MagickImage toMagick(BufferedImage pImage) throws MagickException {
-        if (pImage == null) {
-            throw new IllegalArgumentException("image == null");
-        }
-
-        long start = 0L;
-        if (DEBUG) {
-            start = System.currentTimeMillis();
-        }
-
-        try {
-            ColorModel cm = pImage.getColorModel();
-            if (cm instanceof IndexColorModel) {
-                // Handles both BilevelType, PaletteType and PaletteMatteType
-                return indexedToMagick(pImage, (IndexColorModel) cm, cm.hasAlpha());
-            }
-
-            switch (cm.getColorSpace().getType()) {
-                case ColorSpace.TYPE_GRAY:
-                    // Handles GrayType and GrayMatteType
-                    return grayToMagick(pImage, cm.hasAlpha());
-                case ColorSpace.TYPE_RGB:
-                    // Handles TrueColorType and TrueColorMatteType
-                    return rgbToMagic(pImage, cm.hasAlpha());
-                case ColorSpace.TYPE_CMY:
-                case ColorSpace.TYPE_CMYK:
-                case ColorSpace.TYPE_HLS:
-                case ColorSpace.TYPE_HSV:
-                    // Other types not supported yet
-                default:
-                    throw new IllegalArgumentException("Unknown buffered image type: " + pImage);
-            }
-        }
-        finally {
-            if (DEBUG) {
-                long time = System.currentTimeMillis() - start;
-                System.out.println("Conversion to MagickImage: " + time + " ms");
-            }
-        }
-    }
-
-    private static MagickImage rgbToMagic(BufferedImage pImage, boolean pAlpha) throws MagickException {
-        MagickImage image = new MagickImage();
-
-        BufferedImage buffered = ImageUtil.toBuffered(pImage, pAlpha ? BufferedImage.TYPE_4BYTE_ABGR : BufferedImage.TYPE_3BYTE_BGR);
-
-        // Need to get data of sub raster, not the full data array, this is
-        // just a convenient way
-        Raster raster;
-        if (buffered.getRaster().getParent() != null) {
-            raster = buffered.getData(new Rectangle(buffered.getWidth(), buffered.getHeight()));
-        }
-        else {
-            raster = buffered.getRaster();
-        }
-
-        image.constituteImage(buffered.getWidth(), buffered.getHeight(), pAlpha ? "ABGR" : "BGR",
-                              ((DataBufferByte) raster.getDataBuffer()).getData());
-
-        return image;
-    }
-
-    private static MagickImage grayToMagick(BufferedImage pImage, boolean pAlpha) throws MagickException {
-        MagickImage image = new MagickImage();
-
-        // TODO: Make a fix for TYPE_USHORT_GRAY
-        // The code below does not seem to work (JMagick issues?)...
-        /*
-        if (pImage.getType() == BufferedImage.TYPE_USHORT_GRAY) {
-            short[] data = ((DataBufferUShort) pImage.getRaster().getDataBuffer()).getData();
-            int[] intData = new int[data.length];
-            for (int i = 0; i < data.length; i++) {
-                intData[i] = (data[i] & 0xffff) * 0xffff;
-            }
-            image.constituteImage(pImage.getWidth(), pImage.getHeight(), "I", intData);
-
-            System.out.println("storageClass: " + image.getStorageClass());
-            System.out.println("depth: " + image.getDepth());
-            System.out.println("imageType: " + image.getImageType());
-        }
-        else {
-        */
-        BufferedImage buffered = ImageUtil.toBuffered(pImage, pAlpha ? BufferedImage.TYPE_4BYTE_ABGR : BufferedImage.TYPE_BYTE_GRAY);
-
-        // Need to get data of sub raster, not the full data array, this is
-        // just a convenient way
-        Raster raster;
-        if (buffered.getRaster().getParent() != null) {
-            raster = buffered.getData(new Rectangle(buffered.getWidth(), buffered.getHeight()));
-        }
-        else {
-            raster = buffered.getRaster();
-        }
-
-        image.constituteImage(buffered.getWidth(), buffered.getHeight(), pAlpha ? "ABGR" : "I", ((DataBufferByte) raster.getDataBuffer()).getData());
-        //}
-
-        return image;
-    }
-
-    private static MagickImage indexedToMagick(BufferedImage pImage, IndexColorModel pColorModel, boolean pAlpha) throws MagickException {
-        MagickImage image = rgbToMagic(pImage, pAlpha);
-
-        int mapSize = pColorModel.getMapSize();
-        image.setNumberColors(mapSize);
-
-        return image;
-    }
-
-    /*
-    public static MagickImage toMagick(BufferedImage pImage) throws MagickException {
-        if (pImage == null) {
-            throw new IllegalArgumentException("image == null");
-        }
-        
-        final int width = pImage.getWidth();
-        final int height = pImage.getHeight();
-
-        // int ARGB -> byte RGBA conversion
-        // NOTE: This is ImageMagick Q16 compatible raw RGBA format with 16 bits/sample...
-        //       For a Q8 build, we could probably go with half the space...
-        // NOTE: This is close to insanity, as it wastes extreme ammounts of memory
-        final int[] argb = new int[width];
-        final byte[] raw16 = new byte[width * height * 8];
-        for (int y = 0; y < height; y++) {
-            // Fetch one line of ARGB data
-            pImage.getRGB(0, y, width, 1, argb, 0, width);
-
-            for (int x = 0; x < width; x++) {
-                int pixel = (x + (y * width)) * 8;
-                raw16[pixel    ] = (byte) ((argb[x] >> 16) & 0xff); // R
-                raw16[pixel + 2] = (byte) ((argb[x] >>  8) & 0xff); // G
-                raw16[pixel + 4] = (byte) ((argb[x]      ) & 0xff); // B
-                raw16[pixel + 6] = (byte) ((argb[x] >> 24) & 0xff); // A
-            }
-        }
-
-        // Create magick image
-        ImageInfo info = new ImageInfo();
-        info.setMagick("RGBA"); // Raw RGBA samples
-        info.setSize(width + "x" + height); // String?!?
-
-        MagickImage image = new MagickImage(info);
-        image.setImageAttribute("depth", "8");
-
-        // Set pixel data in 16 bit raw RGBA format
-        image.blobToImage(info, raw16);
-
-        return image;
-    }
-    */
-
-    /**
-     * Converts a bi-level {@code MagickImage} to a {@code BufferedImage}, of
-     * type {@code TYPE_BYTE_BINARY}.
-     *
-     * @param pImage the original {@code MagickImage}
-     * @return a new {@code BufferedImage}
-     *
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    private static BufferedImage bilevelToBuffered(MagickImage pImage) throws MagickException {
-        // As there is no way to get the binary representation of the image,
-        // convert to gray, and the create a binary image from it
-        BufferedImage temp = grayToBuffered(pImage, false);
-
-        BufferedImage image = new BufferedImage(temp.getWidth(), temp.getHeight(), BufferedImage.TYPE_BYTE_BINARY, CM_MONOCHROME);
-
-        ImageUtil.drawOnto(image, temp);
-
-        return image;
-    }
-
-    /**
-     * Converts a gray {@code MagickImage} to a {@code BufferedImage}, of
-     * type {@code TYPE_USHORT_GRAY} or {@code TYPE_BYTE_GRAY}.
-     *
-     * @param pImage the original {@code MagickImage}
-     * @param pAlpha keep alpha channel
-     * @return a new {@code BufferedImage}
-     *
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    private static BufferedImage grayToBuffered(MagickImage pImage, boolean pAlpha) throws MagickException {
-        Dimension size = pImage.getDimension();
-        int length = size.width * size.height;
-        int bands = pAlpha ? 2 : 1;
-        byte[] pixels = new byte[length * bands];
-
-        // TODO: Make a fix for 16 bit TYPE_USHORT_GRAY?!
-        // Note: The ordering AI or I corresponds to BufferedImage
-        // TYPE_CUSTOM and TYPE_BYTE_GRAY respectively
-        pImage.dispatchImage(0, 0, size.width, size.height, pAlpha ? "AI" : "I", pixels);
-
-        // Init databuffer with array, to avoid allocation of empty array
-        DataBuffer buffer = new DataBufferByte(pixels, pixels.length);
-
-        int[] bandOffsets = pAlpha ? new int[] {1, 0} : new int[] {0};
-
-        WritableRaster raster =
-                Raster.createInterleavedRaster(buffer, size.width, size.height,
-                        size.width * bands, bands, bandOffsets, LOCATION_UPPER_LEFT);
-
-        return new BufferedImage(pAlpha ? CM_GRAY_ALPHA : CM_GRAY_OPAQUE, raster, pAlpha, null);
-    }
-
-    /**
-     * Converts a palette-based {@code MagickImage} to a
-     * {@code BufferedImage}, of type {@code TYPE_BYTE_BINARY} (for images
-     * with a palette of <= 16 colors) or {@code TYPE_BYTE_INDEXED}.
-     *
-     * @param pImage the original {@code MagickImage}
-     * @param pAlpha keep alpha channel
-     * @return a new {@code BufferedImage}
-     *
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    private static BufferedImage paletteToBuffered(MagickImage pImage, boolean pAlpha) throws MagickException {
-        // Create indexcolormodel for the image
-        IndexColorModel cm;
-
-        try {
-            cm = createIndexColorModel(pImage.getColormap(), pAlpha);
-        }
-        catch (MagickException e) {
-            // NOTE: Some MagickImages incorrecly (?) reports to be paletteType,
-            //       but does not have a colormap, this is a workaround.
-            return rgbToBuffered(pImage, pAlpha);
-        }
-
-        // As there is no way to get the indexes of an indexed image, convert to
-        // RGB, and the create an indexed image from it
-        BufferedImage temp = rgbToBuffered(pImage, pAlpha);
-
-        BufferedImage image;
-        if (cm.getMapSize() <= 16) {
-            image = new BufferedImage(temp.getWidth(), temp.getHeight(), BufferedImage.TYPE_BYTE_BINARY, cm);
-        }
-        else {
-            image = new BufferedImage(temp.getWidth(), temp.getHeight(), BufferedImage.TYPE_BYTE_INDEXED, cm);
-        }
-
-        // Create transparent background for images containing alpha
-        if (pAlpha) {
-            Graphics2D g = image.createGraphics();
-            try {
-                g.setComposite(AlphaComposite.Clear);
-                g.fillRect(0, 0, temp.getWidth(), temp.getHeight());
-            }
-            finally {
-                g.dispose();
-            }
-        }
-
-        // NOTE: This is (surprisingly) much faster than using g2d.drawImage()..
-        // (Tests shows 20-30ms, vs. 600-700ms on the same image)
-        BufferedImageOp op = new CopyDither(cm);
-        op.filter(temp, image);
-
-        return image;
-    }
-
-    /**
-     * Creates an {@code IndexColorModel} from an array of
-     * {@code PixelPacket}s.
-     *
-     * @param pColormap the original colormap as a {@code PixelPacket} array
-     * @param pAlpha keep alpha channel
-     *
-     * @return a new {@code IndexColorModel}
-     */
-    public static IndexColorModel createIndexColorModel(PixelPacket[] pColormap, boolean pAlpha) {
-        int[] colors = new int[pColormap.length];
-
-        // TODO: Verify if this is correct for alpha...?
-        int trans = pAlpha ? colors.length - 1 : -1;
-
-        //for (int i = 0; i < pColormap.length; i++) {
-        for (int i = pColormap.length - 1; i != 0; i--) {
-            PixelPacket color = pColormap[i];
-            if (pAlpha) {
-                colors[i] = (0xff - (color.getOpacity() & 0xff)) << 24 |
-                            (color.getRed()     & 0xff) << 16 |
-                            (color.getGreen()   & 0xff) <<  8 |
-                            (color.getBlue()    & 0xff);
-            }
-            else {
-                colors[i] = (color.getRed()     & 0xff) << 16 |
-                            (color.getGreen()   & 0xff) <<  8 |
-                            (color.getBlue()    & 0xff);
-            }
-        }
-
-        return new InverseColorMapIndexColorModel(8, colors.length, colors, 0, pAlpha, trans, DataBuffer.TYPE_BYTE);
-    }
-
-    /**
-     * Converts an (A)RGB {@code MagickImage} to a {@code BufferedImage}, of
-     * type {@code TYPE_4BYTE_ABGR} or {@code TYPE_3BYTE_BGR}.
-     *
-     * @param pImage the original {@code MagickImage}
-     * @param pAlpha keep alpha channel
-     * @return a new {@code BufferedImage}
-     *
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    private static BufferedImage rgbToBuffered(MagickImage pImage, boolean pAlpha) throws MagickException {
-        Dimension size = pImage.getDimension();
-        int length = size.width * size.height;
-        int bands = pAlpha ? 4 : 3;
-        byte[] pixels = new byte[length * bands];
-
-        // TODO: If we do multiple dispatches (one per line, typically), we could provide listener
-        //       feedback. But it's currently a lot slower than fetching all the pixels in one go.
-
-        // Note: The ordering ABGR or BGR corresponds to BufferedImage
-        // TYPE_4BYTE_ABGR and TYPE_3BYTE_BGR respectively
-        pImage.dispatchImage(0, 0, size.width, size.height, pAlpha ? "ABGR" : "BGR", pixels);
-
-        // Init databuffer with array, to avoid allocation of empty array
-        DataBuffer buffer = new DataBufferByte(pixels, pixels.length);
-
-        int[] bandOffsets = pAlpha ? BAND_OFF_TRANS : BAND_OFF_OPAQUE;
-
-        WritableRaster raster =
-                Raster.createInterleavedRaster(buffer, size.width, size.height,
-                        size.width * bands, bands, bandOffsets, LOCATION_UPPER_LEFT);
-
-        return new BufferedImage(pAlpha ? CM_COLOR_ALPHA : CM_COLOR_OPAQUE, raster, pAlpha, null);
-    }
-	
-	
-	
-
-    /**
-     * Converts an {@code MagickImage} to a {@code BufferedImage} which holds an CMYK ICC profile
-     *
-     * @param pImage the original {@code MagickImage}
-     * @param pAlpha keep alpha channel
-     * @return a new {@code BufferedImage}
-     *
-     * @throws MagickException if an exception occurs during conversion
-     *
-     * @see BufferedImage
-     */
-    private static BufferedImage cmykToBuffered(MagickImage pImage, boolean pAlpha) throws MagickException {
-		Dimension size = pImage.getDimension();
-		int length = size.width * size.height;
-		
-		// Retreive the ICC profile
-		ICC_Profile profile = ICC_Profile.getInstance(pImage.getColorProfile().getInfo());
-		ColorSpace cs = new ICC_ColorSpace(profile);
-		
-		int bands = cs.getNumComponents() + (pAlpha ? 1 : 0);
-		
-		int[] bits = new int[bands];
-		for (int i = 0; i < bands; i++) {
-			bits[i] = 8;
-		}
-
-        ColorModel cm = pAlpha ?
-                new ComponentColorModel(cs, bits, true, true, Transparency.TRANSLUCENT, DataBuffer.TYPE_BYTE) :
-                new ComponentColorModel(cs, bits, false, false, Transparency.OPAQUE, DataBuffer.TYPE_BYTE);
-
-        byte[] pixels = new byte[length * bands];
-
-		// TODO: If we do multiple dispatches (one per line, typically), we could provide listener
-		//       feedback. But it's currently a lot slower than fetching all the pixels in one go.
-		// TODO: handle more generic cases if profile is not CMYK
-		// TODO: Test "ACMYK"
-		pImage.dispatchImage(0, 0, size.width, size.height, pAlpha ? "ACMYK" : "CMYK", pixels);
-
-        // Init databuffer with array, to avoid allocation of empty array
-        DataBuffer buffer = new DataBufferByte(pixels, pixels.length);
-
-		// TODO: build array from bands variable, here it just works for CMYK
-		// The values has not been tested with an alpha picture actually...
-        int[] bandOffsets = pAlpha ? new int[] {0, 1, 2, 3, 4} : new int[] {0, 1, 2, 3};
-
-        WritableRaster raster =
-                Raster.createInterleavedRaster(buffer, size.width, size.height,
-                        size.width * bands, bands, bandOffsets, LOCATION_UPPER_LEFT);
-		
-        return new BufferedImage(cm, raster, pAlpha, null);
-		
-    }
-}

common/common-image/src/main/java/com/twelvemonkeys/image/SubsamplingFilter.java

@@ -1,79 +1,80 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.image;
-
-import java.awt.image.ReplicateScaleFilter;
-
-/**
- * An {@code ImageFilter} class for subsampling images.
- * <p/>
- * It is meant to be used in conjunction with a {@code FilteredImageSource}
- * object to produce subsampled versions of existing images.
- * 
- * @see java.awt.image.FilteredImageSource
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/SubsamplingFilter.java#1 $
- */
-public class SubsamplingFilter extends ReplicateScaleFilter {
-    private int xSub;
-    private int ySub;
-
-    /**
-     * Creates a {@code SubsamplingFilter}.
-     *
-     * @param pXSub
-     * @param pYSub
-     *
-     * @throws IllegalArgumentException if {@code pXSub} or {@code pYSub} is
-     * less than 1.
-     */
-    public SubsamplingFilter(int pXSub, int pYSub) {
-        super(1, 1); // These are NOT REAL values, but we have to defer setting
-                     // until w/h is available, in setDimensions below
-
-        if (pXSub < 1 || pYSub < 1) {
-            throw new IllegalArgumentException("Subsampling factors must be positive.");
-        }
-
-        xSub = pXSub;
-        ySub = pYSub;
-    }
-
-    /** {@code ImageFilter} implementation, do not invoke. */
-    public void setDimensions(int pWidth, int pHeight) {
-        destWidth = (pWidth + xSub - 1) / xSub;
-        destHeight = (pHeight + ySub - 1) / ySub;
-
-        //System.out.println("Subsampling: " + xSub + "," + ySub + "-> " + destWidth + ", " + destHeight);
-        super.setDimensions(pWidth, pHeight);
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.image;
+
+import java.awt.image.ReplicateScaleFilter;
+
+/**
+ * An {@code ImageFilter} class for subsampling images.
+ * <p>
+ * It is meant to be used in conjunction with a {@code FilteredImageSource}
+ * object to produce subsampled versions of existing images.
+ * </p>
+ * 
+ * @see java.awt.image.FilteredImageSource
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/image/SubsamplingFilter.java#1 $
+ */
+public class SubsamplingFilter extends ReplicateScaleFilter {
+    private int xSub;
+    private int ySub;
+
+    /**
+     * Creates a {@code SubsamplingFilter}.
+     *
+     * @param pXSub
+     * @param pYSub
+     *
+     * @throws IllegalArgumentException if {@code pXSub} or {@code pYSub} is
+     * less than 1.
+     */
+    public SubsamplingFilter(int pXSub, int pYSub) {
+        super(1, 1); // These are NOT REAL values, but we have to defer setting
+                     // until w/h is available, in setDimensions below
+
+        if (pXSub < 1 || pYSub < 1) {
+            throw new IllegalArgumentException("Subsampling factors must be positive.");
+        }
+
+        xSub = pXSub;
+        ySub = pYSub;
+    }
+
+    /** {@code ImageFilter} implementation, do not invoke. */
+    public void setDimensions(int pWidth, int pHeight) {
+        destWidth = (pWidth + xSub - 1) / xSub;
+        destHeight = (pHeight + ySub - 1) / ySub;
+
+        //System.out.println("Subsampling: " + xSub + "," + ySub + "-> " + destWidth + ", " + destHeight);
+        super.setDimensions(pWidth, pHeight);
+    }
+}

common/common-image/src/main/java/com/twelvemonkeys/image/package-info.java

@@ -30,8 +30,9 @@
 
 /**
  * Classes for image manipulation.
- * <p/>
+ * <p>
  * See the class {@link com.twelvemonkeys.image.ImageUtil}.
+ * </p>
  *
  * @version 1.0
  * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>

common/common-image/src/test/java/com/twelvemonkeys/image/AffineTransformOpTest.java

@@ -30,17 +30,24 @@
 
 package com.twelvemonkeys.image;
 
-import org.junit.Test;
+import static java.lang.Math.min;
+import static org.junit.jupiter.api.Assertions.*;
 
-import javax.imageio.ImageTypeSpecifier;
 import java.awt.color.ColorSpace;
 import java.awt.geom.AffineTransform;
 import java.awt.geom.Point2D;
-import java.awt.image.*;
+import java.awt.image.BufferedImage;
+import java.awt.image.BufferedImageOp;
+import java.awt.image.DataBuffer;
+import java.awt.image.ImagingOpException;
+import java.awt.image.Raster;
+import java.awt.image.RasterOp;
 import java.util.Arrays;
 import java.util.List;
 
-import static org.junit.Assert.*;
+import javax.imageio.ImageTypeSpecifier;
+
+import org.junit.jupiter.api.Test;
 
 /**
  * AffineTransformOpTest.
@@ -101,6 +108,7 @@ public class AffineTransformOpTest {
 
     private final int width = 30;
     private final int height = 20;
+    private final double anchor = min(width, height) / 2.0;
 
     @Test
     public void testGetPoint2D() {
@@ -128,33 +136,33 @@ public class AffineTransformOpTest {
 
     @Test
     public void testFilterRotateBIStandard() {
-        BufferedImageOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
-        BufferedImageOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
+        BufferedImageOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
+        BufferedImageOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
 
         for (Integer type : TYPES) {
             BufferedImage image = new BufferedImage(width, height, type);
             BufferedImage jreResult = jreOp.filter(image, null);
             BufferedImage tmResult = tmOp.filter(image, null);
 
-            assertNotNull("No result!", tmResult);
-            assertEquals("Bad type", jreResult.getType(), tmResult.getType());
-            assertEquals("Incorrect color model", jreResult.getColorModel(), tmResult.getColorModel());
+            assertNotNull(tmResult, "No result!");
+            assertEquals(jreResult.getType(), tmResult.getType(), "Bad type");
+            assertEquals(jreResult.getColorModel(), tmResult.getColorModel(), "Incorrect color model");
 
-            assertEquals("Incorrect width", jreResult.getWidth(), tmResult.getWidth());
-            assertEquals("Incorrect height", jreResult.getHeight(), tmResult.getHeight());
+            assertEquals(jreResult.getWidth(), tmResult.getWidth(), "Incorrect width");
+            assertEquals(jreResult.getHeight(), tmResult.getHeight(), "Incorrect height");
         }
     }
 
     @Test
     public void testFilterRotateBICustom() {
-        BufferedImageOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
-        BufferedImageOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
+        BufferedImageOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
+        BufferedImageOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
 
         for (ImageTypeSpecifier spec : SPECS) {
             BufferedImage image = spec.createBufferedImage(width, height);
 
             BufferedImage tmResult = tmOp.filter(image, null);
-            assertNotNull("No result!", tmResult);
+            assertNotNull(tmResult, "No result!");
 
             BufferedImage jreResult = null;
 
@@ -166,18 +174,18 @@ public class AffineTransformOpTest {
             }
 
             if (jreResult != null) {
-                assertEquals("Bad type", jreResult.getType(), tmResult.getType());
-                assertEquals("Incorrect color model", jreResult.getColorModel(), tmResult.getColorModel());
+                assertEquals(jreResult.getType(), tmResult.getType(), "Bad type");
+                assertEquals(jreResult.getColorModel(), tmResult.getColorModel(), "Incorrect color model");
 
-                assertEquals("Incorrect width", jreResult.getWidth(), tmResult.getWidth());
-                assertEquals("Incorrect height", jreResult.getHeight(), tmResult.getHeight());
+                assertEquals(jreResult.getWidth(), tmResult.getWidth(), "Incorrect width");
+                assertEquals(jreResult.getHeight(), tmResult.getHeight(), "Incorrect height");
             }
             else {
-                assertEquals("Bad type", spec.getBufferedImageType(), tmResult.getType());
-                assertEquals("Incorrect color model", spec.getColorModel(), tmResult.getColorModel());
+                assertEquals(spec.getBufferedImageType(), tmResult.getType(), "Bad type");
+                assertEquals(spec.getColorModel(), tmResult.getColorModel(), "Incorrect color model");
 
-                assertEquals("Incorrect width", height, tmResult.getWidth());
-                assertEquals("Incorrect height", width, tmResult.getHeight());
+                assertEquals(height, tmResult.getWidth(), "Incorrect width");
+                assertEquals(width, tmResult.getHeight(), "Incorrect height");
             }
         }
     }
@@ -197,8 +205,8 @@ public class AffineTransformOpTest {
 
     @Test
     public void testFilterRotateRasterStandard() {
-        RasterOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
-        RasterOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
+        RasterOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
+        RasterOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
 
         for (Integer type : TYPES) {
             Raster raster = new BufferedImage(width, height, type).getRaster();
@@ -221,27 +229,25 @@ public class AffineTransformOpTest {
                     fail("No result!");
                 }
                 else {
-                    System.err.println("AffineTransformOpTest.testFilterRotateRasterStandard");
-                    System.err.println("type: " + type);
                     continue;
                 }
             }
 
             if (jreResult != null) {
-                assertEquals("Incorrect width", jreResult.getWidth(), tmResult.getWidth());
-                assertEquals("Incorrect height", jreResult.getHeight(), tmResult.getHeight());
+                assertEquals(jreResult.getWidth(), tmResult.getWidth(), "Incorrect width");
+                assertEquals(jreResult.getHeight(), tmResult.getHeight(), "Incorrect height");
             }
             else {
-                assertEquals("Incorrect width", height, tmResult.getWidth());
-                assertEquals("Incorrect height", width, tmResult.getHeight());
+                assertEquals(height, tmResult.getWidth(), "Incorrect width");
+                assertEquals(width, tmResult.getHeight(), "Incorrect height");
             }
         }
     }
 
     @Test
     public void testFilterRotateRasterCustom() {
-        RasterOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
-        RasterOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, Math.min(width, height) / 2, Math.min(width, height) / 2), null);
+        RasterOp jreOp = new java.awt.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
+        RasterOp tmOp = new com.twelvemonkeys.image.AffineTransformOp(AffineTransform.getQuadrantRotateInstance(1, anchor, anchor), null);
 
         for (ImageTypeSpecifier spec : SPECS) {
             Raster raster = spec.createBufferedImage(width, height).getRaster();
@@ -264,19 +270,17 @@ public class AffineTransformOpTest {
                     fail("No result!");
                 }
                 else {
-                    System.err.println("AffineTransformOpTest.testFilterRotateRasterCustom");
-                    System.err.println("spec: " + spec);
                     continue;
                 }
             }
 
             if (jreResult != null) {
-                assertEquals("Incorrect width", jreResult.getWidth(), tmResult.getWidth());
-                assertEquals("Incorrect height", jreResult.getHeight(), tmResult.getHeight());
+                assertEquals(jreResult.getWidth(), tmResult.getWidth(), "Incorrect width");
+                assertEquals(jreResult.getHeight(), tmResult.getHeight(), "Incorrect height");
             }
             else {
-                assertEquals("Incorrect width", height, tmResult.getWidth());
-                assertEquals("Incorrect height", width, tmResult.getHeight());
+                assertEquals(height, tmResult.getWidth(), "Incorrect width");
+                assertEquals(width, tmResult.getHeight(), "Incorrect height");
             }
         }
     }

common/common-image/src/test/java/com/twelvemonkeys/image/BufferedImageFactoryTest.java

@@ -30,18 +30,16 @@
 
 package com.twelvemonkeys.image;
 
-import org.junit.Ignore;
-import org.junit.Test;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
 
 import java.awt.*;
-import java.awt.color.ColorSpace;
-import java.awt.image.BufferedImage;
-import java.awt.image.ColorModel;
-import java.awt.image.ImageProducer;
-import java.awt.image.IndexColorModel;
+import java.awt.color.*;
+import java.awt.image.*;
 import java.net.URL;
+import java.time.Duration;
 
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * BufferedImageFactoryTestCase
@@ -51,50 +49,58 @@ import static org.junit.Assert.*;
  * @version $Id: BufferedImageFactoryTestCase.java,v 1.0 May 7, 2010 12:40:08 PM haraldk Exp$
  */
 public class BufferedImageFactoryTest {
-    @Test(expected = IllegalArgumentException.class)
+    @Test
     public void testCreateNullImage() {
-        new BufferedImageFactory((Image) null);
+        assertThrows(IllegalArgumentException.class, () -> {
+            new BufferedImageFactory((Image) null);
+        });
     }
 
-    @Test(expected = IllegalArgumentException.class)
+    @Test
     public void testCreateNullProducer() {
-        new BufferedImageFactory((ImageProducer) null);
+        assertThrows(IllegalArgumentException.class, () -> {
+            new BufferedImageFactory((ImageProducer) null);
+        });
     }
 
     // NPE in Toolkit, ok
-    @Test(expected = RuntimeException.class)
+    @Test
     public void testGetBufferedImageErrorSourceByteArray() {
-        Image source = Toolkit.getDefaultToolkit().createImage((byte[]) null);
-
-        new BufferedImageFactory(source);
+        assertThrows(RuntimeException.class, () -> {
+            Image source = Toolkit.getDefaultToolkit().createImage((byte[]) null);
+            new BufferedImageFactory(source);
+        });
     }
 
-    @Test(expected = IllegalArgumentException.class)
+    @Test
     public void testGetBufferedImageErrorSourceImageProducer() {
         Image source = Toolkit.getDefaultToolkit().createImage((ImageProducer) null);
-
-        new BufferedImageFactory(source);
+        assertThrows(IllegalArgumentException.class, () -> {
+            new BufferedImageFactory(source);
+        });
     }
 
     // TODO: This is a quite serious bug, however, the bug is in the Toolkit, allowing such images in the first place...
     // In any case, there's not much we can do, except until someone is bored and kills the app/thread... :-P
-    @Ignore("Bug in Toolkit")
-    @Test(timeout = 1000, expected = ImageConversionException.class)
+    @Disabled("Bug in Toolkit")
+    @Test
     public void testGetBufferedImageErrorSourceString() {
-        Image source = Toolkit.getDefaultToolkit().createImage((String) null);
-
-        BufferedImageFactory factory = new BufferedImageFactory(source);
-        factory.getBufferedImage();
+        assertTimeoutPreemptively(Duration.ofMillis(1000), () -> {
+            Image source = Toolkit.getDefaultToolkit().createImage((String) null);
+            BufferedImageFactory factory = new BufferedImageFactory(source);
+            assertThrows(ImageConversionException.class, factory::getBufferedImage);
+        });
     }
 
     // This is a little random, and it would be nicer if we could throw an IllegalArgumentException on create.
     // Unfortunately, the API doesn't allow this...
-    @Test(timeout = 1000, expected = ImageConversionException.class)
+    @Test
     public void testGetBufferedImageErrorSourceURL() {
-        Image source = Toolkit.getDefaultToolkit().createImage(getClass().getResource("/META-INF/MANIFEST.MF"));
-
-        BufferedImageFactory factory = new BufferedImageFactory(source);
-        factory.getBufferedImage();
+        assertTimeoutPreemptively(Duration.ofMillis(1000), () -> {
+            Image source = Toolkit.getDefaultToolkit().createImage((String) null);
+            BufferedImageFactory factory = new BufferedImageFactory(source);
+            assertThrows(ImageConversionException.class, factory::getBufferedImage);
+        });
     }
 
     @Test
@@ -166,7 +172,7 @@ public class BufferedImageFactoryTest {
 
         assertEquals(3, colorModel.getNumColorComponents());
         assertEquals(ColorSpace.getInstance(ColorSpace.CS_sRGB), colorModel.getColorSpace());
-        assertTrue(colorModel instanceof IndexColorModel);
+        assertInstanceOf(IndexColorModel.class, colorModel);
 
         assertTrue(colorModel.hasAlpha());
         assertEquals(4, colorModel.getNumComponents());
@@ -197,7 +203,7 @@ public class BufferedImageFactoryTest {
 
         for (int y = 0; y < image.getHeight(); y++) {
             for (int x = 0; x < image.getWidth(); x++) {
-                assertEquals("RGB[" + x + ", " + y + "]", original.getRGB(x * 2, y * 2), image.getRGB(x, y));
+                assertEquals(original.getRGB(x * 2, y * 2), image.getRGB(x, y), "RGB[" + x + ", " + y + "]");
             }
         }
     }
@@ -220,7 +226,7 @@ public class BufferedImageFactoryTest {
 
         for (int y = 0; y < image.getHeight(); y++) {
             for (int x = 0; x < image.getWidth(); x++) {
-                assertEquals("RGB[" + x + ", " + y + "]", original.getRGB(40 + x, 40 + y), image.getRGB(x, y));
+                assertEquals(original.getRGB(40 + x, 40 + y), image.getRGB(x, y), "RGB[" + x + ", " + y + "]");
             }
         }
     }
@@ -244,7 +250,7 @@ public class BufferedImageFactoryTest {
 
         for (int y = 0; y < image.getHeight(); y++) {
             for (int x = 0; x < image.getWidth(); x++) {
-                assertEquals("RGB[" + x + ", " + y + "]", original.getRGB(40 + x * 2, 40 + y * 2), image.getRGB(x, y));
+                assertEquals(original.getRGB(40 + x * 2, 40 + y * 2), image.getRGB(x, y), "RGB[" + x + ", " + y + "]");
             }
         }
     }
@@ -260,9 +266,9 @@ public class BufferedImageFactoryTest {
 
         // Listener should abort ASAP
         factory.addProgressListener(new BufferedImageFactory.ProgressListener() {
-            public void progress(BufferedImageFactory pFactory, float pPercentage) {
-                if (pPercentage > 5) {
-                    pFactory.abort();
+            public void progress(BufferedImageFactory factory, float percentage) {
+                if (percentage > 5) {
+                    factory.abort();
                 }
             }
         });
@@ -343,7 +349,7 @@ public class BufferedImageFactoryTest {
         VerifyingListener listener = new VerifyingListener(factory);
         factory.addProgressListener(listener);
         factory.removeProgressListener(new BufferedImageFactory.ProgressListener() {
-            public void progress(BufferedImageFactory pFactory, float pPercentage) {
+            public void progress(BufferedImageFactory factory, float percentage) {
             }
         });
         factory.getBufferedImage();
@@ -380,11 +386,11 @@ public class BufferedImageFactoryTest {
             this.factory = factory;
         }
 
-        public void progress(BufferedImageFactory pFactory, float pPercentage) {
-            assertEquals(factory, pFactory);
-            assertTrue(pPercentage >= progress && pPercentage <= 100f);
+        public void progress(BufferedImageFactory factory, float percentage) {
+            assertEquals(this.factory, factory);
+            assertTrue(percentage >= progress && percentage <= 100f);
 
-            progress = pPercentage;
+            progress = percentage;
         }
 
 

common/common-image/src/test/java/com/twelvemonkeys/image/ImageUtilTest.java

@@ -30,7 +30,7 @@
 
 package com.twelvemonkeys.image;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import javax.imageio.ImageIO;
 import java.awt.*;
@@ -39,7 +39,7 @@ import java.awt.image.IndexColorModel;
 import java.awt.image.RenderedImage;
 import java.io.InputStream;
 
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 public class ImageUtilTest {
 
@@ -116,8 +116,8 @@ public class ImageUtilTest {
     public void testImageIsNotBufferedImage() {
         // Should not be a buffered image
         assertFalse(
-                "FOR SOME IMPLEMENTATIONS THIS MIGHT FAIL!\nIn that case, testToBufferedImage() will fail too.",
-                scaled instanceof BufferedImage
+                scaled instanceof BufferedImage,
+                "FOR SOME IMPLEMENTATIONS THIS MIGHT FAIL!\nIn that case, testToBufferedImage() will fail too."
         );
     }
 
@@ -247,7 +247,7 @@ public class ImageUtilTest {
         if (original != notContrasted) { // Don't care to test if images are same
             for (int y = 0; y < original.getHeight(); y++) {
                 for (int x = 0; x < original.getWidth(); x++) {
-                    assertEquals("0 constrast should not change image", original.getRGB(x, y), notContrasted.getRGB(x, y));
+                    assertEquals(original.getRGB(x, y), notContrasted.getRGB(x, y), "0 constrast should not change image");
                 }
             }
         }
@@ -275,24 +275,24 @@ public class ImageUtilTest {
 
                 // RED
                 if (oR < 127) {
-                    assertTrue("Contrast should be decreased or same", oR >= cR && cR >= dR);
+                    assertTrue(oR >= cR && cR >= dR, "Contrast should be decreased or same");
                 }
                 else {
-                    assertTrue("Contrast should be increased or same", oR <= cR && cR <= dR);
+                    assertTrue(oR <= cR && cR <= dR, "Contrast should be increased or same");
                 }
                 // GREEN
                 if (oG < 127) {
-                    assertTrue("Contrast should be decreased or same", oG >= cG && cG >= dG);
+                    assertTrue(oG >= cG && cG >= dG, "Contrast should be decreased or same");
                 }
                 else {
-                    assertTrue("Contrast should be increased or same", oG <= cG && cG <= dG);
+                    assertTrue(oG <= cG && cG <= dG, "Contrast should be increased or same");
                 }
                 // BLUE
                 if (oB < 127) {
-                    assertTrue("Contrast should be decreased or same", oB >= cB && cB >= dB);
+                    assertTrue(oB >= cB && cB >= dB, "Contrast should be decreased or same");
                 }
                 else {
-                    assertTrue("Contrast should be increased or same", oB <= cB && cB <= dB);
+                    assertTrue(oB <= cB && cB <= dB, "Contrast should be increased or same");
                 }
             }
         }
@@ -304,9 +304,9 @@ public class ImageUtilTest {
                 int r = rgb >> 16 & 0xFF;
                 int g = rgb >> 8 & 0xFF;
                 int b = rgb & 0xFF;
-                assertTrue("Max contrast should only produce primary colors", r == 0 || r == 255);
-                assertTrue("Max contrast should only produce primary colors", g == 0 || g == 255);
-                assertTrue("Max contrast should only produce primary colors", b == 0 || b == 255);
+                assertTrue(r == 0 || r == 255, "Max contrast should only produce primary colors");
+                assertTrue(g == 0 || g == 255, "Max contrast should only produce primary colors");
+                assertTrue(b == 0 || b == 255, "Max contrast should only produce primary colors");
             }
         }
 
@@ -327,24 +327,24 @@ public class ImageUtilTest {
 
                 // RED
                 if (oR >= 127) {
-                    assertTrue("Contrast should be decreased or same", oR >= cR);
+                    assertTrue(oR >= cR, "Contrast should be decreased or same");
                 }
                 else {
-                    assertTrue("Contrast should be increased or same", oR <= cR);
+                    assertTrue(oR <= cR, "Contrast should be increased or same");
                 }
                 // GREEN
                 if (oG >= 127) {
-                    assertTrue("Contrast should be decreased or same", oG >= cG);
+                    assertTrue(oG >= cG, "Contrast should be decreased or same");
                 }
                 else {
-                    assertTrue("Contrast should be increased or same", oG <= cG);
+                    assertTrue(oG <= cG, "Contrast should be increased or same");
                 }
                 // BLUE
                 if (oB >= 127) {
-                    assertTrue("Contrast should be decreased or same", oB >= cB);
+                    assertTrue(oB >= cB, "Contrast should be decreased or same");
                 }
                 else {
-                    assertTrue("Contrast should be increased or same", oB <= cB);
+                    assertTrue(oB <= cB, "Contrast should be increased or same");
                 }
             }
         }
@@ -357,7 +357,7 @@ public class ImageUtilTest {
                 int r = rgb >> 16 & 0xFF;
                 int g = rgb >> 8 & 0xFF;
                 int b = rgb & 0xFF;
-                assertTrue("Minimum contrast should be all gray", r == 127 && g == 127 && b == 127);
+                assertTrue(r == 127 && g == 127 && b == 127, "Minimum contrast should be all gray");
             }
         }
 
@@ -400,7 +400,7 @@ public class ImageUtilTest {
         if (original != notSharpened) { // Don't care to test if images are same
             for (int y = 0; y < original.getHeight(); y++) {
                 for (int x = 0; x < original.getWidth(); x++) {
-                    assertEquals("0 sharpen should not change image", original.getRGB(x, y), notSharpened.getRGB(x, y));
+                    assertEquals(original.getRGB(x, y), notSharpened.getRGB(x, y), "0 sharpen should not change image");
                 }
             }
         }
@@ -446,13 +446,13 @@ public class ImageUtilTest {
         }
 
 //        assertEquals("Difference should not change", diffOriginal, diffSharpened);
-        assertTrue("Abs difference should increase", absDiffOriginal < absDiffSharpened);
+        assertTrue(absDiffOriginal < absDiffSharpened, "Abs difference should increase");
 //        assertEquals("Difference should not change", diffOriginal, diffDefault);
-        assertTrue("Abs difference should increase", absDiffOriginal < absDiffDefault);
+        assertTrue(absDiffOriginal < absDiffDefault, "Abs difference should increase");
 //        assertEquals("Difference should not change", diffOriginal, diffMore);
-        assertTrue("Abs difference should increase", absDiffOriginal < absDiffMore);
+        assertTrue(absDiffOriginal < absDiffMore, "Abs difference should increase");
 //        assertEquals("Difference should not change", diffSharpened, diffMore);
-        assertTrue("Abs difference should increase", absDiffSharpened < absDiffMore);
+        assertTrue(absDiffSharpened < absDiffMore, "Abs difference should increase");
     }
 
     @Test
@@ -466,7 +466,7 @@ public class ImageUtilTest {
         if (original != notBlurred) { // Don't care to test if images are same
             for (int y = 0; y < original.getHeight(); y++) {
                 for (int x = 0; x < original.getWidth(); x++) {
-                    assertEquals("0 blur should not change image", original.getRGB(x, y), notBlurred.getRGB(x, y));
+                    assertEquals(original.getRGB(x, y), notBlurred.getRGB(x, y), "0 blur should not change image");
                 }
             }
         }
@@ -512,13 +512,13 @@ public class ImageUtilTest {
         }
 
 //        assertEquals("Difference should not change", diffOriginal, diffBlurred);
-        assertTrue(String.format("Abs difference should decrease: %s <= %s", absDiffOriginal, absDiffBlurred), absDiffOriginal > absDiffBlurred);
+        assertTrue(absDiffOriginal > absDiffBlurred, String.format("Abs difference should decrease: %s <= %s", absDiffOriginal, absDiffBlurred));
 //        assertEquals("Difference should not change", diffOriginal, diffDefault);
-        assertTrue("Abs difference should decrease", absDiffOriginal > absDiffDefault);
+        assertTrue(absDiffOriginal > absDiffDefault, "Abs difference should decrease");
 //        assertEquals("Difference should not change", diffOriginal, diffMore);
-        assertTrue("Abs difference should decrease", absDiffOriginal > absDiffMore);
+        assertTrue(absDiffOriginal > absDiffMore, "Abs difference should decrease");
 //        assertEquals("Difference should not change", diffBlurred, diffMore);
-        assertTrue("Abs difference should decrease", absDiffBlurred > absDiffMore);
+        assertTrue(absDiffBlurred > absDiffMore, "Abs difference should decrease");
     }
 
     @Test
@@ -528,7 +528,7 @@ public class ImageUtilTest {
         assertNotNull(sunflower);
 
         BufferedImage image = ImageUtil.createIndexed(sunflower);
-        assertNotNull("Image was null", image);
-        assertTrue(image.getColorModel() instanceof IndexColorModel);
+        assertNotNull(image, "Image was null");
+        assertInstanceOf(IndexColorModel.class, image.getColorModel());
     }
 }

common/common-image/src/test/java/com/twelvemonkeys/image/ResampleOpTest.java

@@ -30,8 +30,8 @@
 
 package com.twelvemonkeys.image;
 
-import org.junit.Ignore;
-import org.junit.Test;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
 
 import java.awt.*;
 import java.awt.image.BufferedImage;
@@ -40,7 +40,7 @@ import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 
-import static org.junit.Assert.*;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * ResampleOpTestCase
@@ -124,7 +124,7 @@ public class ResampleOpTest {
             }
         }
 
-        assertEquals("Filter threw exceptions: ", Collections.EMPTY_LIST, exceptions);
+        assertEquals(Collections.EMPTY_LIST, exceptions, "Filter threw exceptions: ");
     }
 
     // 1x1
@@ -358,7 +358,7 @@ public class ResampleOpTest {
         }
     }
 
-    @Ignore("Not for general unit testing")
+    @Disabled("Not for general unit testing")
     @Test
     public void testTime() {
         int iterations = 1000;

common/common-image/todo.txt

@@ -1,6 +0,0 @@
-TODO:
-    Remove compile-time dependency on JMagick:
-        - Extract interface for MagickAccelerator
-        - Move implementation to separate module
-        - Instantiate impl via reflection
-DONE:

common/common-io/pom.xml

@@ -4,15 +4,19 @@
     <parent>
         <groupId>com.twelvemonkeys.common</groupId>
         <artifactId>common</artifactId>
-        <version>3.4</version>
+        <version>3.13.2-SNAPSHOT</version>
     </parent>
     <artifactId>common-io</artifactId>
     <packaging>jar</packaging>
     <name>TwelveMonkeys :: Common :: IO</name>
     <description>
-        The TwelveMonkeys Common IO support
+        TwelveMonkeys Common I/O support classes.
     </description>
 
+    <properties>
+        <project.jpms.module.name>com.twelvemonkeys.common.io</project.jpms.module.name>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>${project.groupId}</groupId>
@@ -27,4 +31,12 @@
         </dependency>
     </dependencies>
 
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
 </project>

common/common-io/src/main/java/com/twelvemonkeys/io/AbstractCachedSeekableStream.java

@@ -186,7 +186,7 @@ abstract class AbstractCachedSeekableStream extends SeekableInputStream {
     }
 
     protected void closeImpl() throws IOException {
-        cache.flush(position);
+        cache.close();
         cache = null;
         stream.close();
     }
@@ -198,12 +198,12 @@ abstract class AbstractCachedSeekableStream extends SeekableInputStream {
      * @author last modified by $Author: haku $
      * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/AbstractCachedSeekableStream.java#2 $
      */
-    public static abstract class StreamCache {
+    static abstract class StreamCache {
 
         /**
          * Creates a {@code StreamCache}.
          */
-        protected StreamCache() {
+        StreamCache() {
         }
 
         /**
@@ -218,9 +218,10 @@ abstract class AbstractCachedSeekableStream extends SeekableInputStream {
         /**
          * Writes a series of bytes at the current read/write position. The read/write position will be increased by
          * {@code pLength}.
-         * <p/>
+         * <p>
          * This implementation invokes {@link #write(int)} {@code pLength} times.
          * Subclasses may override this method for performance.
+         * </p>
          *
          * @param pBuffer the bytes to write.
          * @param pOffset the starting offset into the buffer.
@@ -246,9 +247,10 @@ abstract class AbstractCachedSeekableStream extends SeekableInputStream {
         /**
          * Writes a series of bytes at the current read/write position. The read/write position will be increased by
          * {@code pLength}.
-         * <p/>
+         * <p>
          * This implementation invokes {@link #read()} {@code pLength} times.
          * Subclasses may override this method for performance.
+         * </p>
          *
          * @param pBuffer the bytes to write
          * @param pOffset the starting offset into the buffer.
@@ -283,12 +285,14 @@ abstract class AbstractCachedSeekableStream extends SeekableInputStream {
 
         /**
          * Optionally flushes any data prior to the given position.
-         * <p/>
+         * <p>
          * Attempting to perform a seek operation, and/or a read or write operation to a position equal to or before
          * the flushed position may result in exceptions or undefined behaviour.
-         * <p/>
+         * </p>
+         * <p>
          * Subclasses should override this method for performance reasons, to avoid holding on to unnecessary resources.
          * This implementation does nothing.
+         * </p>
          *
          * @param pPosition the last position to flush.
          */
@@ -303,5 +307,7 @@ abstract class AbstractCachedSeekableStream extends SeekableInputStream {
          * @throws IOException if the position can't be determined because of a problem in the cache backing mechanism.
          */
         abstract long getPosition() throws IOException;
+
+        abstract void close() throws IOException;
     }
 }

common/common-io/src/main/java/com/twelvemonkeys/io/CompoundReader.java

@@ -1,222 +1,221 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.Validate;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.util.ArrayList;
-import java.util.Iterator;
-import java.util.List;
-
-/**
- * A Reader implementation that can read from multiple sources.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/CompoundReader.java#2 $
- */
-public class CompoundReader extends Reader {
-
-    private Reader current;
-    private List<Reader> readers;
-
-    protected final Object finalLock;
-
-    protected final boolean markSupported;
-
-    private int currentReader;
-    private int markedReader;
-    private int mark;
-    private int mNext;
-
-    /**
-     * Create a new compound reader.
-     *
-     * @param pReaders {@code Iterator} containting {@code Reader}s,
-     *        providing the character stream.
-     *
-     * @throws NullPointerException if {@code pReaders} is {@code null}, or
-     *         any of the elements in the iterator is {@code null}.
-     * @throws ClassCastException if any element of the iterator is not a
-     *         {@code java.io.Reader}
-     */
-    public CompoundReader(final Iterator<Reader> pReaders) {
-        super(Validate.notNull(pReaders, "readers"));
-
-        finalLock = pReaders; // NOTE: It's ok to sync on pReaders, as the
-                          // reference can't change, only it's elements
-
-        readers = new ArrayList<Reader>();
-
-        boolean markSupported = true;
-        while (pReaders.hasNext()) {
-            Reader reader = pReaders.next();
-            if (reader == null) {
-                throw new NullPointerException("readers cannot contain null-elements");
-            }
-            readers.add(reader);
-            markSupported = markSupported && reader.markSupported();
-        }
-        this.markSupported = markSupported;
-
-        current = nextReader();
-    }
-
-    protected final Reader nextReader() {
-        if (currentReader >= readers.size()) {
-            current = new EmptyReader();
-        }
-        else {
-            current = readers.get(currentReader++);
-        }
-        
-        // NOTE: Reset mNext for every reader, and record marked reader in mark/reset methods!
-        mNext = 0;
-        return current;
-    }
-
-    /**
-     * Check to make sure that the stream has not been closed
-     *
-     * @throws IOException if the stream is closed
-     */
-    protected final void ensureOpen() throws IOException {
-        if (readers == null) {
-            throw new IOException("Stream closed");
-        }
-    }
-
-    public void close() throws IOException {
-        // Close all readers
-        for (Reader reader : readers) {
-            reader.close();
-        }
-
-        readers = null;
-    }
-
-    @Override
-    public void mark(int pReadLimit) throws IOException {
-        if (pReadLimit < 0) {
-            throw new IllegalArgumentException("Read limit < 0");
-        }
-
-        // TODO: It would be nice if we could actually close some readers now
-
-        synchronized (finalLock) {
-            ensureOpen();
-            mark = mNext;
-            markedReader = currentReader;
-
-            current.mark(pReadLimit);
-        }
-    }
-
-    @Override
-    public void reset() throws IOException {
-        synchronized (finalLock) {
-            ensureOpen();
-
-            if (currentReader != markedReader) {
-                // Reset any reader before this
-                for (int i = currentReader; i >= markedReader; i--) {
-                    readers.get(i).reset();
-                }
-
-                currentReader = markedReader - 1;
-                nextReader();
-            }
-            current.reset();
-
-            mNext = mark;
-        }
-    }
-
-    @Override
-    public boolean markSupported() {
-        return markSupported;
-    }
-
-    @Override
-    public int read() throws IOException {
-        synchronized (finalLock) {
-            int read = current.read();
-
-            if (read < 0 && currentReader < readers.size()) {
-                nextReader();
-                return read(); // In case of 0-length readers
-            }
-
-            mNext++;
-
-            return read;
-        }
-    }
-
-    public int read(char pBuffer[], int pOffset, int pLength) throws IOException {
-        synchronized (finalLock) {
-            int read = current.read(pBuffer, pOffset, pLength);
-
-            if (read < 0 && currentReader < readers.size()) {
-                nextReader();
-                return read(pBuffer, pOffset, pLength); // In case of 0-length readers
-            }
-
-            mNext += read;
-
-            return read;
-        }
-    }
-
-    @Override
-    public boolean ready() throws IOException {
-        return current.ready();
-    }
-
-    @Override
-    public long skip(long pChars) throws IOException {
-        synchronized (finalLock) {
-            long skipped = current.skip(pChars);
-
-            if (skipped == 0 && currentReader < readers.size()) {
-                nextReader();
-                return skip(pChars); // In case of 0-length readers
-            }
-
-            mNext += skipped;
-
-            return skipped;
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.Validate;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+
+/**
+ * A Reader implementation that can read from multiple sources.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/CompoundReader.java#2 $
+ */
+public class CompoundReader extends Reader {
+
+    private Reader current;
+    private List<Reader> readers;
+
+    protected final Object finalLock;
+
+    protected final boolean markSupported;
+
+    private int currentReader;
+    private int markedReader;
+    private long mark;
+    private long next;
+
+    /**
+     * Create a new compound reader.
+     *
+     * @param pReaders {@code Iterator} containting {@code Reader}s,
+     *        providing the character stream.
+     *
+     * @throws NullPointerException if {@code pReaders} is {@code null}, or
+     *         any of the elements in the iterator is {@code null}.
+     * @throws ClassCastException if any element of the iterator is not a
+     *         {@code java.io.Reader}
+     */
+    public CompoundReader(final Iterator<Reader> pReaders) {
+        super(Validate.notNull(pReaders, "readers"));
+
+        finalLock = pReaders; // NOTE: It's ok to sync on pReaders, as the
+                          // reference can't change, only it's elements
+
+        readers = new ArrayList<>();
+
+        boolean markSupported = true;
+        while (pReaders.hasNext()) {
+            Reader reader = pReaders.next();
+            if (reader == null) {
+                throw new NullPointerException("readers cannot contain null-elements");
+            }
+            readers.add(reader);
+            markSupported = markSupported && reader.markSupported();
+        }
+        this.markSupported = markSupported;
+
+        current = nextReader();
+    }
+
+    protected final Reader nextReader() {
+        if (currentReader >= readers.size()) {
+            current = new EmptyReader();
+        }
+        else {
+            current = readers.get(currentReader++);
+        }
+        
+        // NOTE: Reset mNext for every reader, and record marked reader in mark/reset methods!
+        next = 0;
+        return current;
+    }
+
+    /**
+     * Check to make sure that the stream has not been closed
+     *
+     * @throws IOException if the stream is closed
+     */
+    protected final void ensureOpen() throws IOException {
+        if (readers == null) {
+            throw new IOException("Stream closed");
+        }
+    }
+
+    public void close() throws IOException {
+        // Close all readers
+        for (Reader reader : readers) {
+            reader.close();
+        }
+
+        readers = null;
+    }
+
+    @Override
+    public void mark(int pReadLimit) throws IOException {
+        if (pReadLimit < 0) {
+            throw new IllegalArgumentException("Read limit < 0");
+        }
+
+        // TODO: It would be nice if we could actually close some readers now
+
+        synchronized (finalLock) {
+            ensureOpen();
+            mark = next;
+            markedReader = currentReader;
+
+            current.mark(pReadLimit);
+        }
+    }
+
+    @Override
+    public void reset() throws IOException {
+        synchronized (finalLock) {
+            ensureOpen();
+
+            if (currentReader != markedReader) {
+                // Reset any reader before this
+                for (int i = currentReader; i >= markedReader; i--) {
+                    readers.get(i).reset();
+                }
+
+                currentReader = markedReader - 1;
+                nextReader();
+            }
+            current.reset();
+
+            next = mark;
+        }
+    }
+
+    @Override
+    public boolean markSupported() {
+        return markSupported;
+    }
+
+    @Override
+    public int read() throws IOException {
+        synchronized (finalLock) {
+            int read = current.read();
+
+            if (read < 0 && currentReader < readers.size()) {
+                nextReader();
+                return read(); // In case of 0-length readers
+            }
+
+            next++;
+
+            return read;
+        }
+    }
+
+    public int read(char[] pBuffer, int pOffset, int pLength) throws IOException {
+        synchronized (finalLock) {
+            int read = current.read(pBuffer, pOffset, pLength);
+
+            if (read < 0 && currentReader < readers.size()) {
+                nextReader();
+                return read(pBuffer, pOffset, pLength); // In case of 0-length readers
+            }
+
+            next += read;
+
+            return read;
+        }
+    }
+
+    @Override
+    public boolean ready() throws IOException {
+        return current.ready();
+    }
+
+    @Override
+    public long skip(long pChars) throws IOException {
+        synchronized (finalLock) {
+            long skipped = current.skip(pChars);
+
+            if (skipped == 0 && currentReader < readers.size()) {
+                nextReader();
+                return skip(pChars); // In case of 0-length readers
+            }
+
+            next += skipped;
+
+            return skipped;
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/EmptyReader.java

@@ -1,47 +1,46 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.StringReader;
-
-/**
- * EmptyReader
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/EmptyReader.java#1 $
- */
-final class EmptyReader extends StringReader {
-    public EmptyReader() {
-        super("");
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.StringReader;
+
+/**
+ * EmptyReader
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/EmptyReader.java#1 $
+ */
+final class EmptyReader extends StringReader {
+    public EmptyReader() {
+        super("");
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/FastByteArrayOutputStream.java

@@ -1,136 +1,130 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.io.OutputStream;
-
-/**
- * An unsynchronized {@code ByteArrayOutputStream} implementation. This version
- * also has a constructor that lets you create a stream with initial content.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: FastByteArrayOutputStream.java#2 $
- */
-// TODO: Performance test of a stream impl that uses list of fixed size blocks, rather than contiguous block 
-public final class FastByteArrayOutputStream extends ByteArrayOutputStream {
-    /** Max grow size (unless if writing more than this amount of bytes) */
-    protected int maxGrowSize = 1024 * 1024; // 1 MB
-
-    /**
-     * Creates a {@code ByteArrayOutputStream} with the given initial buffer
-     * size.
-     *
-     * @param pSize initial buffer size
-     */
-    public FastByteArrayOutputStream(int pSize) {
-        super(pSize);
-    }
-
-    /**
-     * Creates a {@code ByteArrayOutputStream} with the given initial content.
-     * <p/>
-     * Note that the buffer is not cloned, for maximum performance.
-     *
-     * @param pBuffer initial buffer
-     */
-    public FastByteArrayOutputStream(byte[] pBuffer) {
-        super(0); // Don't allocate array
-        buf = pBuffer;
-        count = pBuffer.length;
-    }
-
-    @Override
-    public void write(byte pBytes[], int pOffset, int pLength) {
-        if ((pOffset < 0) || (pOffset > pBytes.length) || (pLength < 0) ||
-                ((pOffset + pLength) > pBytes.length) || ((pOffset + pLength) < 0)) {
-            throw new IndexOutOfBoundsException();
-        }
-        else if (pLength == 0) {
-            return;
-        }
-
-        int newCount = count + pLength;
-        growIfNeeded(newCount);
-        System.arraycopy(pBytes, pOffset, buf, count, pLength);
-        count = newCount;
-    }
-
-    @Override
-    public void write(int pByte) {
-        int newCount = count + 1;
-        growIfNeeded(newCount);
-        buf[count] = (byte) pByte;
-        count = newCount;
-    }
-
-    private void growIfNeeded(int pNewCount) {
-        if (pNewCount > buf.length) {
-            int newSize = Math.max(Math.min(buf.length << 1, buf.length + maxGrowSize), pNewCount);
-            byte newBuf[] = new byte[newSize];
-            System.arraycopy(buf, 0, newBuf, 0, count);
-            buf = newBuf;
-        }
-    }
-
-    // Non-synchronized version of writeTo
-    @Override
-    public void writeTo(OutputStream pOut) throws IOException {
-        pOut.write(buf, 0, count);
-    }
-
-    // Non-synchronized version of toByteArray
-    @Override
-    public byte[] toByteArray() {
-        byte newBuf[] = new byte[count];
-        System.arraycopy(buf, 0, newBuf, 0, count);
-
-        return newBuf;
-    }
-
-    /**
-     * Creates a {@code ByteArrayInputStream} that reads directly from this
-     * {@code FastByteArrayOutputStream}'s byte buffer.
-     * The buffer is not cloned, for maximum performance.
-     * <p/>
-     * Note that care needs to be taken to avoid writes to
-     * this output stream after the input stream is created.
-     * Failing to do so, may result in unpredictable behaviour.
-     *
-     * @return a new {@code ByteArrayInputStream}, reading from this stream's buffer.
-     */
-    public ByteArrayInputStream createInputStream() {
-        return new ByteArrayInputStream(buf, 0, count);
-    }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Arrays;
+
+/**
+ * An unsynchronized {@code ByteArrayOutputStream} implementation. This version
+ * also has a constructor that lets you create a stream with initial content.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: FastByteArrayOutputStream.java#2 $
+ */
+// TODO: Performance test of a stream impl that uses list of fixed size blocks, rather than contiguous block
+public final class FastByteArrayOutputStream extends ByteArrayOutputStream {
+    /**
+     * Creates a {@code ByteArrayOutputStream} with the given initial buffer
+     * size.
+     *
+     * @param pSize initial buffer size
+     */
+    public FastByteArrayOutputStream(int pSize) {
+        super(pSize);
+    }
+
+    /**
+     * Creates a {@code ByteArrayOutputStream} with the given initial content.
+     * <p>
+     * Note that the buffer is not cloned, for maximum performance.
+     * </p>
+     *
+     * @param pBuffer initial buffer
+     */
+    public FastByteArrayOutputStream(byte[] pBuffer) {
+        super(0); // Don't allocate array
+        buf = pBuffer;
+        count = pBuffer.length;
+    }
+
+    @Override
+    public void write(byte[] pBytes, int pOffset, int pLength) {
+        if ((pOffset < 0) || (pOffset > pBytes.length) || (pLength < 0) ||
+                ((pOffset + pLength) > pBytes.length) || ((pOffset + pLength) < 0)) {
+            throw new IndexOutOfBoundsException();
+        }
+        else if (pLength == 0) {
+            return;
+        }
+
+        int newCount = count + pLength;
+        growIfNeeded(newCount);
+        System.arraycopy(pBytes, pOffset, buf, count, pLength);
+        count = newCount;
+    }
+
+    @Override
+    public void write(int pByte) {
+        int newCount = count + 1;
+        growIfNeeded(newCount);
+        buf[count] = (byte) pByte;
+        count = newCount;
+    }
+
+    private void growIfNeeded(int pNewCount) {
+        if (pNewCount > buf.length) {
+            int newSize = Math.max(buf.length << 1, pNewCount);
+            buf = Arrays.copyOf(buf, newSize);
+        }
+    }
+
+    // Non-synchronized version of writeTo
+    @Override
+    public void writeTo(OutputStream pOut) throws IOException {
+        pOut.write(buf, 0, count);
+    }
+
+    // Non-synchronized version of toByteArray
+    @Override
+    public byte[] toByteArray() {
+        return Arrays.copyOf(buf, count);
+    }
+
+    /**
+     * Creates a {@code ByteArrayInputStream} that reads directly from this
+     * {@code FastByteArrayOutputStream}'s byte buffer.
+     * The buffer is not cloned, for maximum performance.
+     * <p>
+     * Note that care needs to be taken to avoid writes to
+     * this output stream after the input stream is created.
+     * Failing to do so, may result in unpredictable behaviour.
+     * </p>
+     *
+     * @return a new {@code ByteArrayInputStream}, reading from this stream's buffer.
+     */
+    public ByteArrayInputStream createInputStream() {
+        return new ByteArrayInputStream(buf, 0, count);
+    }
 }

common/common-io/src/main/java/com/twelvemonkeys/io/FileCacheSeekableStream.java

@@ -1,232 +1,241 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.Validate;
-
-import java.io.*;
-
-/**
- * A {@code SeekableInputStream} implementation that caches data in a temporary {@code File}.
- * <p/>
- * Temporary files are created as specified in {@link File#createTempFile(String, String, java.io.File)}.
- *
- * @see MemoryCacheSeekableStream
- * @see FileSeekableStream
- *
- * @see File#createTempFile(String, String)
- * @see RandomAccessFile
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/FileCacheSeekableStream.java#5 $
- */
-public final class FileCacheSeekableStream extends AbstractCachedSeekableStream {
-
-    private  byte[] buffer;
-
-    /**
-     * Creates a {@code FileCacheSeekableStream} reading from the given
-     * {@code InputStream}. Data will be cached in a temporary file.
-     *
-     * @param pStream the {@code InputStream} to read from
-     *
-     * @throws IOException if the temporary file cannot be created,
-     *          or cannot be opened for random access.
-     */
-    public FileCacheSeekableStream(final InputStream pStream) throws IOException {
-        this(pStream, "iocache", null);
-    }
-
-    /**
-     * Creates a {@code FileCacheSeekableStream} reading from the given
-     * {@code InputStream}. Data will be cached in a temporary file, with
-     * the given base name.
-     *
-     * @param pStream the {@code InputStream} to read from
-     * @param pTempBaseName optional base name for the temporary file
-     *
-     * @throws IOException if the temporary file cannot be created,
-     *          or cannot be opened for random access.
-     */
-    public FileCacheSeekableStream(final InputStream pStream, final String pTempBaseName) throws IOException {
-        this(pStream, pTempBaseName, null);
-    }
-
-    /**
-     * Creates a {@code FileCacheSeekableStream} reading from the given
-     * {@code InputStream}. Data will be cached in a temporary file, with
-     * the given base name, in the given directory
-     *
-     * @param pStream the {@code InputStream} to read from
-     * @param pTempBaseName optional base name for the temporary file
-     * @param pTempDir optional temp directory
-     *
-     * @throws IOException if the temporary file cannot be created,
-     *          or cannot be opened for random access.
-     */
-    public FileCacheSeekableStream(final InputStream pStream, final String pTempBaseName, final File pTempDir) throws IOException {
-        // NOTE: We do validation BEFORE we create temp file, to avoid orphan files
-        this(Validate.notNull(pStream, "stream"), createTempFile(pTempBaseName, pTempDir));
-    }
-
-    /*protected*/ static File createTempFile(String pTempBaseName, File pTempDir) throws IOException {
-        Validate.notNull(pTempBaseName, "tempBaseName");
-
-        File file = File.createTempFile(pTempBaseName, null, pTempDir);
-        file.deleteOnExit();
-
-        return file;
-    }
-
-    // TODO: Consider exposing this for external use
-    /*protected*/ FileCacheSeekableStream(final InputStream pStream, final File pFile) throws FileNotFoundException {
-        super(pStream, new FileCache(pFile));
-
-        // TODO: Allow for custom buffer sizes?
-        buffer = new byte[1024];
-    }
-
-    public final boolean isCachedMemory() {
-        return false;
-    }
-
-    public final boolean isCachedFile() {
-        return true;
-    }
-
-    @Override
-    protected void closeImpl() throws IOException {
-        super.closeImpl();
-        buffer = null;
-    }
-
-    @Override
-    public int read() throws IOException {
-        checkOpen();
-
-        int read;
-        if (position == streamPosition) {
-            // Read ahead into buffer, for performance
-            read = readAhead(buffer, 0, buffer.length);
-            if (read >= 0) {
-                read = buffer[0] & 0xff;
-            }
-
-            //System.out.println("Read 1 byte from stream: " + Integer.toHexString(read & 0xff));
-        }
-        else {
-            // ..or read byte from the cache
-            syncPosition();
-            read = getCache().read();
-
-            //System.out.println("Read 1 byte from cache: " + Integer.toHexString(read & 0xff));
-        }
-
-        // TODO: This field is not REALLY considered accessible.. :-P
-        if (read != -1) {
-            position++;
-        }
-        return read;
-    }
-
-    @Override
-    public int read(byte[] pBytes, int pOffset, int pLength) throws IOException {
-        checkOpen();
-
-        int length;
-        if (position == streamPosition) {
-            // Read bytes from the stream
-            length = readAhead(pBytes, pOffset, pLength);
-
-            //System.out.println("Read " + length + " byte from stream");
-        }
-        else {
-            // ...or read bytes from the cache
-            syncPosition();
-            length = getCache().read(pBytes, pOffset, (int) Math.min(pLength, streamPosition - position));
-
-            //System.out.println("Read " + length + " byte from cache");
-        }
-
-        // TODO: This field is not REALLY considered accessible.. :-P
-        if (length > 0) {
-            position += length;
-        }
-        return length;
-    }
-
-    private int readAhead(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
-        int length;
-        length = stream.read(pBytes, pOffset, pLength);
-
-        if (length > 0) {
-            streamPosition += length;
-            getCache().write(pBytes, pOffset, length);
-        }
-        return length;
-    }
-
-    final static class FileCache extends StreamCache {
-        private RandomAccessFile mCacheFile;
-
-        public FileCache(final File pFile) throws FileNotFoundException {
-            Validate.notNull(pFile, "file");
-            mCacheFile = new RandomAccessFile(pFile, "rw");
-        }
-
-        public void write(final int pByte) throws IOException {
-            mCacheFile.write(pByte);
-        }
-
-        @Override
-        public void write(final byte[] pBuffer, final int pOffset, final int pLength) throws IOException {
-            mCacheFile.write(pBuffer, pOffset, pLength);
-        }
-
-        public int read() throws IOException {
-            return mCacheFile.read();
-        }
-
-        @Override
-        public int read(final byte[] pBuffer, final int pOffset, final int pLength) throws IOException {
-            return mCacheFile.read(pBuffer, pOffset, pLength);
-        }
-
-        public void seek(final long pPosition) throws IOException {
-            mCacheFile.seek(pPosition);
-        }
-
-        public long getPosition() throws IOException {
-            return mCacheFile.getFilePointer();
-        }
-    }
-
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.Validate;
+
+import java.io.*;
+
+/**
+ * A {@code SeekableInputStream} implementation that caches data in a temporary {@code File}.
+ * <p>
+ * Temporary files are created as specified in {@link File#createTempFile(String, String, java.io.File)}.
+ * </p>
+ *
+ * @see MemoryCacheSeekableStream
+ * @see FileSeekableStream
+ *
+ * @see File#createTempFile(String, String)
+ * @see RandomAccessFile
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/FileCacheSeekableStream.java#5 $
+ */
+public final class FileCacheSeekableStream extends AbstractCachedSeekableStream {
+
+    private  byte[] buffer;
+
+    /**
+     * Creates a {@code FileCacheSeekableStream} reading from the given
+     * {@code InputStream}. Data will be cached in a temporary file.
+     *
+     * @param pStream the {@code InputStream} to read from
+     *
+     * @throws IOException if the temporary file cannot be created,
+     *          or cannot be opened for random access.
+     */
+    public FileCacheSeekableStream(final InputStream pStream) throws IOException {
+        this(pStream, "iocache", null);
+    }
+
+    /**
+     * Creates a {@code FileCacheSeekableStream} reading from the given
+     * {@code InputStream}. Data will be cached in a temporary file, with
+     * the given base name.
+     *
+     * @param pStream the {@code InputStream} to read from
+     * @param pTempBaseName optional base name for the temporary file
+     *
+     * @throws IOException if the temporary file cannot be created,
+     *          or cannot be opened for random access.
+     */
+    public FileCacheSeekableStream(final InputStream pStream, final String pTempBaseName) throws IOException {
+        this(pStream, pTempBaseName, null);
+    }
+
+    /**
+     * Creates a {@code FileCacheSeekableStream} reading from the given
+     * {@code InputStream}. Data will be cached in a temporary file, with
+     * the given base name, in the given directory
+     *
+     * @param pStream the {@code InputStream} to read from
+     * @param pTempBaseName optional base name for the temporary file
+     * @param pTempDir optional temp directory
+     *
+     * @throws IOException if the temporary file cannot be created,
+     *          or cannot be opened for random access.
+     */
+    public FileCacheSeekableStream(final InputStream pStream, final String pTempBaseName, final File pTempDir) throws IOException {
+        // NOTE: We do validation BEFORE we create temp file, to avoid orphan files
+        this(Validate.notNull(pStream, "stream"), createTempFile(pTempBaseName, pTempDir));
+    }
+
+    /*protected*/ static File createTempFile(String pTempBaseName, File pTempDir) throws IOException {
+        Validate.notNull(pTempBaseName, "tempBaseName");
+
+        File file = File.createTempFile(pTempBaseName, null, pTempDir);
+        file.deleteOnExit();
+
+        return file;
+    }
+
+    // TODO: Consider exposing this for external use
+    /*protected*/ FileCacheSeekableStream(final InputStream pStream, final File pFile) throws FileNotFoundException {
+        super(pStream, new FileCache(pFile));
+
+        // TODO: Allow for custom buffer sizes?
+        buffer = new byte[1024];
+    }
+
+    public final boolean isCachedMemory() {
+        return false;
+    }
+
+    public final boolean isCachedFile() {
+        return true;
+    }
+
+    @Override
+    protected void closeImpl() throws IOException {
+        // TODO: Close cache file
+        super.closeImpl();
+
+        buffer = null;
+    }
+
+    @Override
+    public int read() throws IOException {
+        checkOpen();
+
+        int read;
+        if (position == streamPosition) {
+            // Read ahead into buffer, for performance
+            read = readAhead(buffer, 0, buffer.length);
+            if (read >= 0) {
+                read = buffer[0] & 0xff;
+            }
+
+            //System.out.println("Read 1 byte from stream: " + Integer.toHexString(read & 0xff));
+        }
+        else {
+            // ..or read byte from the cache
+            syncPosition();
+            read = getCache().read();
+
+            //System.out.println("Read 1 byte from cache: " + Integer.toHexString(read & 0xff));
+        }
+
+        // TODO: This field is not REALLY considered accessible.. :-P
+        if (read != -1) {
+            position++;
+        }
+        return read;
+    }
+
+    @Override
+    public int read(byte[] pBytes, int pOffset, int pLength) throws IOException {
+        checkOpen();
+
+        int length;
+        if (position == streamPosition) {
+            // Read bytes from the stream
+            length = readAhead(pBytes, pOffset, pLength);
+
+            //System.out.println("Read " + length + " byte from stream");
+        }
+        else {
+            // ...or read bytes from the cache
+            syncPosition();
+            length = getCache().read(pBytes, pOffset, (int) Math.min(pLength, streamPosition - position));
+
+            //System.out.println("Read " + length + " byte from cache");
+        }
+
+        // TODO: This field is not REALLY considered accessible.. :-P
+        if (length > 0) {
+            position += length;
+        }
+        return length;
+    }
+
+    private int readAhead(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
+        int length;
+        length = stream.read(pBytes, pOffset, pLength);
+
+        if (length > 0) {
+            streamPosition += length;
+            getCache().write(pBytes, pOffset, length);
+        }
+        return length;
+    }
+
+    // TODO: We need to close the cache file!!! Otherwise we are leaking file descriptors
+
+    final static class FileCache extends StreamCache {
+        private RandomAccessFile cacheFile;
+
+        public FileCache(final File pFile) throws FileNotFoundException {
+            Validate.notNull(pFile, "file");
+            cacheFile = new RandomAccessFile(pFile, "rw");
+        }
+
+        public void write(final int pByte) throws IOException {
+            cacheFile.write(pByte);
+        }
+
+        @Override
+        public void write(final byte[] pBuffer, final int pOffset, final int pLength) throws IOException {
+            cacheFile.write(pBuffer, pOffset, pLength);
+        }
+
+        public int read() throws IOException {
+            return cacheFile.read();
+        }
+
+        @Override
+        public int read(final byte[] pBuffer, final int pOffset, final int pLength) throws IOException {
+            return cacheFile.read(pBuffer, pOffset, pLength);
+        }
+
+        public void seek(final long pPosition) throws IOException {
+            cacheFile.seek(pPosition);
+        }
+
+        public long getPosition() throws IOException {
+            return cacheFile.getFilePointer();
+        }
+
+        @Override
+        void close() throws IOException {
+            cacheFile.close();
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/FileSeekableStream.java

@@ -1,135 +1,135 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.io.RandomAccessFile;
-
-/**
- * A {@code SeekableInputStream} implementation that uses random access directly to a {@code File}.
- * <p/>
- * @see FileCacheSeekableStream
- * @see MemoryCacheSeekableStream
- * @see RandomAccessFile
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/FileSeekableStream.java#4 $
- */
-public final class FileSeekableStream extends SeekableInputStream {
-
-    // TODO: Figure out why this class is SLOWER than FileCacheSeekableStream in
-    // my tests..?
-
-    final RandomAccessFile mRandomAccess;
-
-    /**
-     * Creates a {@code FileSeekableStream} that reads from the given
-     * {@code File}.
-     *
-     * @param pInput file to read from
-     * @throws FileNotFoundException if {@code pInput} does not exist
-     */
-    public FileSeekableStream(final File pInput) throws FileNotFoundException {
-        this(new RandomAccessFile(pInput, "r"));
-    }
-
-    /**
-     * Creates a {@code FileSeekableStream} that reads from the given file.
-     * The {@code RandomAccessFile} needs only to be open in read
-     * ({@code "r"}) mode.
-     *
-     * @param pInput file to read from
-     */
-    public FileSeekableStream(final RandomAccessFile pInput) {
-        mRandomAccess = pInput;
-    }
-
-    /// Seekable
-
-    public boolean isCached() {
-        return false;
-    }
-
-    public boolean isCachedFile() {
-        return false;
-    }
-
-    public boolean isCachedMemory() {
-        return false;
-    }
-
-    /// InputStream
-
-    @Override
-    public int available() throws IOException {
-        long length = mRandomAccess.length() - position;
-        return length > Integer.MAX_VALUE ? Integer.MAX_VALUE : (int) length;
-    }
-
-    public void closeImpl() throws IOException {
-        mRandomAccess.close();
-    }
-
-    public int read() throws IOException {
-        checkOpen();
-
-        int read = mRandomAccess.read();
-        if (read >= 0) {
-            position++;
-        }
-        return read;
-    }
-
-    @Override
-    public int read(byte pBytes[], int pOffset, int pLength) throws IOException {
-        checkOpen();
-
-        int read = mRandomAccess.read(pBytes, pOffset, pLength);
-        if (read > 0) {
-            position += read;
-        }
-        return read;
-    }
-
-    /**
-     * Does nothing, as we don't really do any caching here.
-     *
-     * @param pPosition the position to flush to
-     */
-    protected void flushBeforeImpl(long pPosition) {
-    }
-
-    protected void seekImpl(long pPosition) throws IOException {
-        mRandomAccess.seek(pPosition);
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.RandomAccessFile;
+
+/**
+ * A {@code SeekableInputStream} implementation that uses random access directly to a {@code File}.
+
+ * @see FileCacheSeekableStream
+ * @see MemoryCacheSeekableStream
+ * @see RandomAccessFile
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/FileSeekableStream.java#4 $
+ */
+public final class FileSeekableStream extends SeekableInputStream {
+
+    // TODO: Figure out why this class is SLOWER than FileCacheSeekableStream in
+    // my tests..?
+
+    final RandomAccessFile mRandomAccess;
+
+    /**
+     * Creates a {@code FileSeekableStream} that reads from the given
+     * {@code File}.
+     *
+     * @param pInput file to read from
+     * @throws FileNotFoundException if {@code pInput} does not exist
+     */
+    public FileSeekableStream(final File pInput) throws FileNotFoundException {
+        this(new RandomAccessFile(pInput, "r"));
+    }
+
+    /**
+     * Creates a {@code FileSeekableStream} that reads from the given file.
+     * The {@code RandomAccessFile} needs only to be open in read
+     * ({@code "r"}) mode.
+     *
+     * @param pInput file to read from
+     */
+    public FileSeekableStream(final RandomAccessFile pInput) {
+        mRandomAccess = pInput;
+    }
+
+    /// Seekable
+
+    public boolean isCached() {
+        return false;
+    }
+
+    public boolean isCachedFile() {
+        return false;
+    }
+
+    public boolean isCachedMemory() {
+        return false;
+    }
+
+    /// InputStream
+
+    @Override
+    public int available() throws IOException {
+        long length = mRandomAccess.length() - position;
+        return length > Integer.MAX_VALUE ? Integer.MAX_VALUE : (int) length;
+    }
+
+    public void closeImpl() throws IOException {
+        mRandomAccess.close();
+    }
+
+    public int read() throws IOException {
+        checkOpen();
+
+        int read = mRandomAccess.read();
+        if (read >= 0) {
+            position++;
+        }
+        return read;
+    }
+
+    @Override
+    public int read(byte pBytes[], int pOffset, int pLength) throws IOException {
+        checkOpen();
+
+        int read = mRandomAccess.read(pBytes, pOffset, pLength);
+        if (read > 0) {
+            position += read;
+        }
+        return read;
+    }
+
+    /**
+     * Does nothing, as we don't really do any caching here.
+     *
+     * @param pPosition the position to flush to
+     */
+    protected void flushBeforeImpl(long pPosition) {
+    }
+
+    protected void seekImpl(long pPosition) throws IOException {
+        mRandomAccess.seek(pPosition);
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/FileSystem.java

@@ -1,103 +1,102 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.IOException;
-import java.io.InputStreamReader;
-
-/**
- * FileSystem
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: FileSystem.java#1 $
- */
-abstract class FileSystem {
-    abstract long getFreeSpace(File pPath);
-
-    abstract long getTotalSpace(File pPath);
-
-    abstract String getName();
-
-    static BufferedReader exec(String[] pArgs) throws IOException {
-        Process cmd = Runtime.getRuntime().exec(pArgs);
-        return new BufferedReader(new InputStreamReader(cmd.getInputStream()));
-    }
-
-    static FileSystem get() {
-        String os = System.getProperty("os.name");
-        //System.out.println("os = " + os);
-
-        os = os.toLowerCase();
-        if (os.contains("windows")) {
-            return new Win32FileSystem();
-        }
-        else if (os.contains("linux") ||
-                os.contains("sun os") ||
-                os.contains("sunos") ||
-                os.contains("solaris") ||
-                os.contains("mpe/ix") ||
-                os.contains("hp-ux") ||
-                os.contains("aix") ||
-                os.contains("freebsd") ||
-                os.contains("irix") ||
-                os.contains("digital unix") ||
-                os.contains("unix") ||
-                os.contains("mac os x")) {
-            return new UnixFileSystem();
-        }
-        else {
-            return new UnknownFileSystem(os);
-        }
-    }
-
-    private static class UnknownFileSystem extends FileSystem {
-        private final String osName;
-
-        UnknownFileSystem(String pOSName) {
-            osName = pOSName;
-        }
-
-        long getFreeSpace(File pPath) {
-            return 0l;
-        }
-
-        long getTotalSpace(File pPath) {
-            return 0l;
-        }
-
-        String getName() {
-            return "Unknown (" + osName + ")";
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+/**
+ * FileSystem
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: FileSystem.java#1 $
+ */
+abstract class FileSystem {
+    abstract long getFreeSpace(File pPath);
+
+    abstract long getTotalSpace(File pPath);
+
+    abstract String getName();
+
+    static BufferedReader exec(String[] pArgs) throws IOException {
+        Process cmd = Runtime.getRuntime().exec(pArgs);
+        return new BufferedReader(new InputStreamReader(cmd.getInputStream()));
+    }
+
+    static FileSystem get() {
+        String os = System.getProperty("os.name");
+        //System.out.println("os = " + os);
+
+        os = os.toLowerCase();
+        if (os.contains("windows")) {
+            return new Win32FileSystem();
+        }
+        else if (os.contains("linux") ||
+                os.contains("sun os") ||
+                os.contains("sunos") ||
+                os.contains("solaris") ||
+                os.contains("mpe/ix") ||
+                os.contains("hp-ux") ||
+                os.contains("aix") ||
+                os.contains("freebsd") ||
+                os.contains("irix") ||
+                os.contains("digital unix") ||
+                os.contains("unix") ||
+                os.contains("mac os x")) {
+            return new UnixFileSystem();
+        }
+        else {
+            return new UnknownFileSystem(os);
+        }
+    }
+
+    private static class UnknownFileSystem extends FileSystem {
+        private final String osName;
+
+        UnknownFileSystem(String pOSName) {
+            osName = pOSName;
+        }
+
+        long getFreeSpace(File pPath) {
+            return 0l;
+        }
+
+        long getTotalSpace(File pPath) {
+            return 0l;
+        }
+
+        String getName() {
+            return "Unknown (" + osName + ")";
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/FilenameMaskFilter.java

@@ -1,244 +1,250 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.util.regex.WildcardStringParser;
-
-import java.io.File;
-import java.io.FilenameFilter;
-
-/**
- * A Java Bean used for approving file names which are to be included in a
- * {@code java.io.File} listing.
- * The mask is given as a well-known DOS filename format, with '*' and '?' as
- * wildcards.
- * All other characters counts as ordinary characters.
- * <p/>
- * The file name masks are used as a filter input and is given to the class via
- * the string array property:<br>
- * <dd>{@code filenameMasksForInclusion} - Filename mask for exclusion of
- * files (default if both properties are defined)
- * <dd>{@code filenameMasksForExclusion} - Filename mask for exclusion of
- * files.
- * <p/>
- * A recommended way of doing this is by referencing to the component which uses
- * this class for file listing. In this way all properties are set in the same
- * component and this utility component is kept in the background with only
- * initial configuration necessary.
- *
- * @author <a href="mailto:eirik.torske@iconmedialab.no">Eirik Torske</a>
- * @see File#list(java.io.FilenameFilter) java.io.File.list
- * @see FilenameFilter java.io.FilenameFilter
- * @see WildcardStringParser
- * @deprecated
- */
-public class FilenameMaskFilter implements FilenameFilter {
-
-     // TODO: Rewrite to use regexp, or create new class
-
-    // Members
-    private String[] filenameMasksForInclusion;
-    private String[] filenameMasksForExclusion;
-    private boolean inclusion = true;
-
-
-    /**
-     * Creates a {@code FilenameMaskFilter}
-     */
-    public FilenameMaskFilter() {
-    }
-
-    /**
-     * Creates a {@code FilenameMaskFilter}
-     *
-     * @param pFilenameMask the filename mask
-     */
-    public FilenameMaskFilter(final String pFilenameMask) {
-        String[] filenameMask = {pFilenameMask};
-        setFilenameMasksForInclusion(filenameMask);
-    }
-
-    /**
-     * Creates a {@code FilenameMaskFilter}
-     *
-     * @param pFilenameMasks the filename masks
-     */
-    public FilenameMaskFilter(final String[] pFilenameMasks) {
-        this(pFilenameMasks, false);
-    }
-
-    /**
-     * Creates a {@code FilenameMaskFilter}
-     *
-     * @param pFilenameMask the filename masks
-     * @param pExclusion if {@code true}, the masks will be excluded
-     */
-    public FilenameMaskFilter(final String pFilenameMask, final boolean pExclusion) {
-        String[] filenameMask = {pFilenameMask};
-
-        if (pExclusion) {
-            setFilenameMasksForExclusion(filenameMask);
-        }
-        else {
-            setFilenameMasksForInclusion(filenameMask);
-        }
-    }
-
-    /**
-     * Creates a {@code FilenameMaskFilter}
-     *
-     * @param pFilenameMasks the filename masks
-     * @param pExclusion if {@code true}, the masks will be excluded
-     */
-    public FilenameMaskFilter(final String[] pFilenameMasks, final boolean pExclusion) {
-        if (pExclusion) {
-            setFilenameMasksForExclusion(pFilenameMasks);
-        }
-        else {
-            setFilenameMasksForInclusion(pFilenameMasks);
-        }
-    }
-
-    /**
-     *
-     * @param pFilenameMasksForInclusion the filename masks to include
-     */
-    public void setFilenameMasksForInclusion(String[] pFilenameMasksForInclusion) {
-        filenameMasksForInclusion = pFilenameMasksForInclusion;
-    }
-
-    /**
-     * @return the current inclusion masks
-     */
-    public String[] getFilenameMasksForInclusion() {
-        return filenameMasksForInclusion.clone();
-    }
-
-    /**
-     * @param pFilenameMasksForExclusion the filename masks to exclude
-     */
-    public void setFilenameMasksForExclusion(String[] pFilenameMasksForExclusion) {
-        filenameMasksForExclusion = pFilenameMasksForExclusion;
-        inclusion = false;
-    }
-
-    /**
-     * @return the current exclusion masks
-     */
-    public String[] getFilenameMasksForExclusion() {
-        return filenameMasksForExclusion.clone();
-    }
-
-    /**
-     * This method implements the {@code java.io.FilenameFilter} interface.
-     *
-     * @param pDir  the directory in which the file was found.
-     * @param pName the name of the file.
-     * @return {@code true} if the file {@code pName} should be included in the file
-     *         list; {@code false} otherwise.
-     */
-    public boolean accept(File pDir, String pName) {
-        WildcardStringParser parser;
-
-        // Check each filename string mask whether the file is to be accepted
-        if (inclusion) {  // Inclusion
-            for (String mask : filenameMasksForInclusion) {
-                parser = new WildcardStringParser(mask);
-                if (parser.parseString(pName)) {
-
-                    // The filename was accepted by the filename masks provided
-                    // - include it in filename list
-                    return true;
-                }
-            }
-
-            // The filename not was accepted by any of the filename masks
-            // provided - NOT to be included in the filename list
-            return false;
-        }
-        else {
-            // Exclusion
-            for (String mask : filenameMasksForExclusion) {
-                parser = new WildcardStringParser(mask);
-                if (parser.parseString(pName)) {
-
-                    // The filename was accepted by the filename masks provided
-                    // - NOT to be included in the filename list
-                    return false;
-                }
-            }
-
-            // The filename was not accepted by any of the filename masks
-            // provided - include it in filename list
-            return true;
-        }
-    }
-
-    /**
-     * @return a string representation for debug purposes
-     */
-    public String toString() {
-        StringBuilder retVal = new StringBuilder();
-        int i;
-
-        if (inclusion) {
-            // Inclusion
-            if (filenameMasksForInclusion == null) {
-                retVal.append("No filename masks set - property filenameMasksForInclusion is null!");
-            }
-            else {
-                retVal.append(filenameMasksForInclusion.length);
-                retVal.append(" filename mask(s) - ");
-                for (i = 0; i < filenameMasksForInclusion.length; i++) {
-                    retVal.append("\"");
-                    retVal.append(filenameMasksForInclusion[i]);
-                    retVal.append("\", \"");
-                }
-            }
-        }
-        else {
-            // Exclusion
-            if (filenameMasksForExclusion == null) {
-                retVal.append("No filename masks set - property filenameMasksForExclusion is null!");
-            }
-            else {
-                retVal.append(filenameMasksForExclusion.length);
-                retVal.append(" exclusion filename mask(s) - ");
-                for (i = 0; i < filenameMasksForExclusion.length; i++) {
-                    retVal.append("\"");
-                    retVal.append(filenameMasksForExclusion[i]);
-                    retVal.append("\", \"");
-                }
-            }
-        }
-        return retVal.toString();
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.util.regex.WildcardStringParser;
+
+import java.io.File;
+import java.io.FilenameFilter;
+
+/**
+ * A Java Bean used for approving file names which are to be included in a
+ * {@code java.io.File} listing.
+ * The mask is given as a well-known DOS filename format, with '*' and '?' as
+ * wildcards.
+ * All other characters counts as ordinary characters.
+ * <p>
+ * The file name masks are used as a filter input and is given to the class via
+ * the string array property:
+ * </p>
+ * <dl>
+ * <dt>{@code filenameMasksForInclusion}</dt>
+ * <dd>Filename mask for exclusion of
+ * files (default if both properties are defined).</dd>
+ * <dt>{@code filenameMasksForExclusion}</dt>
+ * <dd>Filename mask for exclusion of files.</dd>
+ * </dl>
+ * <p>
+ * A recommended way of doing this is by referencing to the component which uses
+ * this class for file listing. In this way all properties are set in the same
+ * component and this utility component is kept in the background with only
+ * initial configuration necessary.
+ * </p>
+ *
+ * @author <a href="mailto:eirik.torske@iconmedialab.no">Eirik Torske</a>
+ * @see File#list(java.io.FilenameFilter) java.io.File.list
+ * @see FilenameFilter java.io.FilenameFilter
+ * @see WildcardStringParser
+ * @deprecated
+ */
+@Deprecated
+public class FilenameMaskFilter implements FilenameFilter {
+
+     // TODO: Rewrite to use regexp, or create new class
+
+    // Members
+    private String[] filenameMasksForInclusion;
+    private String[] filenameMasksForExclusion;
+    private boolean inclusion = true;
+
+
+    /**
+     * Creates a {@code FilenameMaskFilter}
+     */
+    public FilenameMaskFilter() {
+    }
+
+    /**
+     * Creates a {@code FilenameMaskFilter}
+     *
+     * @param pFilenameMask the filename mask
+     */
+    public FilenameMaskFilter(final String pFilenameMask) {
+        String[] filenameMask = {pFilenameMask};
+        setFilenameMasksForInclusion(filenameMask);
+    }
+
+    /**
+     * Creates a {@code FilenameMaskFilter}
+     *
+     * @param pFilenameMasks the filename masks
+     */
+    public FilenameMaskFilter(final String[] pFilenameMasks) {
+        this(pFilenameMasks, false);
+    }
+
+    /**
+     * Creates a {@code FilenameMaskFilter}
+     *
+     * @param pFilenameMask the filename masks
+     * @param pExclusion if {@code true}, the masks will be excluded
+     */
+    public FilenameMaskFilter(final String pFilenameMask, final boolean pExclusion) {
+        String[] filenameMask = {pFilenameMask};
+
+        if (pExclusion) {
+            setFilenameMasksForExclusion(filenameMask);
+        }
+        else {
+            setFilenameMasksForInclusion(filenameMask);
+        }
+    }
+
+    /**
+     * Creates a {@code FilenameMaskFilter}
+     *
+     * @param pFilenameMasks the filename masks
+     * @param pExclusion if {@code true}, the masks will be excluded
+     */
+    public FilenameMaskFilter(final String[] pFilenameMasks, final boolean pExclusion) {
+        if (pExclusion) {
+            setFilenameMasksForExclusion(pFilenameMasks);
+        }
+        else {
+            setFilenameMasksForInclusion(pFilenameMasks);
+        }
+    }
+
+    /**
+     *
+     * @param pFilenameMasksForInclusion the filename masks to include
+     */
+    public void setFilenameMasksForInclusion(String[] pFilenameMasksForInclusion) {
+        filenameMasksForInclusion = pFilenameMasksForInclusion;
+    }
+
+    /**
+     * @return the current inclusion masks
+     */
+    public String[] getFilenameMasksForInclusion() {
+        return filenameMasksForInclusion.clone();
+    }
+
+    /**
+     * @param pFilenameMasksForExclusion the filename masks to exclude
+     */
+    public void setFilenameMasksForExclusion(String[] pFilenameMasksForExclusion) {
+        filenameMasksForExclusion = pFilenameMasksForExclusion;
+        inclusion = false;
+    }
+
+    /**
+     * @return the current exclusion masks
+     */
+    public String[] getFilenameMasksForExclusion() {
+        return filenameMasksForExclusion.clone();
+    }
+
+    /**
+     * This method implements the {@code java.io.FilenameFilter} interface.
+     *
+     * @param pDir  the directory in which the file was found.
+     * @param pName the name of the file.
+     * @return {@code true} if the file {@code pName} should be included in the file
+     *         list; {@code false} otherwise.
+     */
+    public boolean accept(File pDir, String pName) {
+        WildcardStringParser parser;
+
+        // Check each filename string mask whether the file is to be accepted
+        if (inclusion) {  // Inclusion
+            for (String mask : filenameMasksForInclusion) {
+                parser = new WildcardStringParser(mask);
+                if (parser.parseString(pName)) {
+
+                    // The filename was accepted by the filename masks provided
+                    // - include it in filename list
+                    return true;
+                }
+            }
+
+            // The filename not was accepted by any of the filename masks
+            // provided - NOT to be included in the filename list
+            return false;
+        }
+        else {
+            // Exclusion
+            for (String mask : filenameMasksForExclusion) {
+                parser = new WildcardStringParser(mask);
+                if (parser.parseString(pName)) {
+
+                    // The filename was accepted by the filename masks provided
+                    // - NOT to be included in the filename list
+                    return false;
+                }
+            }
+
+            // The filename was not accepted by any of the filename masks
+            // provided - include it in filename list
+            return true;
+        }
+    }
+
+    /**
+     * @return a string representation for debug purposes
+     */
+    public String toString() {
+        StringBuilder retVal = new StringBuilder();
+        int i;
+
+        if (inclusion) {
+            // Inclusion
+            if (filenameMasksForInclusion == null) {
+                retVal.append("No filename masks set - property filenameMasksForInclusion is null!");
+            }
+            else {
+                retVal.append(filenameMasksForInclusion.length);
+                retVal.append(" filename mask(s) - ");
+                for (i = 0; i < filenameMasksForInclusion.length; i++) {
+                    retVal.append("\"");
+                    retVal.append(filenameMasksForInclusion[i]);
+                    retVal.append("\", \"");
+                }
+            }
+        }
+        else {
+            // Exclusion
+            if (filenameMasksForExclusion == null) {
+                retVal.append("No filename masks set - property filenameMasksForExclusion is null!");
+            }
+            else {
+                retVal.append(filenameMasksForExclusion.length);
+                retVal.append(" exclusion filename mask(s) - ");
+                for (i = 0; i < filenameMasksForExclusion.length; i++) {
+                    retVal.append("\"");
+                    retVal.append(filenameMasksForExclusion[i]);
+                    retVal.append("\", \"");
+                }
+            }
+        }
+        return retVal.toString();
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/LittleEndianDataInputStream.java

@@ -1,453 +1,450 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-/*
- * From http://www.cafeaulait.org/books/javaio/ioexamples/index.html:
- *
- * Please feel free to use any fragment of this code you need in your own work.
- * As far as I am concerned, it's in the public domain. No permission is necessary
- * or required.  Credit is always appreciated if you use a large chunk or base a
- * significant product on one of my examples, but that's not required either.
- *
- * Elliotte Rusty Harold
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.Validate;
-
-import java.io.*;
-
-/**
- * A little endian input stream reads two's complement,
- * little endian integers, floating point numbers, and characters
- * and returns them as Java primitive types.
- * <p/>
- * The standard {@code java.io.DataInputStream} class
- * which this class imitates reads big endian quantities.
- * <p/>
- * <em>Warning:
- * <!-- Beware of little indians! -->
- * The {@code DataInput} and {@code DataOutput} interfaces
- * specifies big endian byte order in their documentation.
- * This means that this class is, strictly speaking, not a proper
- * implementation. However, I don't see a reason for the these interfaces to
- * specify the byte order of their underlying representations.
- * </em>
- *
- * @see com.twelvemonkeys.io.LittleEndianRandomAccessFile
- * @see java.io.DataInputStream
- * @see java.io.DataInput
- * @see java.io.DataOutput
- *
- * @author Elliotte Rusty Harold
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version 2
- */
-public class LittleEndianDataInputStream extends FilterInputStream implements DataInput {
-    // TODO: Optimize by reading into a fixed size (8 bytes) buffer instead of individual read operations?
-    /**
-     * Creates a new little endian input stream and chains it to the
-     * input stream specified by the {@code pStream} argument.
-     *
-     * @param pStream the underlying input stream.
-     * @see java.io.FilterInputStream#in
-     */
-    public LittleEndianDataInputStream(final InputStream pStream) {
-        super(Validate.notNull(pStream, "stream"));
-    }
-
-    /**
-     * Reads a {@code boolean} from the underlying input stream by
-     * reading a single byte. If the byte is zero, false is returned.
-     * If the byte is positive, true is returned.
-     *
-     * @return the {@code boolean} value read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public boolean readBoolean() throws IOException {
-        int b = in.read();
-
-        if (b < 0) {
-            throw new EOFException();
-        }
-
-        return b != 0;
-    }
-
-    /**
-     * Reads a signed {@code byte} from the underlying input stream
-     * with value between -128 and 127
-     *
-     * @return the {@code byte} value read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public byte readByte() throws IOException {
-        int b = in.read();
-
-        if (b < 0) {
-            throw new EOFException();
-        }
-
-        return (byte) b;
-
-    }
-
-    /**
-     * Reads an unsigned {@code byte} from the underlying
-     * input stream with value between 0 and 255
-     *
-     * @return the {@code byte} value read.
-     * @throws EOFException if the end of the underlying input
-     *                      stream has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public int readUnsignedByte() throws IOException {
-        int b = in.read();
-
-        if (b < 0) {
-            throw new EOFException();
-        }
-
-        return b;
-    }
-
-    /**
-     * Reads a two byte signed {@code short} from the underlying
-     * input stream in little endian order, low byte first.
-     *
-     * @return the {@code short} read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public short readShort() throws IOException {
-        int byte1 = in.read();
-        int byte2 = in.read();
-
-        // only need to test last byte read
-        // if byte1 is -1 so is byte2
-        if (byte2 < 0) {
-            throw new EOFException();
-        }
-
-        return (short) (((byte2 << 24) >>> 16) | (byte1 << 24) >>> 24);
-    }
-
-    /**
-     * Reads a two byte unsigned {@code short} from the underlying
-     * input stream in little endian order, low byte first.
-     *
-     * @return the int value of the unsigned short read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public int readUnsignedShort() throws IOException {
-        int byte1 = in.read();
-        int byte2 = in.read();
-
-        if (byte2 < 0) {
-            throw new EOFException();
-        }
-
-        return (byte2 << 8) + byte1;
-    }
-
-    /**
-     * Reads a two byte Unicode {@code char} from the underlying
-     * input stream in little endian order, low byte first.
-     *
-     * @return the int value of the unsigned short read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public char readChar() throws IOException {
-        int byte1 = in.read();
-        int byte2 = in.read();
-
-        if (byte2 < 0) {
-            throw new EOFException();
-        }
-
-        return (char) (((byte2 << 24) >>> 16) | ((byte1 << 24) >>> 24));
-    }
-
-
-    /**
-     * Reads a four byte signed {@code int} from the underlying
-     * input stream in little endian order, low byte first.
-     *
-     * @return the {@code int} read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public int readInt() throws IOException {
-        int byte1 = in.read();
-        int byte2 = in.read();
-        int byte3 = in.read();
-        int byte4 = in.read();
-
-        if (byte4 < 0) {
-            throw new EOFException();
-        }
-
-        return (byte4 << 24) | ((byte3 << 24) >>> 8)
-                | ((byte2 << 24) >>> 16) | ((byte1 << 24) >>> 24);
-    }
-
-    /**
-     * Reads an eight byte signed {@code int} from the underlying
-     * input stream in little endian order, low byte first.
-     *
-     * @return the {@code int} read.
-     * @throws EOFException if the end of the underlying input stream
-     *                      has been reached
-     * @throws IOException  if the underlying stream throws an IOException.
-     */
-    public long readLong() throws IOException {
-        long byte1 = in.read();
-        long byte2 = in.read();
-        long byte3 = in.read();
-        long byte4 = in.read();
-        long byte5 = in.read();
-        long byte6 = in.read();
-        long byte7 = in.read();
-        long byte8 = in.read();
-
-        if (byte8 < 0) {
-            throw new EOFException();
-        }
-
-        return (byte8 << 56) | ((byte7 << 56) >>> 8)
-                | ((byte6 << 56) >>> 16) | ((byte5 << 56) >>> 24)
-                | ((byte4 << 56) >>> 32) | ((byte3 << 56) >>> 40)
-                | ((byte2 << 56) >>> 48) | ((byte1 << 56) >>> 56);
-    }
-
-    /**
-     * Reads a string of no more than 65,535 characters
-     * from the underlying input stream using UTF-8
-     * encoding. This method first reads a two byte short
-     * in <b>big</b> endian order as required by the
-     * UTF-8 specification. This gives the number of bytes in
-     * the UTF-8 encoded version of the string.
-     * Next this many bytes are read and decoded as UTF-8
-     * encoded characters.
-     *
-     * @return the decoded string
-     * @throws UTFDataFormatException if the string cannot be decoded
-     * @throws IOException            if the underlying stream throws an IOException.
-     */
-    public String readUTF() throws IOException {
-        int byte1 = in.read();
-        int byte2 = in.read();
-
-        if (byte2 < 0) {
-            throw new EOFException();
-        }
-
-        int numbytes = (byte1 << 8) + byte2;
-        char result[] = new char[numbytes];
-        int numread = 0;
-        int numchars = 0;
-
-        while (numread < numbytes) {
-            int c1 = readUnsignedByte();
-            int c2, c3;
-
-            // The first four bits of c1 determine how many bytes are in this char
-            int test = c1 >> 4;
-            if (test < 8) {  // one byte
-                numread++;
-                result[numchars++] = (char) c1;
-            }
-            else if (test == 12 || test == 13) { // two bytes
-                numread += 2;
-
-                if (numread > numbytes) {
-                    throw new UTFDataFormatException();
-                }
-
-                c2 = readUnsignedByte();
-
-                if ((c2 & 0xC0) != 0x80) {
-                    throw new UTFDataFormatException();
-                }
-
-                result[numchars++] = (char) (((c1 & 0x1F) << 6) | (c2 & 0x3F));
-            }
-            else if (test == 14) { // three bytes
-                numread += 3;
-
-                if (numread > numbytes) {
-                    throw new UTFDataFormatException();
-                }
-
-                c2 = readUnsignedByte();
-                c3 = readUnsignedByte();
-
-                if (((c2 & 0xC0) != 0x80) || ((c3 & 0xC0) != 0x80)) {
-                    throw new UTFDataFormatException();
-                }
-
-                result[numchars++] = (char) (((c1 & 0x0F) << 12) | ((c2 & 0x3F) << 6) | (c3 & 0x3F));
-            }
-            else { // malformed
-                throw new UTFDataFormatException();
-            }
-
-        }  // end while
-
-        return new String(result, 0, numchars);
-
-    }
-
-    /**
-     * @return the next eight bytes of this input stream, interpreted as a
-     *         little endian {@code double}.
-     * @throws EOFException if end of stream occurs before eight bytes
-     *                      have been read.
-     * @throws IOException  if an I/O error occurs.
-     */
-    public final double readDouble() throws IOException {
-        return Double.longBitsToDouble(readLong());
-    }
-
-    /**
-     * @return the next four bytes of this input stream, interpreted as a
-     *         little endian {@code int}.
-     * @throws EOFException if end of stream occurs before four bytes
-     *                      have been read.
-     * @throws IOException  if an I/O error occurs.
-     */
-    public final float readFloat() throws IOException {
-        return Float.intBitsToFloat(readInt());
-    }
-
-    /**
-     * See the general contract of the {@code skipBytes}
-     * method of {@code DataInput}.
-     * <p>
-     * Bytes for this operation are read from the contained input stream.
-     *
-     * @param pLength the number of bytes to be skipped.
-     * @return the actual number of bytes skipped.
-     * @exception IOException if an I/O error occurs.
-     */
-    public final int skipBytes(int pLength) throws IOException {
-        // NOTE: There was probably a bug in ERH's original code here, as skip
-        // never returns -1, but returns 0 if no more bytes can be skipped...
-        int total = 0;
-        int skipped;
-
-        while ((total < pLength) && ((skipped = (int) in.skip(pLength - total)) > 0)) {
-            total += skipped;
-        }
-
-        return total;
-    }
-
-    /**
-     * See the general contract of the {@code readFully}
-     * method of {@code DataInput}.
-     * <p/>
-     * Bytes
-     * for this operation are read from the contained
-     * input stream.
-     *
-     * @param pBytes the buffer into which the data is read.
-     * @throws EOFException if this input stream reaches the end before
-     *                      reading all the bytes.
-     * @throws IOException  if an I/O error occurs.
-     * @see java.io.FilterInputStream#in
-     */
-    public final void readFully(byte pBytes[]) throws IOException {
-        readFully(pBytes, 0, pBytes.length);
-    }
-
-    /**
-     * See the general contract of the {@code readFully}
-     * method of {@code DataInput}.
-     * <p/>
-     * Bytes
-     * for this operation are read from the contained
-     * input stream.
-     *
-     * @param pBytes   the buffer into which the data is read.
-     * @param pOffset the start offset of the data.
-     * @param pLength the number of bytes to read.
-     * @throws EOFException if this input stream reaches the end before
-     *                      reading all the bytes.
-     * @throws IOException  if an I/O error occurs.
-     * @see java.io.FilterInputStream#in
-     */
-    public final void readFully(byte pBytes[], int pOffset, int pLength) throws IOException {
-        if (pLength < 0) {
-            throw new IndexOutOfBoundsException();
-        }
-
-        int count = 0;
-
-        while (count < pLength) {
-            int read = in.read(pBytes, pOffset + count, pLength - count);
-
-            if (read < 0) {
-                throw new EOFException();
-            }
-
-            count += read;
-        }
-    }
-
-    /**
-     * See the general contract of the {@code readLine}
-     * method of {@code DataInput}.
-     * <p>
-     * Bytes for this operation are read from the contained input stream.
-     *
-     * @deprecated This method does not properly convert bytes to characters.
-     *
-     * @return     the next line of text from this input stream.
-     * @exception  IOException  if an I/O error occurs.
-     * @see        java.io.BufferedReader#readLine()
-     * @see        java.io.DataInputStream#readLine()
-     * @noinspection deprecation
-     */
-    public String readLine() throws IOException {
-        DataInputStream ds = new DataInputStream(in);
-        return ds.readLine();
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/*
+ * From http://www.cafeaulait.org/books/javaio/ioexamples/index.html:
+ *
+ * Please feel free to use any fragment of this code you need in your own work.
+ * As far as I am concerned, it's in the public domain. No permission is necessary
+ * or required.  Credit is always appreciated if you use a large chunk or base a
+ * significant product on one of my examples, but that's not required either.
+ *
+ * Elliotte Rusty Harold
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.Validate;
+
+import java.io.*;
+
+/**
+ * A little endian input stream reads two's complement,
+ * little endian integers, floating point numbers, and characters
+ * and returns them as Java primitive types.
+ * <p>
+ * The standard {@code java.io.DataInputStream} class
+ * which this class imitates reads big endian quantities.
+ * </p>
+ * <p>
+ * <em>Warning:
+ * The {@code DataInput} and {@code DataOutput} interfaces
+ * specifies big endian byte order in their documentation.
+ * This means that this class is, strictly speaking, not a proper
+ * implementation. However, I don't see a reason for the these interfaces to
+ * specify the byte order of their underlying representations.
+ * </em>
+ * </p>
+ *
+ * @see com.twelvemonkeys.io.LittleEndianRandomAccessFile
+ * @see java.io.DataInputStream
+ * @see java.io.DataInput
+ * @see java.io.DataOutput
+ *
+ * @author Elliotte Rusty Harold
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version 2
+ */
+public class LittleEndianDataInputStream extends FilterInputStream implements DataInput {
+    // TODO: Optimize by reading into a fixed size (8 bytes) buffer instead of individual read operations?
+    /**
+     * Creates a new little endian input stream and chains it to the
+     * input stream specified by the {@code pStream} argument.
+     *
+     * @param pStream the underlying input stream.
+     * @see java.io.FilterInputStream#in
+     */
+    public LittleEndianDataInputStream(final InputStream pStream) {
+        super(Validate.notNull(pStream, "stream"));
+    }
+
+    /**
+     * Reads a {@code boolean} from the underlying input stream by
+     * reading a single byte. If the byte is zero, false is returned.
+     * If the byte is positive, true is returned.
+     *
+     * @return the {@code boolean} value read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public boolean readBoolean() throws IOException {
+        int b = in.read();
+
+        if (b < 0) {
+            throw new EOFException();
+        }
+
+        return b != 0;
+    }
+
+    /**
+     * Reads a signed {@code byte} from the underlying input stream
+     * with value between -128 and 127
+     *
+     * @return the {@code byte} value read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public byte readByte() throws IOException {
+        int b = in.read();
+
+        if (b < 0) {
+            throw new EOFException();
+        }
+
+        return (byte) b;
+
+    }
+
+    /**
+     * Reads an unsigned {@code byte} from the underlying
+     * input stream with value between 0 and 255
+     *
+     * @return the {@code byte} value read.
+     * @throws EOFException if the end of the underlying input
+     *                      stream has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public int readUnsignedByte() throws IOException {
+        int b = in.read();
+
+        if (b < 0) {
+            throw new EOFException();
+        }
+
+        return b;
+    }
+
+    /**
+     * Reads a two byte signed {@code short} from the underlying
+     * input stream in little endian order, low byte first.
+     *
+     * @return the {@code short} read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public short readShort() throws IOException {
+        int byte1 = in.read();
+        int byte2 = in.read();
+
+        // only need to test last byte read
+        // if byte1 is -1 so is byte2
+        if (byte2 < 0) {
+            throw new EOFException();
+        }
+
+        return (short) (((byte2 << 24) >>> 16) | (byte1 << 24) >>> 24);
+    }
+
+    /**
+     * Reads a two byte unsigned {@code short} from the underlying
+     * input stream in little endian order, low byte first.
+     *
+     * @return the int value of the unsigned short read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public int readUnsignedShort() throws IOException {
+        int byte1 = in.read();
+        int byte2 = in.read();
+
+        if (byte2 < 0) {
+            throw new EOFException();
+        }
+
+        return (byte2 << 8) + byte1;
+    }
+
+    /**
+     * Reads a two byte Unicode {@code char} from the underlying
+     * input stream in little endian order, low byte first.
+     *
+     * @return the int value of the unsigned short read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public char readChar() throws IOException {
+        int byte1 = in.read();
+        int byte2 = in.read();
+
+        if (byte2 < 0) {
+            throw new EOFException();
+        }
+
+        return (char) (((byte2 << 24) >>> 16) | ((byte1 << 24) >>> 24));
+    }
+
+
+    /**
+     * Reads a four byte signed {@code int} from the underlying
+     * input stream in little endian order, low byte first.
+     *
+     * @return the {@code int} read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public int readInt() throws IOException {
+        int byte1 = in.read();
+        int byte2 = in.read();
+        int byte3 = in.read();
+        int byte4 = in.read();
+
+        if (byte4 < 0) {
+            throw new EOFException();
+        }
+
+        return (byte4 << 24) | ((byte3 << 24) >>> 8)
+                | ((byte2 << 24) >>> 16) | ((byte1 << 24) >>> 24);
+    }
+
+    /**
+     * Reads an eight byte signed {@code int} from the underlying
+     * input stream in little endian order, low byte first.
+     *
+     * @return the {@code int} read.
+     * @throws EOFException if the end of the underlying input stream
+     *                      has been reached
+     * @throws IOException  if the underlying stream throws an IOException.
+     */
+    public long readLong() throws IOException {
+        long byte1 = in.read();
+        long byte2 = in.read();
+        long byte3 = in.read();
+        long byte4 = in.read();
+        long byte5 = in.read();
+        long byte6 = in.read();
+        long byte7 = in.read();
+        long byte8 = in.read();
+
+        if (byte8 < 0) {
+            throw new EOFException();
+        }
+
+        return (byte8 << 56) | ((byte7 << 56) >>> 8)
+                | ((byte6 << 56) >>> 16) | ((byte5 << 56) >>> 24)
+                | ((byte4 << 56) >>> 32) | ((byte3 << 56) >>> 40)
+                | ((byte2 << 56) >>> 48) | ((byte1 << 56) >>> 56);
+    }
+
+    /**
+     * Reads a string of no more than 65,535 characters
+     * from the underlying input stream using UTF-8
+     * encoding. This method first reads a two byte short
+     * in <b>big</b> endian order as required by the
+     * UTF-8 specification. This gives the number of bytes in
+     * the UTF-8 encoded version of the string.
+     * Next this many bytes are read and decoded as UTF-8
+     * encoded characters.
+     *
+     * @return the decoded string
+     * @throws UTFDataFormatException if the string cannot be decoded
+     * @throws IOException            if the underlying stream throws an IOException.
+     */
+    public String readUTF() throws IOException {
+        int byte1 = in.read();
+        int byte2 = in.read();
+
+        if (byte2 < 0) {
+            throw new EOFException();
+        }
+
+        int numbytes = (byte1 << 8) + byte2;
+        char result[] = new char[numbytes];
+        int numread = 0;
+        int numchars = 0;
+
+        while (numread < numbytes) {
+            int c1 = readUnsignedByte();
+            int c2, c3;
+
+            // The first four bits of c1 determine how many bytes are in this char
+            int test = c1 >> 4;
+            if (test < 8) {  // one byte
+                numread++;
+                result[numchars++] = (char) c1;
+            }
+            else if (test == 12 || test == 13) { // two bytes
+                numread += 2;
+
+                if (numread > numbytes) {
+                    throw new UTFDataFormatException();
+                }
+
+                c2 = readUnsignedByte();
+
+                if ((c2 & 0xC0) != 0x80) {
+                    throw new UTFDataFormatException();
+                }
+
+                result[numchars++] = (char) (((c1 & 0x1F) << 6) | (c2 & 0x3F));
+            }
+            else if (test == 14) { // three bytes
+                numread += 3;
+
+                if (numread > numbytes) {
+                    throw new UTFDataFormatException();
+                }
+
+                c2 = readUnsignedByte();
+                c3 = readUnsignedByte();
+
+                if (((c2 & 0xC0) != 0x80) || ((c3 & 0xC0) != 0x80)) {
+                    throw new UTFDataFormatException();
+                }
+
+                result[numchars++] = (char) (((c1 & 0x0F) << 12) | ((c2 & 0x3F) << 6) | (c3 & 0x3F));
+            }
+            else { // malformed
+                throw new UTFDataFormatException();
+            }
+
+        }  // end while
+
+        return new String(result, 0, numchars);
+
+    }
+
+    /**
+     * @return the next eight bytes of this input stream, interpreted as a
+     *         little endian {@code double}.
+     * @throws EOFException if end of stream occurs before eight bytes
+     *                      have been read.
+     * @throws IOException  if an I/O error occurs.
+     */
+    public final double readDouble() throws IOException {
+        return Double.longBitsToDouble(readLong());
+    }
+
+    /**
+     * @return the next four bytes of this input stream, interpreted as a
+     *         little endian {@code int}.
+     * @throws EOFException if end of stream occurs before four bytes
+     *                      have been read.
+     * @throws IOException  if an I/O error occurs.
+     */
+    public final float readFloat() throws IOException {
+        return Float.intBitsToFloat(readInt());
+    }
+
+    /**
+     * See the general contract of the {@code skipBytes}
+     * method of {@code DataInput}.
+     * <p>
+     * Bytes for this operation are read from the contained input stream.
+     *
+     * @param pLength the number of bytes to be skipped.
+     * @return the actual number of bytes skipped.
+     * @exception IOException if an I/O error occurs.
+     */
+    public final int skipBytes(int pLength) throws IOException {
+        // NOTE: There was probably a bug in ERH's original code here, as skip
+        // never returns -1, but returns 0 if no more bytes can be skipped...
+        int total = 0;
+        int skipped;
+
+        while ((total < pLength) && ((skipped = (int) in.skip(pLength - total)) > 0)) {
+            total += skipped;
+        }
+
+        return total;
+    }
+
+    /**
+     * See the general contract of the {@code readFully} method of {@code DataInput}.
+     * <p>
+     * Bytes for this operation are read from the contained input stream.
+     * </p>
+     *
+     * @param pBytes the buffer into which the data is read.
+     * @throws EOFException if this input stream reaches the end before
+     *                      reading all the bytes.
+     * @throws IOException  if an I/O error occurs.
+     * @see java.io.FilterInputStream#in
+     */
+    public final void readFully(byte pBytes[]) throws IOException {
+        readFully(pBytes, 0, pBytes.length);
+    }
+
+    /**
+     * See the general contract of the {@code readFully} method of {@code DataInput}.
+     * <p>
+     * Bytes for this operation are read from the contained input stream.
+     * </p>
+     *
+     * @param pBytes   the buffer into which the data is read.
+     * @param pOffset the start offset of the data.
+     * @param pLength the number of bytes to read.
+     * @throws EOFException if this input stream reaches the end before
+     *                      reading all the bytes.
+     * @throws IOException  if an I/O error occurs.
+     * @see java.io.FilterInputStream#in
+     */
+    public final void readFully(byte pBytes[], int pOffset, int pLength) throws IOException {
+        if (pLength < 0) {
+            throw new IndexOutOfBoundsException();
+        }
+
+        int count = 0;
+
+        while (count < pLength) {
+            int read = in.read(pBytes, pOffset + count, pLength - count);
+
+            if (read < 0) {
+                throw new EOFException();
+            }
+
+            count += read;
+        }
+    }
+
+    /**
+     * See the general contract of the {@code readLine}
+     * method of {@code DataInput}.
+     * <p>
+     * Bytes for this operation are read from the contained input stream.
+     *
+     * @deprecated This method does not properly convert bytes to characters.
+     *
+     * @return     the next line of text from this input stream.
+     * @exception  IOException  if an I/O error occurs.
+     * @see        java.io.BufferedReader#readLine()
+     * @see        java.io.DataInputStream#readLine()
+     */
+    @Deprecated
+    public String readLine() throws IOException {
+        DataInputStream ds = new DataInputStream(in);
+        return ds.readLine();
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/LittleEndianDataOutputStream.java

@@ -1,341 +1,342 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-/*
- * From http://www.cafeaulait.org/books/javaio/ioexamples/index.html:
- *
- * Please feel free to use any fragment of this code you need in your own work.
- * As far as I am concerned, it's in the public domain. No permission is necessary
- * or required.  Credit is always appreciated if you use a large chunk or base a
- * significant product on one of my examples, but that's not required either.
- *
- * Elliotte Rusty Harold
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.Validate;
-
-import java.io.*;
-
-/**
- * A little endian output stream writes primitive Java numbers
- * and characters to an output stream in a little endian format.
- * <p/>
- * The standard {@code java.io.DataOutputStream} class which this class
- * imitates uses big endian integers.
- * <p/>
- * <em>Warning:
- * <!-- Beware of little indians! -->
- * The {@code DataInput} and {@code DataOutput} interfaces
- * specifies big endian byte order in their documentation.
- * This means that this class is, strictly speaking, not a proper
- * implementation. However, I don't see a reason for the these interfaces to
- * specify the byte order of their underlying representations.
- * </em>
- *
- * @see com.twelvemonkeys.io.LittleEndianRandomAccessFile
- * @see java.io.DataOutputStream
- * @see java.io.DataInput
- * @see java.io.DataOutput
- *
- * @author Elliotte Rusty Harold
- * @version 1.0.1, 19 May 1999
- */
-public class LittleEndianDataOutputStream extends FilterOutputStream implements DataOutput {
-
-    /**
-     * The number of bytes written so far to the little endian output stream.
-     */
-    protected int bytesWritten;
-
-    /**
-     * Creates a new little endian output stream and chains it to the
-     * output stream specified by the {@code pStream} argument.
-     *
-     * @param pStream the underlying output stream.
-     * @see java.io.FilterOutputStream#out
-     */
-    public LittleEndianDataOutputStream(OutputStream pStream) {
-        super(Validate.notNull(pStream, "stream"));
-    }
-
-    /**
-     * Writes the specified byte value to the underlying output stream.
-     *
-     * @param pByte the {@code byte} value to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public synchronized void write(int pByte) throws IOException {
-        out.write(pByte);
-        bytesWritten++;
-    }
-
-    /**
-     * Writes {@code pLength} bytes from the specified byte array
-     * starting at {@code pOffset} to the underlying output stream.
-     *
-     * @param pBytes   the data.
-     * @param pOffset the start offset in the data.
-     * @param pLength the number of bytes to write.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public synchronized void write(byte[] pBytes, int pOffset, int pLength) throws IOException {
-        out.write(pBytes, pOffset, pLength);
-        bytesWritten += pLength;
-    }
-
-
-    /**
-     * Writes a {@code boolean} to the underlying output stream as
-     * a single byte. If the argument is true, the byte value 1 is written.
-     * If the argument is false, the byte value {@code 0} in written.
-     *
-     * @param pBoolean the {@code boolean} value to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public void writeBoolean(boolean pBoolean) throws IOException {
-        if (pBoolean) {
-            write(1);
-        }
-        else {
-            write(0);
-        }
-    }
-
-    /**
-     * Writes out a {@code byte} to the underlying output stream
-     *
-     * @param pByte the {@code byte} value to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public void writeByte(int pByte) throws IOException {
-        out.write(pByte);
-        bytesWritten++;
-    }
-
-    /**
-     * Writes a two byte {@code short} to the underlying output stream in
-     * little endian order, low byte first.
-     *
-     * @param pShort the {@code short} to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public void writeShort(int pShort) throws IOException {
-        out.write(pShort & 0xFF);
-        out.write((pShort >>> 8) & 0xFF);
-        bytesWritten += 2;
-    }
-
-    /**
-     * Writes a two byte {@code char} to the underlying output stream
-     * in little endian order, low byte first.
-     *
-     * @param pChar the {@code char} value to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public void writeChar(int pChar) throws IOException {
-        out.write(pChar & 0xFF);
-        out.write((pChar >>> 8) & 0xFF);
-        bytesWritten += 2;
-    }
-
-    /**
-     * Writes a four-byte {@code int} to the underlying output stream
-     * in little endian order, low byte first, high byte last
-     *
-     * @param pInt the {@code int} to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public void writeInt(int pInt) throws IOException {
-        out.write(pInt & 0xFF);
-        out.write((pInt >>> 8) & 0xFF);
-        out.write((pInt >>> 16) & 0xFF);
-        out.write((pInt >>> 24) & 0xFF);
-        bytesWritten += 4;
-
-    }
-
-    /**
-     * Writes an eight-byte {@code long} to the underlying output stream
-     * in little endian order, low byte first, high byte last
-     *
-     * @param pLong the {@code long} to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     */
-    public void writeLong(long pLong) throws IOException {
-        out.write((int) pLong & 0xFF);
-        out.write((int) (pLong >>> 8) & 0xFF);
-        out.write((int) (pLong >>> 16) & 0xFF);
-        out.write((int) (pLong >>> 24) & 0xFF);
-        out.write((int) (pLong >>> 32) & 0xFF);
-        out.write((int) (pLong >>> 40) & 0xFF);
-        out.write((int) (pLong >>> 48) & 0xFF);
-        out.write((int) (pLong >>> 56) & 0xFF);
-        bytesWritten += 8;
-    }
-
-    /**
-     * Writes a 4 byte Java float to the underlying output stream in
-     * little endian order.
-     *
-     * @param f the {@code float} value to be written.
-     * @throws IOException if an I/O error occurs.
-     */
-    public final void writeFloat(float f) throws IOException {
-        writeInt(Float.floatToIntBits(f));
-    }
-
-    /**
-     * Writes an 8 byte Java double to the underlying output stream in
-     * little endian order.
-     *
-     * @param d the {@code double} value to be written.
-     * @throws IOException if an I/O error occurs.
-     */
-    public final void writeDouble(double d) throws IOException {
-        writeLong(Double.doubleToLongBits(d));
-    }
-
-    /**
-     * Writes a string to the underlying output stream as a sequence of
-     * bytes. Each character is written to the data output stream as
-     * if by the {@link #writeByte(int)} method.
-     *
-     * @param pString the {@code String} value to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     * @see #writeByte(int)
-     * @see #out
-     */
-    public void writeBytes(String pString) throws IOException {
-        int length = pString.length();
-
-        for (int i = 0; i < length; i++) {
-            out.write((byte) pString.charAt(i));
-        }
-
-        bytesWritten += length;
-    }
-
-    /**
-     * Writes a string to the underlying output stream as a sequence of
-     * characters. Each character is written to the data output stream as
-     * if by the {@code writeChar} method.
-     *
-     * @param pString a {@code String} value to be written.
-     * @throws IOException if the underlying stream throws an IOException.
-     * @see #writeChar(int)
-     * @see #out
-     */
-    public void writeChars(String pString) throws IOException {
-        int length = pString.length();
-
-        for (int i = 0; i < length; i++) {
-            int c = pString.charAt(i);
-            out.write(c & 0xFF);
-            out.write((c >>> 8) & 0xFF);
-        }
-
-        bytesWritten += length * 2;
-    }
-
-    /**
-     * Writes a string of no more than 65,535 characters
-     * to the underlying output stream using UTF-8
-     * encoding. This method first writes a two byte short
-     * in <b>big</b> endian order as required by the
-     * UTF-8 specification. This gives the number of bytes in the
-     * UTF-8 encoded version of the string, not the number of characters
-     * in the string. Next each character of the string is written
-     * using the UTF-8 encoding for the character.
-     *
-     * @param pString the string to be written.
-     * @throws UTFDataFormatException if the string is longer than
-     *                                65,535 characters.
-     * @throws IOException            if the underlying stream throws an IOException.
-     */
-    public void writeUTF(String pString) throws IOException {
-        int numchars = pString.length();
-        int numbytes = 0;
-
-        for (int i = 0; i < numchars; i++) {
-            int c = pString.charAt(i);
-
-            if ((c >= 0x0001) && (c <= 0x007F)) {
-                numbytes++;
-            }
-            else if (c > 0x07FF) {
-                numbytes += 3;
-            }
-            else {
-                numbytes += 2;
-            }
-        }
-
-        if (numbytes > 65535) {
-            throw new UTFDataFormatException();
-        }
-
-        out.write((numbytes >>> 8) & 0xFF);
-        out.write(numbytes & 0xFF);
-
-        for (int i = 0; i < numchars; i++) {
-            int c = pString.charAt(i);
-
-            if ((c >= 0x0001) && (c <= 0x007F)) {
-                out.write(c);
-            }
-            else if (c > 0x07FF) {
-                out.write(0xE0 | ((c >> 12) & 0x0F));
-                out.write(0x80 | ((c >> 6) & 0x3F));
-                out.write(0x80 | (c & 0x3F));
-                bytesWritten += 2;
-            }
-            else {
-                out.write(0xC0 | ((c >> 6) & 0x1F));
-                out.write(0x80 | (c & 0x3F));
-                bytesWritten += 1;
-            }
-        }
-
-        bytesWritten += numchars + 2;
-    }
-
-    /**
-     * Returns the number of bytes written to this little endian output stream.
-     * (This class is not thread-safe with respect to this method. It is
-     * possible that this number is temporarily less than the actual
-     * number of bytes written.)
-     * @return the value of the {@code written} field.
-     * @see     #bytesWritten
-     */
-    public int size() {
-        return bytesWritten;
-  }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+/*
+ * From http://www.cafeaulait.org/books/javaio/ioexamples/index.html:
+ *
+ * Please feel free to use any fragment of this code you need in your own work.
+ * As far as I am concerned, it's in the public domain. No permission is necessary
+ * or required.  Credit is always appreciated if you use a large chunk or base a
+ * significant product on one of my examples, but that's not required either.
+ *
+ * Elliotte Rusty Harold
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.Validate;
+
+import java.io.*;
+
+/**
+ * A little endian output stream writes primitive Java numbers
+ * and characters to an output stream in a little endian format.
+ * <p>
+ * The standard {@code java.io.DataOutputStream} class which this class
+ * imitates uses big endian integers.
+ * </p>
+ * <p>
+ * <em>Warning:
+ * The {@code DataInput} and {@code DataOutput} interfaces
+ * specifies big endian byte order in their documentation.
+ * This means that this class is, strictly speaking, not a proper
+ * implementation. However, I don't see a reason for the these interfaces to
+ * specify the byte order of their underlying representations.
+ * </em>
+ * <p>
+ *
+ * @see com.twelvemonkeys.io.LittleEndianRandomAccessFile
+ * @see java.io.DataOutputStream
+ * @see java.io.DataInput
+ * @see java.io.DataOutput
+ *
+ * @author Elliotte Rusty Harold
+ * @version 1.0.1, 19 May 1999
+ */
+public class LittleEndianDataOutputStream extends FilterOutputStream implements DataOutput {
+
+    /**
+     * The number of bytes written so far to the little endian output stream.
+     */
+    protected int bytesWritten;
+
+    /**
+     * Creates a new little endian output stream and chains it to the
+     * output stream specified by the {@code pStream} argument.
+     *
+     * @param pStream the underlying output stream.
+     * @see java.io.FilterOutputStream#out
+     */
+    public LittleEndianDataOutputStream(OutputStream pStream) {
+        super(Validate.notNull(pStream, "stream"));
+    }
+
+    /**
+     * Writes the specified byte value to the underlying output stream.
+     *
+     * @param pByte the {@code byte} value to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public synchronized void write(int pByte) throws IOException {
+        out.write(pByte);
+        bytesWritten++;
+    }
+
+    /**
+     * Writes {@code pLength} bytes from the specified byte array
+     * starting at {@code pOffset} to the underlying output stream.
+     *
+     * @param pBytes   the data.
+     * @param pOffset the start offset in the data.
+     * @param pLength the number of bytes to write.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public synchronized void write(byte[] pBytes, int pOffset, int pLength) throws IOException {
+        out.write(pBytes, pOffset, pLength);
+        bytesWritten += pLength;
+    }
+
+
+    /**
+     * Writes a {@code boolean} to the underlying output stream as
+     * a single byte. If the argument is true, the byte value 1 is written.
+     * If the argument is false, the byte value {@code 0} in written.
+     *
+     * @param pBoolean the {@code boolean} value to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public void writeBoolean(boolean pBoolean) throws IOException {
+        if (pBoolean) {
+            write(1);
+        }
+        else {
+            write(0);
+        }
+    }
+
+    /**
+     * Writes out a {@code byte} to the underlying output stream
+     *
+     * @param pByte the {@code byte} value to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public void writeByte(int pByte) throws IOException {
+        out.write(pByte);
+        bytesWritten++;
+    }
+
+    /**
+     * Writes a two byte {@code short} to the underlying output stream in
+     * little endian order, low byte first.
+     *
+     * @param pShort the {@code short} to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public void writeShort(int pShort) throws IOException {
+        out.write(pShort & 0xFF);
+        out.write((pShort >>> 8) & 0xFF);
+        bytesWritten += 2;
+    }
+
+    /**
+     * Writes a two byte {@code char} to the underlying output stream
+     * in little endian order, low byte first.
+     *
+     * @param pChar the {@code char} value to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public void writeChar(int pChar) throws IOException {
+        out.write(pChar & 0xFF);
+        out.write((pChar >>> 8) & 0xFF);
+        bytesWritten += 2;
+    }
+
+    /**
+     * Writes a four-byte {@code int} to the underlying output stream
+     * in little endian order, low byte first, high byte last
+     *
+     * @param pInt the {@code int} to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public void writeInt(int pInt) throws IOException {
+        out.write(pInt & 0xFF);
+        out.write((pInt >>> 8) & 0xFF);
+        out.write((pInt >>> 16) & 0xFF);
+        out.write((pInt >>> 24) & 0xFF);
+        bytesWritten += 4;
+
+    }
+
+    /**
+     * Writes an eight-byte {@code long} to the underlying output stream
+     * in little endian order, low byte first, high byte last
+     *
+     * @param pLong the {@code long} to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     */
+    public void writeLong(long pLong) throws IOException {
+        out.write((int) pLong & 0xFF);
+        out.write((int) (pLong >>> 8) & 0xFF);
+        out.write((int) (pLong >>> 16) & 0xFF);
+        out.write((int) (pLong >>> 24) & 0xFF);
+        out.write((int) (pLong >>> 32) & 0xFF);
+        out.write((int) (pLong >>> 40) & 0xFF);
+        out.write((int) (pLong >>> 48) & 0xFF);
+        out.write((int) (pLong >>> 56) & 0xFF);
+        bytesWritten += 8;
+    }
+
+    /**
+     * Writes a 4 byte Java float to the underlying output stream in
+     * little endian order.
+     *
+     * @param f the {@code float} value to be written.
+     * @throws IOException if an I/O error occurs.
+     */
+    public final void writeFloat(float f) throws IOException {
+        writeInt(Float.floatToIntBits(f));
+    }
+
+    /**
+     * Writes an 8 byte Java double to the underlying output stream in
+     * little endian order.
+     *
+     * @param d the {@code double} value to be written.
+     * @throws IOException if an I/O error occurs.
+     */
+    public final void writeDouble(double d) throws IOException {
+        writeLong(Double.doubleToLongBits(d));
+    }
+
+    /**
+     * Writes a string to the underlying output stream as a sequence of
+     * bytes. Each character is written to the data output stream as
+     * if by the {@link #writeByte(int)} method.
+     *
+     * @param pString the {@code String} value to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     * @see #writeByte(int)
+     * @see #out
+     */
+    public void writeBytes(String pString) throws IOException {
+        int length = pString.length();
+
+        for (int i = 0; i < length; i++) {
+            out.write((byte) pString.charAt(i));
+        }
+
+        bytesWritten += length;
+    }
+
+    /**
+     * Writes a string to the underlying output stream as a sequence of
+     * characters. Each character is written to the data output stream as
+     * if by the {@code writeChar} method.
+     *
+     * @param pString a {@code String} value to be written.
+     * @throws IOException if the underlying stream throws an IOException.
+     * @see #writeChar(int)
+     * @see #out
+     */
+    public void writeChars(String pString) throws IOException {
+        int length = pString.length();
+
+        for (int i = 0; i < length; i++) {
+            int c = pString.charAt(i);
+            out.write(c & 0xFF);
+            out.write((c >>> 8) & 0xFF);
+        }
+
+        bytesWritten += length * 2;
+    }
+
+    /**
+     * Writes a string of no more than 65,535 characters
+     * to the underlying output stream using UTF-8
+     * encoding. This method first writes a two byte short
+     * in <b>big</b> endian order as required by the
+     * UTF-8 specification. This gives the number of bytes in the
+     * UTF-8 encoded version of the string, not the number of characters
+     * in the string. Next each character of the string is written
+     * using the UTF-8 encoding for the character.
+     *
+     * @param pString the string to be written.
+     * @throws UTFDataFormatException if the string is longer than
+     *                                65,535 characters.
+     * @throws IOException            if the underlying stream throws an IOException.
+     */
+    public void writeUTF(String pString) throws IOException {
+        int numchars = pString.length();
+        int numbytes = 0;
+
+        for (int i = 0; i < numchars; i++) {
+            int c = pString.charAt(i);
+
+            if ((c >= 0x0001) && (c <= 0x007F)) {
+                numbytes++;
+            }
+            else if (c > 0x07FF) {
+                numbytes += 3;
+            }
+            else {
+                numbytes += 2;
+            }
+        }
+
+        if (numbytes > 65535) {
+            throw new UTFDataFormatException();
+        }
+
+        out.write((numbytes >>> 8) & 0xFF);
+        out.write(numbytes & 0xFF);
+
+        for (int i = 0; i < numchars; i++) {
+            int c = pString.charAt(i);
+
+            if ((c >= 0x0001) && (c <= 0x007F)) {
+                out.write(c);
+            }
+            else if (c > 0x07FF) {
+                out.write(0xE0 | ((c >> 12) & 0x0F));
+                out.write(0x80 | ((c >> 6) & 0x3F));
+                out.write(0x80 | (c & 0x3F));
+                bytesWritten += 2;
+            }
+            else {
+                out.write(0xC0 | ((c >> 6) & 0x1F));
+                out.write(0x80 | (c & 0x3F));
+                bytesWritten += 1;
+            }
+        }
+
+        bytesWritten += numchars + 2;
+    }
+
+    /**
+     * Returns the number of bytes written to this little endian output stream.
+     * (This class is not thread-safe with respect to this method. It is
+     * possible that this number is temporarily less than the actual
+     * number of bytes written.)
+     * @return the value of the {@code written} field.
+     * @see     #bytesWritten
+     */
+    public int size() {
+        return bytesWritten;
+  }
 }

common/common-io/src/main/java/com/twelvemonkeys/io/MemoryCacheSeekableStream.java

@@ -1,193 +1,197 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * A {@code SeekableInputStream} implementation that caches data in memory.
- * <p/>
- *
- * @see FileCacheSeekableStream
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/MemoryCacheSeekableStream.java#3 $
- */
-public final class MemoryCacheSeekableStream extends AbstractCachedSeekableStream {
-
-    /**
-     * Creates a {@code MemoryCacheSeekableStream}, reading from the given
-     * {@code InputStream}. Data will be cached in memory.
-     *
-     * @param pStream the {@code InputStream} to read from.
-     */
-    public MemoryCacheSeekableStream(final InputStream pStream) {
-        super(pStream, new MemoryCache());
-    }
-
-    public final boolean isCachedMemory() {
-        return true;
-    }
-
-    public final boolean isCachedFile() {
-        return false;
-    }
-
-    final static class MemoryCache extends StreamCache {
-        final static int BLOCK_SIZE = 1 << 13;
-
-        private final List<byte[]> cache = new ArrayList<byte[]>();
-        private long length;
-        private long position;
-        private long start;
-
-        private byte[] getBlock() throws IOException {
-            final long currPos = position - start;
-            if (currPos < 0) {
-                throw new IOException("StreamCache flushed before read position");
-            }
-
-            long index = currPos / BLOCK_SIZE;
-
-            if (index >= Integer.MAX_VALUE) {
-                throw new IOException("Memory cache max size exceeded");
-            }
-
-            if (index >= cache.size()) {
-                try {
-                    cache.add(new byte[BLOCK_SIZE]);
-//                    System.out.println("Allocating new block, size: " + BLOCK_SIZE);
-//                    System.out.println("New total size: " + cache.size() * BLOCK_SIZE + " (" + cache.size() + " blocks)");
-                }
-                catch (OutOfMemoryError e) {
-                    throw new IOException("No more memory for cache: " + cache.size() * BLOCK_SIZE);
-                }
-            }
-
-            //System.out.println("index: " + index);
-
-            return cache.get((int) index);
-        }
-
-        public void write(final int pByte) throws IOException {
-            byte[] buffer = getBlock();
-
-            int idx = (int) (position % BLOCK_SIZE);
-            buffer[idx] = (byte) pByte;
-            position++;
-
-            if (position > length) {
-                length = position;
-            }
-        }
-
-        // TODO: OptimizeMe!!!
-        @Override
-        public void write(final byte[] pBuffer, final int pOffset, final int pLength) throws IOException {
-            byte[] buffer = getBlock();
-            for (int i = 0; i < pLength; i++) {
-                int index = (int) position % BLOCK_SIZE;
-                if (index == 0) {
-                    buffer = getBlock();
-                }
-                buffer[index] = pBuffer[pOffset + i];
-
-                position++;
-            }
-            if (position > length) {
-                length = position;
-            }
-        }
-
-        public int read() throws IOException {
-            if (position >= length) {
-                return -1;
-            }
-
-            byte[] buffer = getBlock();
-
-            int idx = (int) (position % BLOCK_SIZE);
-            position++;
-
-            return buffer[idx] & 0xff;
-        }
-
-        // TODO: OptimizeMe!!!
-        @Override
-        public int read(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
-            if (position >= length) {
-                return -1;
-            }
-
-            byte[] buffer = getBlock();
-
-            int bufferPos = (int) (position % BLOCK_SIZE);
-
-            // Find maxIdx and simplify test in for-loop
-            int maxLen = (int) Math.min(Math.min(pLength, buffer.length - bufferPos), length - position);
-
-            int i;
-            //for (i = 0; i < pLength && i < buffer.length - idx && i < length - position; i++) {
-            for (i = 0; i < maxLen; i++) {
-                pBytes[pOffset + i] = buffer[bufferPos + i];
-            }
-
-            position += i;
-
-            return i;
-        }
-
-        public void seek(final long pPosition) throws IOException {
-            if (pPosition < start) {
-                throw new IOException("Seek before flush position");
-            }
-            position = pPosition;
-        }
-
-        @Override
-        public void flush(final long pPosition) {
-            int firstPos = (int) (pPosition / BLOCK_SIZE) - 1;
-
-            for (int i = 0; i < firstPos; i++) {
-                cache.remove(0);
-            }
-
-            start = pPosition;
-        }
-
-        public long getPosition() {
-            return position;
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A {@code SeekableInputStream} implementation that caches data in memory.
+ *
+ * @see FileCacheSeekableStream
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/MemoryCacheSeekableStream.java#3 $
+ */
+public final class MemoryCacheSeekableStream extends AbstractCachedSeekableStream {
+
+    /**
+     * Creates a {@code MemoryCacheSeekableStream}, reading from the given
+     * {@code InputStream}. Data will be cached in memory.
+     *
+     * @param pStream the {@code InputStream} to read from.
+     */
+    public MemoryCacheSeekableStream(final InputStream pStream) {
+        super(pStream, new MemoryCache());
+    }
+
+    public final boolean isCachedMemory() {
+        return true;
+    }
+
+    public final boolean isCachedFile() {
+        return false;
+    }
+
+    final static class MemoryCache extends StreamCache {
+        final static int BLOCK_SIZE = 1 << 13;
+
+        private final List<byte[]> cache = new ArrayList<>();
+        private long length;
+        private long position;
+        private long start;
+
+        private byte[] getBlock() throws IOException {
+            final long currPos = position - start;
+            if (currPos < 0) {
+                throw new IOException("StreamCache flushed before read position");
+            }
+
+            long index = currPos / BLOCK_SIZE;
+
+            if (index >= Integer.MAX_VALUE) {
+                throw new IOException("Memory cache max size exceeded");
+            }
+
+            if (index >= cache.size()) {
+                try {
+                    cache.add(new byte[BLOCK_SIZE]);
+//                    System.out.println("Allocating new block, size: " + BLOCK_SIZE);
+//                    System.out.println("New total size: " + cache.size() * BLOCK_SIZE + " (" + cache.size() + " blocks)");
+                }
+                catch (OutOfMemoryError e) {
+                    throw new IOException("No more memory for cache: " + cache.size() * BLOCK_SIZE);
+                }
+            }
+
+            //System.out.println("index: " + index);
+
+            return cache.get((int) index);
+        }
+
+        public void write(final int pByte) throws IOException {
+            byte[] buffer = getBlock();
+
+            int idx = (int) (position % BLOCK_SIZE);
+            buffer[idx] = (byte) pByte;
+            position++;
+
+            if (position > length) {
+                length = position;
+            }
+        }
+
+        // TODO: OptimizeMe!!!
+        @Override
+        public void write(final byte[] pBuffer, final int pOffset, final int pLength) throws IOException {
+            byte[] buffer = getBlock();
+            for (int i = 0; i < pLength; i++) {
+                int index = (int) position % BLOCK_SIZE;
+                if (index == 0) {
+                    buffer = getBlock();
+                }
+                buffer[index] = pBuffer[pOffset + i];
+
+                position++;
+            }
+            if (position > length) {
+                length = position;
+            }
+        }
+
+        public int read() throws IOException {
+            if (position >= length) {
+                return -1;
+            }
+
+            byte[] buffer = getBlock();
+
+            int idx = (int) (position % BLOCK_SIZE);
+            position++;
+
+            return buffer[idx] & 0xff;
+        }
+
+        // TODO: OptimizeMe!!!
+        @Override
+        public int read(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
+            if (position >= length) {
+                return -1;
+            }
+
+            byte[] buffer = getBlock();
+
+            int bufferPos = (int) (position % BLOCK_SIZE);
+
+            // Find maxIdx and simplify test in for-loop
+            int maxLen = (int) Math.min(Math.min(pLength, buffer.length - bufferPos), length - position);
+
+            int i;
+            //for (i = 0; i < pLength && i < buffer.length - idx && i < length - position; i++) {
+            for (i = 0; i < maxLen; i++) {
+                pBytes[pOffset + i] = buffer[bufferPos + i];
+            }
+
+            position += i;
+
+            return i;
+        }
+
+        public void seek(final long pPosition) throws IOException {
+            if (pPosition < start) {
+                throw new IOException("Seek before flush position");
+            }
+            position = pPosition;
+        }
+
+        @Override
+        public void flush(final long pPosition) {
+            int firstPos = (int) (pPosition / BLOCK_SIZE) - 1;
+
+            for (int i = 0; i < firstPos; i++) {
+                cache.remove(0);
+            }
+
+            start = pPosition;
+        }
+
+        @Override
+        void close() throws IOException {
+            cache.clear();
+        }
+
+        public long getPosition() {
+            return position;
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/NullInputStream.java

@@ -1,82 +1,81 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.IOException;
-import java.io.InputStream;
-
-/**
- * An {@code InputStream} that contains no bytes.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/NullInputStream.java#2 $
- */
-public class NullInputStream extends InputStream {
-
-    /**
-     * Creates a {@code NullInputStream}.
-     */
-    public NullInputStream() {
-    }
-
-    /**
-     * This implementation returns {@code -1} (EOF), always.
-     *
-     * @return {@code -1}
-     * @throws IOException
-     */
-    public int read() throws IOException {
-        return -1;
-    }
-
-    /**
-     * This implementation returns {@code 0}, always.
-     *
-     * @return {@code 0}
-     * @throws IOException
-     */
-    @Override
-    public int available() throws IOException {
-        return 0;
-    }
-
-    /**
-     * This implementation returns {@code 0}, always.
-     *
-     * @return {@code 0}
-     * @throws IOException
-     */
-    @Override
-    public long skip(long pOffset) throws IOException {
-        return 0l;
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * An {@code InputStream} that contains no bytes.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/NullInputStream.java#2 $
+ */
+public class NullInputStream extends InputStream {
+
+    /**
+     * Creates a {@code NullInputStream}.
+     */
+    public NullInputStream() {
+    }
+
+    /**
+     * This implementation returns {@code -1} (EOF), always.
+     *
+     * @return {@code -1}
+     * @throws IOException
+     */
+    public int read() throws IOException {
+        return -1;
+    }
+
+    /**
+     * This implementation returns {@code 0}, always.
+     *
+     * @return {@code 0}
+     * @throws IOException
+     */
+    @Override
+    public int available() throws IOException {
+        return 0;
+    }
+
+    /**
+     * This implementation returns {@code 0}, always.
+     *
+     * @return {@code 0}
+     * @throws IOException
+     */
+    @Override
+    public long skip(long pOffset) throws IOException {
+        return 0l;
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/NullOutputStream.java

@@ -1,70 +1,69 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.IOException;
-import java.io.OutputStream;
-
-/**
- * An {@code OutputStream} implementation that works as a sink.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/NullOutputStream.java#2 $
- */
-public class NullOutputStream extends OutputStream {
-
-    /**
-     * Creates a {@code NullOutputStream}.
-     */
-    public NullOutputStream() {
-    }
-
-    /**
-     * This implementation does nothing.
-     */
-    public void write(int pByte) throws IOException {
-    }
-
-    /**
-     * This implementation does nothing.
-     */
-    @Override
-    public void write(byte pBytes[]) throws IOException {
-    }
-
-    /**
-     * This implementation does nothing.
-     */
-    @Override
-    public void write(byte pBytes[], int pOffset, int pLength) throws IOException {
-    }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * An {@code OutputStream} implementation that works as a sink.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/NullOutputStream.java#2 $
+ */
+public class NullOutputStream extends OutputStream {
+
+    /**
+     * Creates a {@code NullOutputStream}.
+     */
+    public NullOutputStream() {
+    }
+
+    /**
+     * This implementation does nothing.
+     */
+    public void write(int pByte) throws IOException {
+    }
+
+    /**
+     * This implementation does nothing.
+     */
+    @Override
+    public void write(byte pBytes[]) throws IOException {
+    }
+
+    /**
+     * This implementation does nothing.
+     */
+    @Override
+    public void write(byte pBytes[], int pOffset, int pLength) throws IOException {
+    }
 }

common/common-io/src/main/java/com/twelvemonkeys/io/RandomAccessStream.java

@@ -1,241 +1,242 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.DataInput;
-import java.io.DataOutput;
-import java.io.EOFException;
-import java.io.IOException;
-
-/**
- * A data stream that is both readable and writable, much like a
- * {@code RandomAccessFile}, except it may be backed by something other than a file.
- * <p/>
- *
- * @see java.io.RandomAccessFile
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/RandomAccessStream.java#3 $
- */
-public abstract class RandomAccessStream implements Seekable, DataInput, DataOutput {
-    // TODO: Use a RandomAcceessFile as backing in impl, probably
-    // TODO: Create an in-memory implementation too?
-    // TODO: Package private SeekableDelegate?
-
-    // TODO: Both read and write must update stream position
-    //private int position = -1;
-
-    /** This random access stream, wrapped in an {@code InputStream} */
-    SeekableInputStream inputView = null;
-    /** This random access stream, wrapped in an {@code OutputStream} */
-    SeekableOutputStream outputView = null;
-
-    // TODO: Create an Input and an Output interface matching InputStream and OutputStream?
-    public int read() throws IOException {
-        try {
-            return readByte() & 0xff;
-        }
-        catch (EOFException e) {
-            return -1;
-        }
-    }
-
-    public int read(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
-        if (pBytes == null) {
-            throw new NullPointerException("bytes == null");
-        }
-        else if ((pOffset < 0) || (pOffset > pBytes.length) || (pLength < 0) ||
-                ((pOffset + pLength) > pBytes.length) || ((pOffset + pLength) < 0)) {
-            throw new IndexOutOfBoundsException();
-        }
-        else if (pLength == 0) {
-            return 0;
-        }
-
-        // Special case, allready at EOF
-        int c = read();
-        if (c == -1) {
-            return -1;
-        }
-
-        // Otherwise, read as many as bytes as possible
-        pBytes[pOffset] = (byte) c;
-
-        int i = 1;
-        try {
-            for (; i < pLength; i++) {
-                c = read();
-                if (c == -1) {
-                    break;
-                }
-                pBytes[pOffset + i] = (byte) c;
-            }
-        }
-        catch (IOException ignore) {
-            // Ignore exception, just return length
-        }
-
-        return i;
-    }
-
-    public final int read(byte[] pBytes) throws IOException {
-        return read(pBytes, 0, pBytes != null ? pBytes.length : 1);
-    }
-
-    /**
-     * Returns an input view of this {@code RandomAccessStream}.
-     * Invoking this method several times, will return the same object.
-     * <p/>
-     * <em>Note that read access is NOT synchronized.</em>
-     *
-     * @return a {@code SeekableInputStream} reading from this stream
-     */
-    public final SeekableInputStream asInputStream() {
-        if (inputView == null) {
-             inputView = new InputStreamView(this);
-        }
-        return inputView;
-    }
-
-    /**
-     * Returns an output view of this {@code RandomAccessStream}.
-     * Invoking this method several times, will return the same object.
-     * <p/>
-     * <em>Note that write access is NOT synchronized.</em>
-     *
-     * @return a {@code SeekableOutputStream} writing to this stream
-     */
-    public final SeekableOutputStream asOutputStream() {
-        if (outputView == null) {
-            outputView = new OutputStreamView(this);
-        }
-        return outputView;
-    }
-
-    static final class InputStreamView extends SeekableInputStream {
-        // TODO: Consider adding synchonization (on stream) for all operations
-        // TODO: Is is a good thing that close/flush etc works on stream?
-        //  - Or should it rather just work on the views?
-        //  - Allow multiple views?
-
-        final private RandomAccessStream mStream;
-
-        public InputStreamView(RandomAccessStream pStream) {
-            if (pStream == null) {
-                throw new IllegalArgumentException("stream == null");
-            }
-            mStream = pStream;
-        }
-
-        public boolean isCached() {
-            return mStream.isCached();
-        }
-
-        public boolean isCachedFile() {
-            return mStream.isCachedFile();
-        }
-
-        public boolean isCachedMemory() {
-            return mStream.isCachedMemory();
-        }
-
-        protected void closeImpl() throws IOException {
-            mStream.close();
-        }
-
-        protected void flushBeforeImpl(long pPosition) throws IOException {
-            mStream.flushBefore(pPosition);
-        }
-
-        protected void seekImpl(long pPosition) throws IOException {
-            mStream.seek(pPosition);
-        }
-
-        public int read() throws IOException {
-            return mStream.read();
-        }
-
-        @Override
-        public int read(byte pBytes[], int pOffset, int pLength) throws IOException {
-            return mStream.read(pBytes, pOffset, pLength);
-        }
-    }
-
-    static final class OutputStreamView extends SeekableOutputStream {
-        // TODO: Consider adding synchonization (on stream) for all operations
-        // TODO: Is is a good thing that close/flush etc works on stream?
-        //  - Or should it rather just work on the views?
-        //  - Allow multiple views?
-
-        final private RandomAccessStream mStream;
-
-        public OutputStreamView(RandomAccessStream pStream) {
-            if (pStream == null) {
-                throw new IllegalArgumentException("stream == null");
-            }
-            mStream = pStream;
-        }
-
-        public boolean isCached() {
-            return mStream.isCached();
-        }
-
-        public boolean isCachedFile() {
-            return mStream.isCachedFile();
-        }
-
-        public boolean isCachedMemory() {
-            return mStream.isCachedMemory();
-        }
-
-        protected void closeImpl() throws IOException {
-            mStream.close();
-        }
-
-        protected void flushBeforeImpl(long pPosition) throws IOException {
-            mStream.flushBefore(pPosition);
-        }
-
-        protected void seekImpl(long pPosition) throws IOException {
-            mStream.seek(pPosition);
-        }
-
-        public void write(int pByte) throws IOException {
-            mStream.write(pByte);
-        }
-
-        @Override
-        public void write(byte pBytes[], int pOffset, int pLength) throws IOException {
-            mStream.write(pBytes, pOffset, pLength);
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.EOFException;
+import java.io.IOException;
+
+/**
+ * A data stream that is both readable and writable, much like a
+ * {@code RandomAccessFile}, except it may be backed by something other than a file.
+ *
+ * @see java.io.RandomAccessFile
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/RandomAccessStream.java#3 $
+ */
+public abstract class RandomAccessStream implements Seekable, DataInput, DataOutput {
+    // TODO: Use a RandomAcceessFile as backing in impl, probably
+    // TODO: Create an in-memory implementation too?
+    // TODO: Package private SeekableDelegate?
+
+    // TODO: Both read and write must update stream position
+    //private int position = -1;
+
+    /** This random access stream, wrapped in an {@code InputStream} */
+    SeekableInputStream inputView = null;
+    /** This random access stream, wrapped in an {@code OutputStream} */
+    SeekableOutputStream outputView = null;
+
+    // TODO: Create an Input and an Output interface matching InputStream and OutputStream?
+    public int read() throws IOException {
+        try {
+            return readByte() & 0xff;
+        }
+        catch (EOFException e) {
+            return -1;
+        }
+    }
+
+    public int read(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
+        if (pBytes == null) {
+            throw new NullPointerException("bytes == null");
+        }
+        else if ((pOffset < 0) || (pOffset > pBytes.length) || (pLength < 0) ||
+                ((pOffset + pLength) > pBytes.length) || ((pOffset + pLength) < 0)) {
+            throw new IndexOutOfBoundsException();
+        }
+        else if (pLength == 0) {
+            return 0;
+        }
+
+        // Special case, allready at EOF
+        int c = read();
+        if (c == -1) {
+            return -1;
+        }
+
+        // Otherwise, read as many as bytes as possible
+        pBytes[pOffset] = (byte) c;
+
+        int i = 1;
+        try {
+            for (; i < pLength; i++) {
+                c = read();
+                if (c == -1) {
+                    break;
+                }
+                pBytes[pOffset + i] = (byte) c;
+            }
+        }
+        catch (IOException ignore) {
+            // Ignore exception, just return length
+        }
+
+        return i;
+    }
+
+    public final int read(byte[] pBytes) throws IOException {
+        return read(pBytes, 0, pBytes != null ? pBytes.length : 1);
+    }
+
+    /**
+     * Returns an input view of this {@code RandomAccessStream}.
+     * Invoking this method several times, will return the same object.
+     * <p>
+     * <em>Note that read access is NOT synchronized.</em>
+     * </p>
+     *
+     * @return a {@code SeekableInputStream} reading from this stream
+     */
+    public final SeekableInputStream asInputStream() {
+        if (inputView == null) {
+             inputView = new InputStreamView(this);
+        }
+        return inputView;
+    }
+
+    /**
+     * Returns an output view of this {@code RandomAccessStream}.
+     * Invoking this method several times, will return the same object.
+     * <p>
+     * <em>Note that write access is NOT synchronized.</em>
+     * </p>
+     *
+     * @return a {@code SeekableOutputStream} writing to this stream
+     */
+    public final SeekableOutputStream asOutputStream() {
+        if (outputView == null) {
+            outputView = new OutputStreamView(this);
+        }
+        return outputView;
+    }
+
+    static final class InputStreamView extends SeekableInputStream {
+        // TODO: Consider adding synchonization (on stream) for all operations
+        // TODO: Is is a good thing that close/flush etc works on stream?
+        //  - Or should it rather just work on the views?
+        //  - Allow multiple views?
+
+        final private RandomAccessStream mStream;
+
+        public InputStreamView(RandomAccessStream pStream) {
+            if (pStream == null) {
+                throw new IllegalArgumentException("stream == null");
+            }
+            mStream = pStream;
+        }
+
+        public boolean isCached() {
+            return mStream.isCached();
+        }
+
+        public boolean isCachedFile() {
+            return mStream.isCachedFile();
+        }
+
+        public boolean isCachedMemory() {
+            return mStream.isCachedMemory();
+        }
+
+        protected void closeImpl() throws IOException {
+            mStream.close();
+        }
+
+        protected void flushBeforeImpl(long pPosition) throws IOException {
+            mStream.flushBefore(pPosition);
+        }
+
+        protected void seekImpl(long pPosition) throws IOException {
+            mStream.seek(pPosition);
+        }
+
+        public int read() throws IOException {
+            return mStream.read();
+        }
+
+        @Override
+        public int read(byte pBytes[], int pOffset, int pLength) throws IOException {
+            return mStream.read(pBytes, pOffset, pLength);
+        }
+    }
+
+    static final class OutputStreamView extends SeekableOutputStream {
+        // TODO: Consider adding synchonization (on stream) for all operations
+        // TODO: Is is a good thing that close/flush etc works on stream?
+        //  - Or should it rather just work on the views?
+        //  - Allow multiple views?
+
+        final private RandomAccessStream mStream;
+
+        public OutputStreamView(RandomAccessStream pStream) {
+            if (pStream == null) {
+                throw new IllegalArgumentException("stream == null");
+            }
+            mStream = pStream;
+        }
+
+        public boolean isCached() {
+            return mStream.isCached();
+        }
+
+        public boolean isCachedFile() {
+            return mStream.isCachedFile();
+        }
+
+        public boolean isCachedMemory() {
+            return mStream.isCachedMemory();
+        }
+
+        protected void closeImpl() throws IOException {
+            mStream.close();
+        }
+
+        protected void flushBeforeImpl(long pPosition) throws IOException {
+            mStream.flushBefore(pPosition);
+        }
+
+        protected void seekImpl(long pPosition) throws IOException {
+            mStream.seek(pPosition);
+        }
+
+        public void write(int pByte) throws IOException {
+            mStream.write(pByte);
+        }
+
+        @Override
+        public void write(byte pBytes[], int pOffset, int pLength) throws IOException {
+            mStream.write(pBytes, pOffset, pLength);
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/Seekable.java

@@ -1,186 +1,193 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.IOException;
-
-/**
- * Interface for seekable streams.
- * <p/>
- * @see SeekableInputStream
- * @see SeekableOutputStream
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Seekable.java#1 $
- */
-public interface Seekable {
-
-    /**
-     * Returns the current byte position of the stream. The next read will take
-     * place starting at this offset.
-     *
-     * @return a {@code long} containing the position of the stream.
-     * @throws IOException if an I/O error occurs.
-     */
-    long getStreamPosition() throws IOException;
-
-    /**
-     * Sets the current stream position to the desired location.
-     * The next read will occur at this location.
-     * <p/>
-     * An {@code IndexOutOfBoundsException} will be thrown if pPosition is smaller
-     * than the flushed position (as returned by {@link #getFlushedPosition()}).
-     * <p/>
-     * It is legal to seek past the end of the file; an {@code EOFException}
-     * will be thrown only if a read is performed.
-     *
-     * @param pPosition a long containing the desired file pointer position.
-     *
-     * @throws IndexOutOfBoundsException if {@code pPosition} is smaller than
-     * the flushed position.
-     * @throws IOException if any other I/O error occurs.
-     */
-    void seek(long pPosition) throws IOException;
-
-    /**
-     * Marks a position in the stream to be returned to by a subsequent call to
-     * reset.
-     * Unlike a standard {@code InputStream}, all {@code Seekable}
-     * streams upport marking. Additionally, calls to {@code mark} and
-     * {@code reset} may be nested arbitrarily.
-     * <p/>
-     * Unlike the {@code mark} methods declared by the {@code Reader} or
-     * {@code InputStream}
-     * interfaces, no {@code readLimit} parameter is used. An arbitrary amount
-     * of data may be read following the call to {@code mark}.
-     */
-    void mark();
-
-    /**
-     * Returns the file pointer to its previous position,
-     * at the time of the most recent unmatched call to mark.
-     * <p/>
-     * Calls to reset without a corresponding call to mark will either:
-     * <ul>
-     * <li>throw an {@code IOException}</li>
-     * <li>or, reset to the beginning of the stream.</li>
-     * </ul>
-     * An {@code IOException} will be thrown if the previous marked position
-     * lies in the discarded portion of the stream.
-     *
-     * @throws IOException if an I/O error occurs.
-     * @see java.io.InputStream#reset()
-     */
-    void reset() throws IOException;
-
-    /**
-     * Discards the initial portion of the stream prior to the indicated
-     * postion. Attempting to seek to an offset within the flushed portion of
-     * the stream will result in an {@code IndexOutOfBoundsException}.
-     * <p/>
-     * Calling {@code flushBefore} may allow classes implementing this
-     * interface to free up resources such as memory or disk space that are
-     * being used to store data from the stream.
-     *
-     * @param pPosition a long containing the length of the file prefix that
-     * may be flushed.
-     *
-     * @throws IndexOutOfBoundsException if {@code pPosition} lies in the
-     * flushed portion of the stream or past the current stream position.
-     * @throws IOException if an I/O error occurs.
-     */
-    void flushBefore(long pPosition) throws IOException;
-
-    /**
-     * Discards the initial position of the stream prior to the current stream
-     * position. Equivalent to {@code flushBefore(getStreamPosition())}.
-     *
-     * @throws IOException if an I/O error occurs.
-     */
-    void flush() throws IOException;
-
-    /**
-     * Returns the earliest position in the stream to which seeking may be
-     * performed. The returned value will be the maximum of all values passed
-     * into previous calls to {@code flushBefore}.
-     *
-     * @return the earliest legal position for seeking, as a {@code long}.
-     *
-     * @throws IOException if an I/O error occurs.
-     */
-    long getFlushedPosition() throws IOException;
-
-    /**
-     * Returns true if this {@code Seekable} stream caches data itself in order
-     * to allow seeking backwards. Applications may consult this in order to
-     * decide how frequently, or whether, to flush in order to conserve cache
-     * resources.
-     *
-     * @return {@code true} if this {@code Seekable} caches data.
-     * @see #isCachedMemory()
-     * @see #isCachedFile()
-     */
-    boolean isCached();
-
-    /**
-     * Returns true if this {@code Seekable} stream caches data itself in order
-     * to allow seeking backwards, and the cache is kept in main memory.
-     * Applications may consult this in order to decide how frequently, or
-     * whether, to flush in order to conserve cache resources.
-     *
-     * @return {@code true} if this {@code Seekable} caches data in main
-     * memory.
-     * @see #isCached()
-     * @see #isCachedFile()
-     */
-    boolean isCachedMemory();
-
-    /**
-     * Returns true if this {@code Seekable} stream caches data itself in
-     * order to allow seeking backwards, and the cache is kept in a
-     * temporary file.
-     * Applications may consult this in order to decide how frequently,
-     * or whether, to flush in order to conserve cache resources.
-     *
-     * @return {@code true} if this {@code Seekable} caches data in a
-     * temporary file.
-     * @see #isCached
-     * @see #isCachedMemory
-     */
-    boolean isCachedFile();
-
-    /**
-     * Closes the stream.
-     *
-     * @throws java.io.IOException if the stream can't be closed.
-     */
-    void close() throws IOException;
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.IOException;
+
+/**
+ * Interface for seekable streams.
+ *
+ * @see SeekableInputStream
+ * @see SeekableOutputStream
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Seekable.java#1 $
+ */
+public interface Seekable {
+
+    /**
+     * Returns the current byte position of the stream. The next read will take
+     * place starting at this offset.
+     *
+     * @return a {@code long} containing the position of the stream.
+     * @throws IOException if an I/O error occurs.
+     */
+    long getStreamPosition() throws IOException;
+
+    /**
+     * Sets the current stream position to the desired location.
+     * The next read will occur at this location.
+     * <p>
+     * An {@code IndexOutOfBoundsException} will be thrown if pPosition is smaller
+     * than the flushed position (as returned by {@link #getFlushedPosition()}).
+     * </p>
+     * <p>
+     * It is legal to seek past the end of the file; an {@code EOFException}
+     * will be thrown only if a read is performed.
+     * </p>
+     *
+     * @param pPosition a long containing the desired file pointer position.
+     *
+     * @throws IndexOutOfBoundsException if {@code pPosition} is smaller than
+     * the flushed position.
+     * @throws IOException if any other I/O error occurs.
+     */
+    void seek(long pPosition) throws IOException;
+
+    /**
+     * Marks a position in the stream to be returned to by a subsequent call to
+     * reset.
+     * Unlike a standard {@code InputStream}, all {@code Seekable}
+     * streams upport marking. Additionally, calls to {@code mark} and
+     * {@code reset} may be nested arbitrarily.
+     * <p>
+     * Unlike the {@code mark} methods declared by the {@code Reader} or
+     * {@code InputStream}
+     * interfaces, no {@code readLimit} parameter is used. An arbitrary amount
+     * of data may be read following the call to {@code mark}.
+     * </p>
+     */
+    void mark();
+
+    /**
+     * Returns the file pointer to its previous position,
+     * at the time of the most recent unmatched call to mark.
+     * <p>
+     * Calls to reset without a corresponding call to mark will either:
+     * </p>
+     * <ul>
+     * <li>throw an {@code IOException}</li>
+     * <li>or, reset to the beginning of the stream.</li>
+     * </ul>
+     * <p>
+     * An {@code IOException} will be thrown if the previous marked position
+     * lies in the discarded portion of the stream.
+     * </p>
+     *
+     * @throws IOException if an I/O error occurs.
+     * @see java.io.InputStream#reset()
+     */
+    void reset() throws IOException;
+
+    /**
+     * Discards the initial portion of the stream prior to the indicated
+     * postion. Attempting to seek to an offset within the flushed portion of
+     * the stream will result in an {@code IndexOutOfBoundsException}.
+     * <p>
+     * Calling {@code flushBefore} may allow classes implementing this
+     * interface to free up resources such as memory or disk space that are
+     * being used to store data from the stream.
+     * </p>
+     *
+     * @param pPosition a long containing the length of the file prefix that
+     * may be flushed.
+     *
+     * @throws IndexOutOfBoundsException if {@code pPosition} lies in the
+     * flushed portion of the stream or past the current stream position.
+     * @throws IOException if an I/O error occurs.
+     */
+    void flushBefore(long pPosition) throws IOException;
+
+    /**
+     * Discards the initial position of the stream prior to the current stream
+     * position. Equivalent to {@code flushBefore(getStreamPosition())}.
+     *
+     * @throws IOException if an I/O error occurs.
+     */
+    void flush() throws IOException;
+
+    /**
+     * Returns the earliest position in the stream to which seeking may be
+     * performed. The returned value will be the maximum of all values passed
+     * into previous calls to {@code flushBefore}.
+     *
+     * @return the earliest legal position for seeking, as a {@code long}.
+     *
+     * @throws IOException if an I/O error occurs.
+     */
+    long getFlushedPosition() throws IOException;
+
+    /**
+     * Returns true if this {@code Seekable} stream caches data itself in order
+     * to allow seeking backwards. Applications may consult this in order to
+     * decide how frequently, or whether, to flush in order to conserve cache
+     * resources.
+     *
+     * @return {@code true} if this {@code Seekable} caches data.
+     * @see #isCachedMemory()
+     * @see #isCachedFile()
+     */
+    boolean isCached();
+
+    /**
+     * Returns true if this {@code Seekable} stream caches data itself in order
+     * to allow seeking backwards, and the cache is kept in main memory.
+     * Applications may consult this in order to decide how frequently, or
+     * whether, to flush in order to conserve cache resources.
+     *
+     * @return {@code true} if this {@code Seekable} caches data in main
+     * memory.
+     * @see #isCached()
+     * @see #isCachedFile()
+     */
+    boolean isCachedMemory();
+
+    /**
+     * Returns true if this {@code Seekable} stream caches data itself in
+     * order to allow seeking backwards, and the cache is kept in a
+     * temporary file.
+     * Applications may consult this in order to decide how frequently,
+     * or whether, to flush in order to conserve cache resources.
+     *
+     * @return {@code true} if this {@code Seekable} caches data in a
+     * temporary file.
+     * @see #isCached
+     * @see #isCachedMemory
+     */
+    boolean isCachedFile();
+
+    /**
+     * Closes the stream.
+     *
+     * @throws java.io.IOException if the stream can't be closed.
+     */
+    void close() throws IOException;
+}

common/common-io/src/main/java/com/twelvemonkeys/io/SeekableInputStream.java

@@ -1,238 +1,238 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.Stack;
-
-/**
- * Abstract base class for {@code InputStream}s implementing the {@code Seekable} interface.
- * <p/>
- * @see SeekableOutputStream
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SeekableInputStream.java#4 $
- */
-public abstract class SeekableInputStream extends InputStream implements Seekable {
-
-    // TODO: It's at the moment not possible to create subclasses outside this
-    // package, as there's no access to position. position needs to be
-    // updated from the read/read/read methods...
-
-    /** The stream position in this stream */
-    long position;
-    long flushedPosition;
-    boolean closed;
-
-    protected Stack<Long> markedPositions = new Stack<Long>();
-
-    /// InputStream overrides
-    @Override
-    public final int read(byte[] pBytes) throws IOException {
-        return read(pBytes, 0, pBytes != null ? pBytes.length : 1);
-    }
-
-    /**
-     * Implemented using {@code seek(currentPos + pLength)}.
-     *
-     * @param pLength the number of bytes to skip
-     * @return the actual number of bytes skipped (may be equal to or less
-     *         than {@code pLength})
-     *
-     * @throws IOException if an I/O exception occurs during skip
-     */
-    @Override
-    public final long skip(final long pLength) throws IOException {
-        long pos = position;
-        long wantedPosition = pos + pLength;
-        if (wantedPosition < flushedPosition) {
-            throw new IOException("position < flushedPosition");
-        }
-
-        // Stop at stream length for compatibility, even though it might be allowed
-        // to seek past end of stream
-        int available = available();
-        if (available > 0) {
-            seek(Math.min(wantedPosition, pos + available));
-        }
-        // TODO: Add optimization for streams with known length!
-        else {
-            // Slow mode...
-            int toSkip = (int) Math.max(Math.min(pLength, 512), -512);
-            while (toSkip > 0 && read() >= 0) {
-                toSkip--;
-            }
-        }
-
-        return position - pos;
-    }
-
-    @Override
-    public final void mark(int pLimit) {
-        mark();
-
-        // TODO: We don't really need to do this.. Is it a good idea?
-        try {
-            flushBefore(Math.max(position - pLimit, flushedPosition));
-        }
-        catch (IOException ignore) {
-            // Ignore, as it's not really critical
-        }
-    }
-
-    /**
-     * Returns {@code true}, as marking is always supported.
-     *
-     * @return {@code true}.
-     */
-    @Override
-    public final boolean markSupported() {
-        return true;
-    }
-
-    /// Seekable implementation
-    public final void seek(long pPosition) throws IOException {
-        checkOpen();
-
-        // NOTE: This is correct according to javax.imageio (IndexOutOfBoundsException),
-        // but it's kind of inconsistent with reset that throws IOException...
-        if (pPosition < flushedPosition) {
-           throw new IndexOutOfBoundsException("position < flushedPosition");
-        }
-
-        seekImpl(pPosition);
-        position = pPosition;
-    }
-
-    protected abstract void seekImpl(long pPosition) throws IOException;
-
-    public final void mark() {
-        markedPositions.push(position);
-    }
-
-    @Override
-    public final void reset() throws IOException {
-        checkOpen();
-        if (!markedPositions.isEmpty()) {
-            long newPos = markedPositions.pop();
-
-            // NOTE: This is correct according to javax.imageio (IOException),
-            // but it's kind of inconsistent with seek that throws IndexOutOfBoundsException...
-            if (newPos < flushedPosition) {
-                throw new IOException("Previous marked position has been discarded");
-            }
-
-            seek(newPos);
-        }
-        else {
-            // TODO: To iron out some wrinkles due to conflicting contracts
-            // (InputStream and Seekable both declare reset),
-            // we might need to reset to the last marked position instead..
-            // However, that becomes REALLY confusing if that position is after
-            // the current position...
-            seek(0);
-        }
-    }
-
-    public final void flushBefore(long pPosition) throws IOException {
-        if (pPosition < flushedPosition) {
-            throw new IndexOutOfBoundsException("position < flushedPosition");
-        }
-        if (pPosition > getStreamPosition()) {
-            throw new IndexOutOfBoundsException("position > stream position");
-        }
-        checkOpen();
-        flushBeforeImpl(pPosition);
-        flushedPosition = pPosition;
-    }
-
-    /**
-     * Discards the initial portion of the stream prior to the indicated postion.
-     *
-     * @param pPosition the position to flush to
-     * @throws IOException if an I/O exception occurs during the flush operation
-     *
-     * @see #flushBefore(long)
-     */
-    protected abstract void flushBeforeImpl(long pPosition) throws IOException;
-
-    public final void flush() throws IOException {
-        flushBefore(flushedPosition);
-    }
-
-    public final long getFlushedPosition() throws IOException {
-        checkOpen();
-        return flushedPosition;
-    }
-
-    public final long getStreamPosition() throws IOException {
-        checkOpen();
-        return position;
-    }
-
-    protected final void checkOpen() throws IOException {
-        if (closed) {
-            throw new IOException("closed");
-        }
-    }
-
-    @Override
-    public final void close() throws IOException {
-        checkOpen();
-        closed = true;
-        closeImpl();
-    }
-
-    protected abstract void closeImpl() throws IOException;
-
-    /**
-     * Finalizes this object prior to garbage collection.  The
-     * {@code close} method is called to close any open input
-     * source.  This method should not be called from application
-     * code.
-     *
-     * @exception Throwable if an error occurs during superclass
-     * finalization.
-     */
-    @Override
-    protected void finalize() throws Throwable {
-        if (!closed) {
-            try {
-                close();
-            }
-            catch (IOException ignore) {
-                // Ignroe
-            }
-        }
-        super.finalize();
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Stack;
+
+/**
+ * Abstract base class for {@code InputStream}s implementing the {@code Seekable} interface.
+ *
+ * @see SeekableOutputStream
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SeekableInputStream.java#4 $
+ */
+public abstract class SeekableInputStream extends InputStream implements Seekable {
+
+    // TODO: It's at the moment not possible to create subclasses outside this
+    // package, as there's no access to position. position needs to be
+    // updated from the read/read/read methods...
+
+    /** The stream position in this stream */
+    long position;
+    long flushedPosition;
+    boolean closed;
+
+    protected Stack<Long> markedPositions = new Stack<Long>();
+
+    /// InputStream overrides
+    @Override
+    public final int read(byte[] pBytes) throws IOException {
+        return read(pBytes, 0, pBytes != null ? pBytes.length : 1);
+    }
+
+    /**
+     * Implemented using {@code seek(currentPos + pLength)}.
+     *
+     * @param pLength the number of bytes to skip
+     * @return the actual number of bytes skipped (may be equal to or less
+     *         than {@code pLength})
+     *
+     * @throws IOException if an I/O exception occurs during skip
+     */
+    @Override
+    public final long skip(final long pLength) throws IOException {
+        long pos = position;
+        long wantedPosition = pos + pLength;
+        if (wantedPosition < flushedPosition) {
+            throw new IOException("position < flushedPosition");
+        }
+
+        // Stop at stream length for compatibility, even though it might be allowed
+        // to seek past end of stream
+        int available = available();
+        if (available > 0) {
+            seek(Math.min(wantedPosition, pos + available));
+        }
+        // TODO: Add optimization for streams with known length!
+        else {
+            // Slow mode...
+            int toSkip = (int) Math.max(Math.min(pLength, 512), -512);
+            while (toSkip > 0 && read() >= 0) {
+                toSkip--;
+            }
+        }
+
+        return position - pos;
+    }
+
+    @Override
+    public final void mark(int pLimit) {
+        mark();
+
+        // TODO: We don't really need to do this.. Is it a good idea?
+        try {
+            flushBefore(Math.max(position - pLimit, flushedPosition));
+        }
+        catch (IOException ignore) {
+            // Ignore, as it's not really critical
+        }
+    }
+
+    /**
+     * Returns {@code true}, as marking is always supported.
+     *
+     * @return {@code true}.
+     */
+    @Override
+    public final boolean markSupported() {
+        return true;
+    }
+
+    /// Seekable implementation
+    public final void seek(long pPosition) throws IOException {
+        checkOpen();
+
+        // NOTE: This is correct according to javax.imageio (IndexOutOfBoundsException),
+        // but it's kind of inconsistent with reset that throws IOException...
+        if (pPosition < flushedPosition) {
+           throw new IndexOutOfBoundsException("position < flushedPosition");
+        }
+
+        seekImpl(pPosition);
+        position = pPosition;
+    }
+
+    protected abstract void seekImpl(long pPosition) throws IOException;
+
+    public final void mark() {
+        markedPositions.push(position);
+    }
+
+    @Override
+    public final void reset() throws IOException {
+        checkOpen();
+        if (!markedPositions.isEmpty()) {
+            long newPos = markedPositions.pop();
+
+            // NOTE: This is correct according to javax.imageio (IOException),
+            // but it's kind of inconsistent with seek that throws IndexOutOfBoundsException...
+            if (newPos < flushedPosition) {
+                throw new IOException("Previous marked position has been discarded");
+            }
+
+            seek(newPos);
+        }
+        else {
+            // TODO: To iron out some wrinkles due to conflicting contracts
+            // (InputStream and Seekable both declare reset),
+            // we might need to reset to the last marked position instead..
+            // However, that becomes REALLY confusing if that position is after
+            // the current position...
+            seek(0);
+        }
+    }
+
+    public final void flushBefore(long pPosition) throws IOException {
+        if (pPosition < flushedPosition) {
+            throw new IndexOutOfBoundsException("position < flushedPosition");
+        }
+        if (pPosition > getStreamPosition()) {
+            throw new IndexOutOfBoundsException("position > stream position");
+        }
+        checkOpen();
+        flushBeforeImpl(pPosition);
+        flushedPosition = pPosition;
+    }
+
+    /**
+     * Discards the initial portion of the stream prior to the indicated postion.
+     *
+     * @param pPosition the position to flush to
+     * @throws IOException if an I/O exception occurs during the flush operation
+     *
+     * @see #flushBefore(long)
+     */
+    protected abstract void flushBeforeImpl(long pPosition) throws IOException;
+
+    public final void flush() throws IOException {
+        flushBefore(flushedPosition);
+    }
+
+    public final long getFlushedPosition() throws IOException {
+        checkOpen();
+        return flushedPosition;
+    }
+
+    public final long getStreamPosition() throws IOException {
+        checkOpen();
+        return position;
+    }
+
+    protected final void checkOpen() throws IOException {
+        if (closed) {
+            throw new IOException("closed");
+        }
+    }
+
+    @Override
+    public final void close() throws IOException {
+        checkOpen();
+        closed = true;
+        closeImpl();
+    }
+
+    protected abstract void closeImpl() throws IOException;
+
+    /**
+     * Finalizes this object prior to garbage collection.  The
+     * {@code close} method is called to close any open input
+     * source.  This method should not be called from application
+     * code.
+     *
+     * @exception Throwable if an error occurs during superclass
+     * finalization.
+     */
+    @Override
+    protected void finalize() throws Throwable {
+        if (!closed) {
+            try {
+                close();
+            }
+            catch (IOException ignore) {
+                // Ignroe
+            }
+        }
+        super.finalize();
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/SeekableOutputStream.java

@@ -1,140 +1,140 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.util.Stack;
-
-/**
- * Abstract base class for {@code OutputStream}s implementing the
- * {@code Seekable} interface.
- * <p/>
- * @see SeekableInputStream
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SeekableOutputStream.java#2 $
- */
-public abstract class SeekableOutputStream extends OutputStream implements Seekable {
-    // TODO: Implement
-    long position;
-    long flushedPosition;
-    boolean closed;
-
-    protected Stack<Long> markedPositions = new Stack<Long>();
-
-    /// Outputstream overrides
-    @Override
-    public final void write(byte pBytes[]) throws IOException {
-        write(pBytes, 0, pBytes != null ? pBytes.length : 1);
-    }
-
-    /// Seekable implementation
-    // TODO: This is common behaviour/implementation with SeekableInputStream,
-    // probably a good idea to extract a delegate..?
-    public final void seek(long pPosition) throws IOException {
-        checkOpen();
-
-        // TODO: This is correct according to javax.imageio (IndexOutOfBoundsException),
-        // but it's inconsistent with reset that throws IOException...
-        if (pPosition < flushedPosition) {
-            throw new IndexOutOfBoundsException("position < flushedPosition!");
-        }
-
-        seekImpl(pPosition);
-        position = pPosition;
-    }
-
-    protected abstract void seekImpl(long pPosition) throws IOException;
-
-    public final void mark() {
-        markedPositions.push(position);
-    }
-
-    public final void reset() throws IOException {
-        checkOpen();
-        if (!markedPositions.isEmpty()) {
-            long newPos = markedPositions.pop();
-
-            // TODO: This is correct according to javax.imageio (IOException),
-            // but it's inconsistent with seek that throws IndexOutOfBoundsException...
-            if (newPos < flushedPosition) {
-                throw new IOException("Previous marked position has been discarded!");
-            }
-
-            seek(newPos);
-        }
-    }
-
-    public final void flushBefore(long pPosition) throws IOException {
-        if (pPosition < flushedPosition) {
-            throw new IndexOutOfBoundsException("position < flushedPosition!");
-        }
-        if (pPosition > getStreamPosition()) {
-            throw new IndexOutOfBoundsException("position > getStreamPosition()!");
-        }
-        checkOpen();
-        flushBeforeImpl(pPosition);
-        flushedPosition = pPosition;
-    }
-
-    protected abstract void flushBeforeImpl(long pPosition) throws IOException;
-
-    @Override
-    public final void flush() throws IOException {
-        flushBefore(flushedPosition);
-    }
-
-    public final long getFlushedPosition() throws IOException {
-        checkOpen();
-        return flushedPosition;
-    }
-
-    public final long getStreamPosition() throws IOException {
-        checkOpen();
-        return position;
-    }
-
-    protected final void checkOpen() throws IOException {
-        if (closed) {
-            throw new IOException("closed");
-        }
-    }
-
-    @Override
-    public final void close() throws IOException {
-        checkOpen();
-        closed = true;
-        closeImpl();
-    }
-
-    protected abstract void closeImpl() throws IOException;
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Stack;
+
+/**
+ * Abstract base class for {@code OutputStream}s implementing the
+ * {@code Seekable} interface.
+ *
+ * @see SeekableInputStream
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SeekableOutputStream.java#2 $
+ */
+public abstract class SeekableOutputStream extends OutputStream implements Seekable {
+    // TODO: Implement
+    long position;
+    long flushedPosition;
+    boolean closed;
+
+    protected Stack<Long> markedPositions = new Stack<Long>();
+
+    /// Outputstream overrides
+    @Override
+    public final void write(byte pBytes[]) throws IOException {
+        write(pBytes, 0, pBytes != null ? pBytes.length : 1);
+    }
+
+    /// Seekable implementation
+    // TODO: This is common behaviour/implementation with SeekableInputStream,
+    // probably a good idea to extract a delegate..?
+    public final void seek(long pPosition) throws IOException {
+        checkOpen();
+
+        // TODO: This is correct according to javax.imageio (IndexOutOfBoundsException),
+        // but it's inconsistent with reset that throws IOException...
+        if (pPosition < flushedPosition) {
+            throw new IndexOutOfBoundsException("position < flushedPosition!");
+        }
+
+        seekImpl(pPosition);
+        position = pPosition;
+    }
+
+    protected abstract void seekImpl(long pPosition) throws IOException;
+
+    public final void mark() {
+        markedPositions.push(position);
+    }
+
+    public final void reset() throws IOException {
+        checkOpen();
+        if (!markedPositions.isEmpty()) {
+            long newPos = markedPositions.pop();
+
+            // TODO: This is correct according to javax.imageio (IOException),
+            // but it's inconsistent with seek that throws IndexOutOfBoundsException...
+            if (newPos < flushedPosition) {
+                throw new IOException("Previous marked position has been discarded!");
+            }
+
+            seek(newPos);
+        }
+    }
+
+    public final void flushBefore(long pPosition) throws IOException {
+        if (pPosition < flushedPosition) {
+            throw new IndexOutOfBoundsException("position < flushedPosition!");
+        }
+        if (pPosition > getStreamPosition()) {
+            throw new IndexOutOfBoundsException("position > getStreamPosition()!");
+        }
+        checkOpen();
+        flushBeforeImpl(pPosition);
+        flushedPosition = pPosition;
+    }
+
+    protected abstract void flushBeforeImpl(long pPosition) throws IOException;
+
+    @Override
+    public final void flush() throws IOException {
+        flushBefore(flushedPosition);
+    }
+
+    public final long getFlushedPosition() throws IOException {
+        checkOpen();
+        return flushedPosition;
+    }
+
+    public final long getStreamPosition() throws IOException {
+        checkOpen();
+        return position;
+    }
+
+    protected final void checkOpen() throws IOException {
+        if (closed) {
+            throw new IOException("closed");
+        }
+    }
+
+    @Override
+    public final void close() throws IOException {
+        checkOpen();
+        closed = true;
+        closeImpl();
+    }
+
+    protected abstract void closeImpl() throws IOException;
+}

common/common-io/src/main/java/com/twelvemonkeys/io/StringArrayReader.java

@@ -1,189 +1,188 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.Validate;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.io.StringReader;
-
-/**
- * StringArrayReader
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/StringArrayReader.java#2 $
- */
-public class StringArrayReader extends StringReader {
-
-    private StringReader current;
-    private String[] strings;
-    protected final Object finalLock;
-    private int currentSting;
-    private int markedString;
-    private int mark;
-    private int next;
-
-    /**
-     * Create a new string array reader.
-     *
-     * @param pStrings {@code String}s providing the character stream.
-     */
-    public StringArrayReader(final String[] pStrings) {
-        super("");
-
-        Validate.notNull(pStrings, "strings");
-
-        finalLock = lock = pStrings; // NOTE: It's ok to sync on pStrings, as the
-                                 // reference can't change, only it's elements
-
-        strings = pStrings.clone(); // Defensive copy for content
-        nextReader();
-    }
-
-    protected final Reader nextReader() {
-        if (currentSting >= strings.length) {
-            current = new EmptyReader();
-        }
-        else {
-            current = new StringReader(strings[currentSting++]);
-        }
-
-        // NOTE: Reset next for every reader, and record marked reader in mark/reset methods!
-        next = 0;
-        
-        return current;
-    }
-
-    /**
-     * Check to make sure that the stream has not been closed
-     *
-     * @throws IOException if the stream is closed
-     */
-    protected final void ensureOpen() throws IOException {
-        if (strings == null) {
-            throw new IOException("Stream closed");
-        }
-    }
-
-    public void close() {
-        super.close();
-        strings = null;
-        current.close();
-    }
-
-    public void mark(int pReadLimit) throws IOException {
-        if (pReadLimit < 0){
-            throw new IllegalArgumentException("Read limit < 0");
-        }
-
-        synchronized (finalLock) {
-            ensureOpen();
-            mark = next;
-            markedString = currentSting;
-
-            current.mark(pReadLimit);
-        }
-    }
-
-    public void reset() throws IOException {
-        synchronized (finalLock) {
-            ensureOpen();
-
-            if (currentSting != markedString) {
-                currentSting = markedString - 1;
-                nextReader();
-                current.skip(mark);
-            }
-            else {
-                current.reset();
-            }
-
-            next = mark;
-        }
-    }
-
-    public boolean markSupported() {
-        return true;
-    }
-
-    public int read() throws IOException {
-        synchronized (finalLock) {
-            int read = current.read();
-
-            if (read < 0 && currentSting < strings.length) {
-                nextReader();
-                return read(); // In case of empty strings
-            }
-
-            next++;
-
-            return read;
-        }
-    }
-
-    public int read(char pBuffer[], int pOffset, int pLength) throws IOException {
-        synchronized (finalLock) {
-            int read = current.read(pBuffer, pOffset, pLength);
-
-            if (read < 0 && currentSting < strings.length) {
-                nextReader();
-                return read(pBuffer, pOffset, pLength); // In case of empty strings
-            }
-
-            next += read;
-
-            return read;
-        }
-    }
-
-    public boolean ready() throws IOException {
-        return current.ready();
-    }
-
-    public long skip(long pChars) throws IOException {
-        synchronized (finalLock) {
-            long skipped = current.skip(pChars);
-
-            if (skipped == 0 && currentSting < strings.length) {
-                nextReader();
-                return skip(pChars);
-            }
-
-            next += skipped;
-
-            return skipped;
-        }
-    }
-
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.Validate;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.io.StringReader;
+
+/**
+ * StringArrayReader
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/StringArrayReader.java#2 $
+ */
+public class StringArrayReader extends StringReader {
+
+    private StringReader current;
+    private String[] strings;
+    protected final Object finalLock;
+    private int currentSting;
+    private int markedString;
+    private long mark;
+    private long next;
+
+    /**
+     * Create a new string array reader.
+     *
+     * @param pStrings {@code String}s providing the character stream.
+     */
+    public StringArrayReader(final String[] pStrings) {
+        super("");
+
+        Validate.notNull(pStrings, "strings");
+
+        finalLock = lock = pStrings; // NOTE: It's ok to sync on pStrings, as the
+                                 // reference can't change, only it's elements
+
+        strings = pStrings.clone(); // Defensive copy for content
+        nextReader();
+    }
+
+    protected final Reader nextReader() {
+        if (currentSting >= strings.length) {
+            current = new EmptyReader();
+        }
+        else {
+            current = new StringReader(strings[currentSting++]);
+        }
+
+        // NOTE: Reset next for every reader, and record marked reader in mark/reset methods!
+        next = 0;
+        
+        return current;
+    }
+
+    /**
+     * Check to make sure that the stream has not been closed
+     *
+     * @throws IOException if the stream is closed
+     */
+    protected final void ensureOpen() throws IOException {
+        if (strings == null) {
+            throw new IOException("Stream closed");
+        }
+    }
+
+    public void close() {
+        super.close();
+        strings = null;
+        current.close();
+    }
+
+    public void mark(int pReadLimit) throws IOException {
+        if (pReadLimit < 0){
+            throw new IllegalArgumentException("Read limit < 0");
+        }
+
+        synchronized (finalLock) {
+            ensureOpen();
+            mark = next;
+            markedString = currentSting;
+
+            current.mark(pReadLimit);
+        }
+    }
+
+    public void reset() throws IOException {
+        synchronized (finalLock) {
+            ensureOpen();
+
+            if (currentSting != markedString) {
+                currentSting = markedString - 1;
+                nextReader();
+                current.skip(mark);
+            }
+            else {
+                current.reset();
+            }
+
+            next = mark;
+        }
+    }
+
+    public boolean markSupported() {
+        return true;
+    }
+
+    public int read() throws IOException {
+        synchronized (finalLock) {
+            int read = current.read();
+
+            if (read < 0 && currentSting < strings.length) {
+                nextReader();
+                return read(); // In case of empty strings
+            }
+
+            next++;
+
+            return read;
+        }
+    }
+
+    public int read(char[] pBuffer, int pOffset, int pLength) throws IOException {
+        synchronized (finalLock) {
+            int read = current.read(pBuffer, pOffset, pLength);
+
+            if (read < 0 && currentSting < strings.length) {
+                nextReader();
+                return read(pBuffer, pOffset, pLength); // In case of empty strings
+            }
+
+            next += read;
+
+            return read;
+        }
+    }
+
+    public boolean ready() throws IOException {
+        return current.ready();
+    }
+
+    public long skip(long pChars) throws IOException {
+        synchronized (finalLock) {
+            long skipped = current.skip(pChars);
+
+            if (skipped == 0 && currentSting < strings.length) {
+                nextReader();
+                return skip(pChars);
+            }
+
+            next += skipped;
+
+            return skipped;
+        }
+    }
+
+}

common/common-io/src/main/java/com/twelvemonkeys/io/SubStream.java

@@ -1,137 +1,134 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.Validate;
-
-import java.io.FilterInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-
-/**
- * An {@code InputStream} reading up to a specified number of bytes from an
- * underlying stream.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/SubStream.java#2 $
- */
-public final class SubStream extends FilterInputStream {
-    private long bytesLeft;
-    private int markLimit;
-
-    /**
-     * Creates a {@code SubStream} of the given {@code pStream}.
-     *
-     * @param pStream the underlying input stream
-     * @param pLength maximum number of bytes to read drom this stream
-     */
-    public SubStream(final InputStream pStream, final long pLength) {
-        super(Validate.notNull(pStream, "stream"));
-        bytesLeft = pLength;
-    }
-
-    /**
-     * Marks this stream as closed.
-     * This implementation does <em>not</em> close the underlying stream.
-     */
-    @Override
-    public void close() throws IOException {
-        // NOTE: Do not close the underlying stream
-        while (bytesLeft > 0) {
-            //noinspection ResultOfMethodCallIgnored
-            skip(bytesLeft);
-        }
-    }
-
-    @Override
-    public int available() throws IOException {
-        return (int) Math.min(super.available(), bytesLeft);
-    }
-
-    @Override
-    public void mark(int pReadLimit) {
-        super.mark(pReadLimit);// This either succeeds or does nothing...
-        markLimit = pReadLimit;
-    }
-
-    @Override
-    public void reset() throws IOException {
-        super.reset();// This either succeeds or throws IOException
-        bytesLeft += markLimit;
-    }
-
-    @Override
-    public int read() throws IOException {
-        if (bytesLeft-- <= 0) {
-            return -1;
-        }
-        return super.read();
-    }
-
-    @Override
-    public final int read(byte[] pBytes) throws IOException {
-        return read(pBytes, 0, pBytes.length);
-    }
-
-    @Override
-    public int read(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
-        if (bytesLeft <= 0) {
-            return -1;
-        }
-
-        int read = super.read(pBytes, pOffset, (int) findMaxLen(pLength));
-        bytesLeft = read < 0 ? 0 : bytesLeft - read;
-        return read;
-    }
-
-    /**
-     * Finds the maximum number of bytes we can read or skip, from this stream.
-     *
-     * @param pLength the requested length
-     * @return the maximum number of bytes to read
-     */
-    private long findMaxLen(long pLength) {
-        if (bytesLeft < pLength) {
-            return (int) Math.max(bytesLeft, 0);
-        }
-        else {
-            return pLength;
-        }
-    }
-
-    @Override
-    public long skip(long pLength) throws IOException {
-        long skipped = super.skip(findMaxLen(pLength));// Skips 0 or more, never -1
-        bytesLeft -= skipped;
-        return skipped;
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.Validate;
+
+import java.io.FilterInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+/**
+ * An {@code InputStream} reading up to a specified number of bytes from an
+ * underlying stream.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ */
+public final class SubStream extends FilterInputStream {
+    private long bytesLeft;
+    private int markLimit;
+
+    /**
+     * Creates a {@code SubStream} of the given {@code stream}.
+     *
+     * @param stream the underlying input stream
+     * @param length maximum number of bytes to read from this stream
+     */
+    public SubStream(final InputStream stream, final long length) {
+        super(Validate.notNull(stream, "stream"));
+        bytesLeft = Validate.isTrue(length >= 0, length, "length < 0: %s");
+    }
+
+    /**
+     * Marks this stream as closed.
+     * This implementation does <em>not</em> close the underlying stream.
+     */
+    @Override
+    public void close() throws IOException {
+        // NOTE: Do not close the underlying stream, but consume it
+        while (bytesLeft > 0) {
+            if (skip(bytesLeft) <= 0 && read() < 0) {
+                break;
+            }
+        }
+    }
+
+    @Override
+    public int available() throws IOException {
+        return (int) findMaxLen(super.available());
+    }
+
+    @Override
+    public void mark(int readLimit) {
+        super.mark(readLimit);// This either succeeds or does nothing...
+        markLimit = readLimit;
+    }
+
+    @Override
+    public void reset() throws IOException {
+        super.reset();// This either succeeds or throws IOException
+        bytesLeft += markLimit;
+    }
+
+    @Override
+    public int read() throws IOException {
+        if (bytesLeft-- <= 0) {
+            return -1;
+        }
+
+        return super.read();
+    }
+
+    @Override
+    public int read(byte[] bytes) throws IOException {
+        return read(bytes, 0, bytes.length);
+    }
+
+    @Override
+    public int read(final byte[] bytes, final int off, final int len) throws IOException {
+        if (bytesLeft <= 0) {
+            return -1;
+        }
+
+        int read = super.read(bytes, off, (int) findMaxLen(len));
+        bytesLeft = read < 0 ? 0 : bytesLeft - read;
+
+        return read;
+    }
+
+    @Override
+    public long skip(long length) throws IOException {
+        long skipped = super.skip(findMaxLen(length)); // Skips 0 or more, never -1
+        bytesLeft -= skipped;
+
+        return skipped;
+    }
+
+    /**
+     * Finds the maximum number of bytes we can read or skip, from this stream.
+     *
+     * @param length the requested length
+     * @return the maximum number of bytes to read
+     */
+    private long findMaxLen(long length) {
+        return bytesLeft < length ? Math.max(bytesLeft, 0) : length;
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/UnixFileSystem.java

@@ -1,107 +1,106 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.util.StringTokenIterator;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.IOException;
-
-/**
- * UnixFileSystem
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/UnixFileSystem.java#1 $
- */
-final class UnixFileSystem extends FileSystem {
-    long getFreeSpace(File pPath) {
-        try {
-            return getNumber(pPath, 3);
-        }
-        catch (IOException e) {
-            return 0l;
-        }
-    }
-
-    long getTotalSpace(File pPath) {
-        try {
-            return getNumber(pPath, 5);
-        }
-        catch (IOException e) {
-            return 0l;
-        }
-    }
-
-    private long getNumber(File pPath, int pIndex) throws IOException {
-        // TODO: Test on other platforms
-        // Tested on Mac OS X, CygWin
-        BufferedReader reader = exec(new String[] {"df", "-k", pPath.getAbsolutePath()});
-
-        String last = null;
-        String line;
-        try {
-            while ((line = reader.readLine()) != null) {
-                last = line;
-            }
-        }
-        finally {
-            FileUtil.close(reader);
-        }
-
-        if (last != null) {
-            String blocks = null;
-            StringTokenIterator tokens = new StringTokenIterator(last, " ", StringTokenIterator.REVERSE);
-            int count = 0;
-            // We want the 3rd last token
-            while (count < pIndex && tokens.hasNext()) {
-                blocks = tokens.nextToken();
-                count++;
-            }
-
-            if (blocks != null) {
-                try {
-                    return Long.parseLong(blocks) * 1024L;
-                }
-                catch (NumberFormatException ignore) {
-                    // Ignore
-                }
-            }
-        }
-
-        return 0l;
-    }
-
-    String getName() {
-        return "Unix";
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.util.StringTokenIterator;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * UnixFileSystem
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/UnixFileSystem.java#1 $
+ */
+final class UnixFileSystem extends FileSystem {
+    long getFreeSpace(File pPath) {
+        try {
+            return getNumber(pPath, 3);
+        }
+        catch (IOException e) {
+            return 0l;
+        }
+    }
+
+    long getTotalSpace(File pPath) {
+        try {
+            return getNumber(pPath, 5);
+        }
+        catch (IOException e) {
+            return 0l;
+        }
+    }
+
+    private long getNumber(File pPath, int pIndex) throws IOException {
+        // TODO: Test on other platforms
+        // Tested on Mac OS X, CygWin
+        BufferedReader reader = exec(new String[] {"df", "-k", pPath.getAbsolutePath()});
+
+        String last = null;
+        String line;
+        try {
+            while ((line = reader.readLine()) != null) {
+                last = line;
+            }
+        }
+        finally {
+            FileUtil.close(reader);
+        }
+
+        if (last != null) {
+            String blocks = null;
+            StringTokenIterator tokens = new StringTokenIterator(last, " ", StringTokenIterator.REVERSE);
+            int count = 0;
+            // We want the 3rd last token
+            while (count < pIndex && tokens.hasNext()) {
+                blocks = tokens.nextToken();
+                count++;
+            }
+
+            if (blocks != null) {
+                try {
+                    return Long.parseLong(blocks) * 1024L;
+                }
+                catch (NumberFormatException ignore) {
+                    // Ignore
+                }
+            }
+        }
+
+        return 0l;
+    }
+
+    String getName() {
+        return "Unix";
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/Win32File.java

@@ -1,195 +1,194 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.File;
-import java.io.FileFilter;
-import java.io.FilenameFilter;
-import java.io.IOException;
-
-/**
- * Win32File
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32File.java#2 $
- */
-final class Win32File extends File {
-    private final static boolean IS_WINDOWS = isWindows();
-
-    private static boolean isWindows() {
-        try {
-            String os = System.getProperty("os.name");
-            return os.toLowerCase().indexOf("windows") >= 0;
-        }
-        catch (Throwable t) {
-            // Ignore
-        }
-        return false;
-    }
-
-    private Win32File(File pPath) {
-        super(pPath.getPath());
-    }
-
-    public static void main(String[] pArgs) {
-        int argIdx = 0;
-        boolean recursive = false;
-        while (pArgs.length > argIdx + 1 && pArgs[argIdx].charAt(0) == '-' && pArgs[argIdx].length() > 1) {
-            if (pArgs[argIdx].charAt(1) == 'R' || pArgs[argIdx].equals("--recursive")) {
-                recursive = true;
-            }
-            else {
-                System.err.println("Unknown option: " + pArgs[argIdx]);
-            }
-            argIdx++;
-        }
-
-        File file = wrap(new File(pArgs[argIdx]));
-        System.out.println("file: " + file);
-        System.out.println("file.getClass(): " + file.getClass());
-
-        listFiles(file, 0, recursive);
-    }
-
-    private static void listFiles(File pFile, int pLevel, boolean pRecursive) {
-        if (pFile.isDirectory()) {
-            File[] files = pFile.listFiles();
-            for (int l = 0; l < pLevel; l++) {
-                System.out.print(" ");
-            }
-            System.out.println("Contents of " + pFile + ": ");
-            for (File file : files) {
-                for (int l = 0; l < pLevel; l++) {
-                    System.out.print(" ");
-                }
-                System.out.println("  " + file);
-                if (pRecursive) {
-                    listFiles(file, pLevel + 1, pLevel < 4);
-                }
-            }
-        }
-    }
-
-    /**
-     * Wraps a {@code File} object pointing to a Windows symbolic link
-     * ({@code .lnk} file) in a {@code Win32Lnk}.
-     * If the operating system is not Windows, the
-     * {@code pPath} parameter is returned unwrapped.
-     *
-     * @param pPath any path, possibly pointing to a Windows symbolic link file.
-     * May be {@code null}, in which case {@code null} is returned.
-     *
-     * @return a new {@code Win32Lnk} object if the current os is Windows, and
-     * the file is a Windows symbolic link ({@code .lnk} file), otherwise
-     * {@code pPath}
-     */
-    public static File wrap(final File pPath) {
-        if (pPath == null) {
-            return null;
-        }
-
-        if (IS_WINDOWS) {
-            // Don't wrap if allready wrapped
-            if (pPath instanceof Win32File || pPath instanceof Win32Lnk) {
-                return pPath;
-            }
-
-            if (pPath.exists() && pPath.getName().endsWith(".lnk")) {
-                // If Win32 .lnk, let's wrap
-                try {
-                    return new Win32Lnk(pPath);
-                }
-                catch (IOException e) {
-                    // TODO: FixMe!
-                    e.printStackTrace();
-                }
-            }
-
-            // Wwrap even if not a .lnk, as the listFiles() methods etc,
-            // could potentially return .lnk's, that we want to wrap later...
-            return new Win32File(pPath);
-        }
-
-        return pPath;
-    }
-
-    /**
-     * Wraps a {@code File} array, possibly pointing to Windows symbolic links
-     * ({@code .lnk} files) in {@code Win32Lnk}s.
-     *
-     * @param pPaths an array of {@code File}s, possibly pointing to Windows
-     * symbolic link files.
-     * May be {@code null}, in which case {@code null} is returned.
-     *
-     * @return {@code pPaths}, with any {@code File} representing a Windows
-     * symbolic link ({@code .lnk} file) wrapped in a {@code Win32Lnk}.
-     */
-    public static File[] wrap(File[] pPaths) {
-        if (IS_WINDOWS) {
-            for (int i = 0; pPaths != null && i < pPaths.length; i++) {
-                pPaths[i] = wrap(pPaths[i]);
-            }
-        }
-        return pPaths;
-    }
-
-    // File overrides
-    @Override
-    public File getAbsoluteFile() {
-        return wrap(super.getAbsoluteFile());
-    }
-
-    @Override
-    public File getCanonicalFile() throws IOException {
-        return wrap(super.getCanonicalFile());
-    }
-
-    @Override
-    public File getParentFile() {
-        return wrap(super.getParentFile());
-    }
-
-    @Override
-    public File[] listFiles() {
-        return wrap(super.listFiles());
-    }
-
-    @Override
-    public File[] listFiles(FileFilter filter) {
-        return wrap(super.listFiles(filter));
-    }
-
-    @Override
-    public File[] listFiles(FilenameFilter filter) {
-        return wrap(super.listFiles(filter));
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.File;
+import java.io.FileFilter;
+import java.io.FilenameFilter;
+import java.io.IOException;
+
+/**
+ * Win32File
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32File.java#2 $
+ */
+final class Win32File extends File {
+    private final static boolean IS_WINDOWS = isWindows();
+
+    private static boolean isWindows() {
+        try {
+            String os = System.getProperty("os.name");
+            return os.toLowerCase().indexOf("windows") >= 0;
+        }
+        catch (Throwable t) {
+            // Ignore
+        }
+        return false;
+    }
+
+    private Win32File(File pPath) {
+        super(pPath.getPath());
+    }
+
+    public static void main(String[] pArgs) {
+        int argIdx = 0;
+        boolean recursive = false;
+        while (pArgs.length > argIdx + 1 && pArgs[argIdx].charAt(0) == '-' && pArgs[argIdx].length() > 1) {
+            if (pArgs[argIdx].charAt(1) == 'R' || pArgs[argIdx].equals("--recursive")) {
+                recursive = true;
+            }
+            else {
+                System.err.println("Unknown option: " + pArgs[argIdx]);
+            }
+            argIdx++;
+        }
+
+        File file = wrap(new File(pArgs[argIdx]));
+        System.out.println("file: " + file);
+        System.out.println("file.getClass(): " + file.getClass());
+
+        listFiles(file, 0, recursive);
+    }
+
+    private static void listFiles(File pFile, int pLevel, boolean pRecursive) {
+        if (pFile.isDirectory()) {
+            File[] files = pFile.listFiles();
+            for (int l = 0; l < pLevel; l++) {
+                System.out.print(" ");
+            }
+            System.out.println("Contents of " + pFile + ": ");
+            for (File file : files) {
+                for (int l = 0; l < pLevel; l++) {
+                    System.out.print(" ");
+                }
+                System.out.println("  " + file);
+                if (pRecursive) {
+                    listFiles(file, pLevel + 1, pLevel < 4);
+                }
+            }
+        }
+    }
+
+    /**
+     * Wraps a {@code File} object pointing to a Windows symbolic link
+     * ({@code .lnk} file) in a {@code Win32Lnk}.
+     * If the operating system is not Windows, the
+     * {@code pPath} parameter is returned unwrapped.
+     *
+     * @param pPath any path, possibly pointing to a Windows symbolic link file.
+     * May be {@code null}, in which case {@code null} is returned.
+     *
+     * @return a new {@code Win32Lnk} object if the current os is Windows, and
+     * the file is a Windows symbolic link ({@code .lnk} file), otherwise
+     * {@code pPath}
+     */
+    public static File wrap(final File pPath) {
+        if (pPath == null) {
+            return null;
+        }
+
+        if (IS_WINDOWS) {
+            // Don't wrap if allready wrapped
+            if (pPath instanceof Win32File || pPath instanceof Win32Lnk) {
+                return pPath;
+            }
+
+            if (pPath.exists() && pPath.getName().endsWith(".lnk")) {
+                // If Win32 .lnk, let's wrap
+                try {
+                    return new Win32Lnk(pPath);
+                }
+                catch (IOException e) {
+                    // TODO: FixMe!
+                    e.printStackTrace();
+                }
+            }
+
+            // Wwrap even if not a .lnk, as the listFiles() methods etc,
+            // could potentially return .lnk's, that we want to wrap later...
+            return new Win32File(pPath);
+        }
+
+        return pPath;
+    }
+
+    /**
+     * Wraps a {@code File} array, possibly pointing to Windows symbolic links
+     * ({@code .lnk} files) in {@code Win32Lnk}s.
+     *
+     * @param pPaths an array of {@code File}s, possibly pointing to Windows
+     * symbolic link files.
+     * May be {@code null}, in which case {@code null} is returned.
+     *
+     * @return {@code pPaths}, with any {@code File} representing a Windows
+     * symbolic link ({@code .lnk} file) wrapped in a {@code Win32Lnk}.
+     */
+    public static File[] wrap(File[] pPaths) {
+        if (IS_WINDOWS) {
+            for (int i = 0; pPaths != null && i < pPaths.length; i++) {
+                pPaths[i] = wrap(pPaths[i]);
+            }
+        }
+        return pPaths;
+    }
+
+    // File overrides
+    @Override
+    public File getAbsoluteFile() {
+        return wrap(super.getAbsoluteFile());
+    }
+
+    @Override
+    public File getCanonicalFile() throws IOException {
+        return wrap(super.getCanonicalFile());
+    }
+
+    @Override
+    public File getParentFile() {
+        return wrap(super.getParentFile());
+    }
+
+    @Override
+    public File[] listFiles() {
+        return wrap(super.listFiles());
+    }
+
+    @Override
+    public File[] listFiles(FileFilter filter) {
+        return wrap(super.listFiles(filter));
+    }
+
+    @Override
+    public File[] listFiles(FilenameFilter filter) {
+        return wrap(super.listFiles(filter));
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/Win32FileSystem.java

@@ -1,92 +1,91 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.BufferedReader;
-import java.io.File;
-import java.io.IOException;
-
-/**
- * WindowsFileSystem
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32FileSystem.java#2 $
- */
-final class Win32FileSystem extends FileSystem {
-    public long getFreeSpace(File pPath) {
-        try {
-            // Windows version
-            // TODO: Test on W2K/95/98/etc... (tested on XP)
-            BufferedReader reader = exec(new String[] {"CMD.EXE", "/C", "DIR", "/-C", pPath.getAbsolutePath()});
-
-            String last = null;
-            String line;
-            try {
-                while ((line = reader.readLine()) != null) {
-                    last = line;
-                }
-            }
-            finally {
-                FileUtil.close(reader);
-            }
-
-            if (last != null) {
-                int end = last.lastIndexOf(" bytes free");
-                int start = last.lastIndexOf(' ', end - 1);
-
-                if (start >= 0 && end >= 0) {
-                    try {
-                        return Long.parseLong(last.substring(start + 1, end));
-                    }
-                    catch (NumberFormatException ignore) {
-                        // Ignore
-                    }
-                }
-            }
-        }
-        catch (IOException ignore) {
-            // Ignore
-        }
-
-        return 0l;
-    }
-
-    long getTotalSpace(File pPath) {
-        // TODO: Implement, probably need some JNI stuff...
-        // Distribute df.exe and execute from temp!? ;-)
-        return getFreeSpace(pPath);
-    }
-
-    String getName() {
-        return "Win32";
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+
+/**
+ * WindowsFileSystem
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32FileSystem.java#2 $
+ */
+final class Win32FileSystem extends FileSystem {
+    public long getFreeSpace(File pPath) {
+        try {
+            // Windows version
+            // TODO: Test on W2K/95/98/etc... (tested on XP)
+            BufferedReader reader = exec(new String[] {"CMD.EXE", "/C", "DIR", "/-C", pPath.getAbsolutePath()});
+
+            String last = null;
+            String line;
+            try {
+                while ((line = reader.readLine()) != null) {
+                    last = line;
+                }
+            }
+            finally {
+                FileUtil.close(reader);
+            }
+
+            if (last != null) {
+                int end = last.lastIndexOf(" bytes free");
+                int start = last.lastIndexOf(' ', end - 1);
+
+                if (start >= 0 && end >= 0) {
+                    try {
+                        return Long.parseLong(last.substring(start + 1, end));
+                    }
+                    catch (NumberFormatException ignore) {
+                        // Ignore
+                    }
+                }
+            }
+        }
+        catch (IOException ignore) {
+            // Ignore
+        }
+
+        return 0l;
+    }
+
+    long getTotalSpace(File pPath) {
+        // TODO: Implement, probably need some JNI stuff...
+        // Distribute df.exe and execute from temp!? ;-)
+        return getFreeSpace(pPath);
+    }
+
+    String getName() {
+        return "Win32";
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/Win32Lnk.java

@@ -1,475 +1,477 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import java.io.*;
-import java.util.Arrays;
-
-/**
- * A {@code File} implementation that resolves the Windows {@code .lnk} files as symbolic links.
- * <p/>
- * This class is based on example code from
- * <a href="http://www.oreilly.com/catalog/swinghks/index.html">Swing Hacks</a>,
- * By Joshua Marinacci, Chris Adamson (O'Reilly, ISBN: 0-596-00907-0), Hack 30.
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32Lnk.java#2 $
- */
-final class Win32Lnk extends File {
-    private final static byte[] LNK_MAGIC = {
-            'L', 0x00, 0x00, 0x00, // Magic
-    };
-    private final static byte[] LNK_GUID = {
-            0x01, 0x14, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, // Shell Link GUID
-            (byte) 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 'F'
-    };
-
-    private final File target;
-
-    private static final int FLAG_ITEM_ID_LIST = 0x01;
-    private static final int FLAG_FILE_LOC_INFO = 0x02;
-    private static final int FLAG_DESC_STRING = 0x04;
-    private static final int FLAG_REL_PATH_STRING = 0x08;
-    private static final int FLAG_WORKING_DIRECTORY = 0x10;
-    private static final int FLAG_COMMAND_LINE_ARGS = 0x20;
-    private static final int FLAG_ICON_FILENAME = 0x40;
-    private static final int FLAG_ADDITIONAL_INFO = 0x80;
-
-    private Win32Lnk(final String pPath) throws IOException {
-        super(pPath);
-        File target = parse(this);
-        if (target == this) {
-            // NOTE: This is a workaround
-            // target = this causes infinite loops in some methods
-            target = new File(pPath);
-        }
-        this.target = target;
-    }
-
-    Win32Lnk(final File pPath) throws IOException {
-        this(pPath.getPath());
-    }
-
-    /**
-     * Parses a {@code .lnk} file to find the real file.
-     *
-     * @param pPath the path to the {@code .lnk} file
-     * @return a new file object that
-     * @throws java.io.IOException if the {@code .lnk} cannot be parsed
-     */
-    static File parse(final File pPath) throws IOException {
-        if (!pPath.getName().endsWith(".lnk")) {
-            return pPath;
-        }
-
-        File result = pPath;
-
-        LittleEndianDataInputStream in = new LittleEndianDataInputStream(new BufferedInputStream(new FileInputStream(pPath)));
-        try {
-            byte[] magic = new byte[4];
-            in.readFully(magic);
-
-            byte[] guid = new byte[16];
-            in.readFully(guid);
-
-            if (!(Arrays.equals(LNK_MAGIC, magic) && Arrays.equals(LNK_GUID, guid))) {
-                //System.out.println("Not a symlink");
-                // Not a symlink
-                return pPath;
-            }
-
-            // Get the flags
-            int flags = in.readInt();
-            //System.out.println("flags: " + Integer.toBinaryString(flags & 0xff));
-
-            // Get to the file settings
-            /*int attributes = */in.readInt();
-
-            // File attributes
-            // 0 Target is read only.
-            // 1 Target is hidden.
-            // 2 Target is a system file.
-            // 3 Target is a volume label. (Not possible)
-            // 4 Target is a directory.
-            // 5 Target has been modified since last backup. (archive)
-            // 6 Target is encrypted (NTFS EFS)
-            // 7 Target is Normal??
-            // 8 Target is temporary.
-            // 9 Target is a sparse file.
-            // 10 Target has reparse point data.
-            // 11 Target is compressed.
-            // 12 Target is offline.
-            //System.out.println("attributes: " + Integer.toBinaryString(attributes));
-            // NOTE: Cygwin .lnks are not directory links, can't rely on this.. :-/
-
-            in.skipBytes(48); // TODO: Make sense of this data...
-
-            // Skipped data:
-            // long time 1 (creation)
-            // long time 2 (modification)
-            // long time 3 (last access)
-            // int file length
-            // int icon number
-            // int ShowVnd value
-            // int hotkey
-            // int, int - unknown: 0,0
-
-            // If the shell settings are present, skip them
-            if ((flags & FLAG_ITEM_ID_LIST) != 0) {
-                // Shell Item Id List present
-                //System.out.println("Shell Item Id List present");
-                int shellLen = in.readShort(); // Short
-                //System.out.println("shellLen: " + shellLen);
-
-                // TODO: Probably need to parse this data, to determine
-                // Cygwin folders...
-
-                /*
-                int read = 2;
-                int itemLen = in.readShort();
-                while (itemLen > 0) {
-                    System.out.println("--> ITEM: " + itemLen);
-
-                    BufferedReader reader = new BufferedReader(new InputStreamReader(new SubStream(in, itemLen - 2)));
-                    //byte[] itemBytes = new byte[itemLen - 2]; // NOTE: Lenght included
-                    //in.readFully(itemBytes);
-
-                    String item = reader.readLine();
-                    System.out.println("item: \"" + item + "\"");
-
-                    itemLen = in.readShort();
-                    read += itemLen;
-                }
-
-                System.out.println("read: " + read);
-                */
-
-                in.skipBytes(shellLen);
-            }
-
-            if ((flags & FLAG_FILE_LOC_INFO) != 0) {
-                // File Location Info Table present
-                //System.out.println("File Location Info Table present");
-
-                // 0h 1 dword This is the total length of this structure and all following data
-                // 4h 1 dword This is a pointer to first offset after this structure. 1Ch
-                // 8h 1 dword Flags
-                // Ch 1 dword Offset of local volume info
-                // 10h 1 dword Offset of base pathname on local system
-                // 14h 1 dword Offset of network volume info
-                // 18h 1 dword Offset of remaining pathname
-
-                // Flags:
-                // Bit Meaning
-                // 0 Available on a local volume
-                // 1 Available on a network share
-                // TODO: Make sure the path is on a local disk, etc..
-
-                int tableLen = in.readInt(); // Int
-                //System.out.println("tableLen: " + tableLen);
-
-                in.readInt(); // Skip
-
-                int locFlags = in.readInt();
-                //System.out.println("locFlags: " + Integer.toBinaryString(locFlags));
-                if ((locFlags & 0x01) != 0) {
-                    //System.out.println("Available local");
-                }
-                if ((locFlags & 0x02) != 0) {
-                    //System.err.println("Available on network path");
-                }
-
-                // Get the local volume and local system values
-                in.skipBytes(4); // TODO: see above for structure
-
-                int localSysOff = in.readInt();
-                //System.out.println("localSysOff: " + localSysOff);
-                in.skipBytes(localSysOff - 20);  // Relative to start of chunk
-
-                byte[] pathBytes = new byte[tableLen - localSysOff - 1];
-                in.readFully(pathBytes, 0, pathBytes.length);
-                String path = new String(pathBytes, 0, pathBytes.length - 1);
-                /*
-                ByteArrayOutputStream bytes = new ByteArrayOutputStream();
-                byte read;
-                // Read bytes until the null (0) character
-                while (true) {
-                    read = in.readByte();
-                    if (read == 0) {
-                        break;
-                    }
-                    bytes.write(read & 0xff);
-                }
-
-                String path = new String(bytes.toByteArray(), 0, bytes.size());
-                //*/
-
-                // Recurse to end of link chain
-                // TODO: This may cause endless loop if cyclic chain...
-                //System.out.println("path: \"" + path + "\"");
-                try {
-                    result = parse(new File(path));
-                }
-                catch (StackOverflowError e) {
-                    throw new IOException("Cannot resolve cyclic link: " + e.getMessage());
-                }
-            }
-
-            if ((flags & FLAG_DESC_STRING) != 0) {
-                // Description String present, skip it.
-                //System.out.println("Description String present");
-
-                // The string length is the first word which must also be skipped.
-                int descLen = in.readShort();
-                //System.out.println("descLen: " + descLen);
-
-                byte[] descBytes = new byte[descLen];
-                in.readFully(descBytes, 0, descLen);
-
-                //String desc = new String(descBytes, 0, descLen);
-                //System.out.println("desc: " + desc);
-            }
-
-            if ((flags & FLAG_REL_PATH_STRING) != 0) {
-                // Relative Path String present
-                //System.out.println("Relative Path String present");
-
-                // The string length is the first word which must also be skipped.
-                int pathLen = in.readShort();
-                //System.out.println("pathLen: " + pathLen);
-
-                byte[] pathBytes = new byte[pathLen];
-                in.readFully(pathBytes, 0, pathLen);
-
-                String path = new String(pathBytes, 0, pathLen);
-
-                // TODO: This may cause endless loop if cyclic chain...
-                //System.out.println("path: \"" + path + "\"");
-                if (result == pPath) {
-                    try {
-                        result = parse(new File(pPath.getParentFile(), path));
-                    }
-                    catch (StackOverflowError e) {
-                        throw new IOException("Cannot resolve cyclic link: " + e.getMessage());
-                    }
-                }
-            }
-
-            if ((flags & FLAG_WORKING_DIRECTORY) != 0) {
-                //System.out.println("Working Directory present");
-            }
-            if ((flags & FLAG_COMMAND_LINE_ARGS) != 0) {
-                //System.out.println("Command Line Arguments present");
-                // NOTE: This means this .lnk is not a folder, don't follow
-                result = pPath;
-            }
-            if ((flags & FLAG_ICON_FILENAME) != 0) {
-                //System.out.println("Icon Filename present");
-            }
-            if ((flags & FLAG_ADDITIONAL_INFO) != 0) {
-                //System.out.println("Additional Info present");
-            }
-        }
-        finally {
-            in.close();
-        }
-
-        return result;
-    }
-
-    /*
-    private static String getNullDelimitedString(byte[] bytes, int off) {
-        int len = 0;
-        // Count bytes until the null (0) character
-        while (true) {
-            if (bytes[off + len] == 0) {
-                break;
-            }
-            len++;
-        }
-
-        System.err.println("--> " + len);
-
-        return new String(bytes, off, len);
-    }
-    */
-
-    /**
-     * Converts two bytes into a short.
-     * <p/>
-     * NOTE: this is little endian because it's for an
-     * Intel only OS
-     *
-     * @ param bytes
-     * @ param off
-     * @return the bytes as a short.
-     */
-    /*
-    private static int bytes2short(byte[] bytes, int off) {
-        return ((bytes[off + 1] & 0xff) << 8) | (bytes[off] & 0xff);
-    }
-    */
-
-    public File getTarget() {
-        return target;
-    }
-
-    // java.io.File overrides below
-
-    @Override
-    public boolean isDirectory() {
-        return target.isDirectory();
-    }
-
-    @Override
-    public boolean canRead() {
-        return target.canRead();
-    }
-
-    @Override
-    public boolean canWrite() {
-        return target.canWrite();
-    }
-
-    // NOTE: equals is implemented using compareto == 0
-    /*
-    public int compareTo(File pathname) {
-        // TODO: Verify this
-        // Probably not a good idea, as it IS NOT THE SAME file
-        // It's probably better to not override
-        return target.compareTo(pathname);
-    }
-    */
-
-    // Should probably never allow creating a new .lnk
-    // public boolean createNewFile() throws IOException
-
-    // Deletes only the .lnk
-    // public boolean delete() {
-    //public void deleteOnExit() {
-
-    @Override
-    public boolean exists() {
-        return target.exists();
-    }
-
-    // A .lnk may be absolute
-    //public File getAbsoluteFile() {
-    //public String getAbsolutePath() {
-
-    // Theses should be resolved according to the API (for Unix).
-    @Override
-    public File getCanonicalFile() throws IOException {
-        return target.getCanonicalFile();
-    }
-
-    @Override
-    public String getCanonicalPath() throws IOException {
-        return target.getCanonicalPath();
-    }
-
-    //public String getName() {
-
-    // I guess the parent should be the parent of the .lnk, not the target
-    //public String getParent() {
-    //public File getParentFile() {
-
-    // public boolean isAbsolute() {
-    @Override
-    public boolean isFile() {
-        return target.isFile();
-    }
-
-    @Override
-    public boolean isHidden() {
-        return target.isHidden();
-    }
-
-    @Override
-    public long lastModified() {
-        return target.lastModified();
-    }
-
-    @Override
-    public long length() {
-        return target.length();
-    }
-
-    @Override
-    public String[] list() {
-        return target.list();
-    }
-
-    @Override
-    public String[] list(final FilenameFilter filter) {
-        return target.list(filter);
-    }
-
-    @Override
-    public File[] listFiles() {
-        return Win32File.wrap(target.listFiles());
-    }
-
-    @Override
-    public File[] listFiles(final FileFilter filter) {
-        return Win32File.wrap(target.listFiles(filter));
-    }
-
-    @Override
-    public File[] listFiles(final FilenameFilter filter) {
-        return Win32File.wrap(target.listFiles(filter));
-    }
-
-    // Makes no sense, does it?
-    //public boolean mkdir() {
-    //public boolean mkdirs() {
-
-    // Only rename the lnk
-    //public boolean renameTo(File dest) {
-
-    @Override
-    public boolean setLastModified(long time) {
-        return target.setLastModified(time);
-    }
-
-    @Override
-    public boolean setReadOnly() {
-        return target.setReadOnly();
-    }
-
-    @Override
-    public String toString() {
-        if (target.equals(this)) {
-            return super.toString();
-        }
-        return super.toString() + " -> " + target.toString();
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import java.io.*;
+import java.util.Arrays;
+
+/**
+ * A {@code File} implementation that resolves the Windows {@code .lnk} files as symbolic links.
+ * <p>
+ * This class is based on example code from
+ * <a href="http://www.oreilly.com/catalog/swinghks/index.html">Swing Hacks</a>,
+ * By Joshua Marinacci, Chris Adamson (O'Reilly, ISBN: 0-596-00907-0), Hack 30.
+ * </p>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32Lnk.java#2 $
+ */
+final class Win32Lnk extends File {
+    private final static byte[] LNK_MAGIC = {
+            'L', 0x00, 0x00, 0x00, // Magic
+    };
+    private final static byte[] LNK_GUID = {
+            0x01, 0x14, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, // Shell Link GUID
+            (byte) 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 'F'
+    };
+
+    private final File target;
+
+    private static final int FLAG_ITEM_ID_LIST = 0x01;
+    private static final int FLAG_FILE_LOC_INFO = 0x02;
+    private static final int FLAG_DESC_STRING = 0x04;
+    private static final int FLAG_REL_PATH_STRING = 0x08;
+    private static final int FLAG_WORKING_DIRECTORY = 0x10;
+    private static final int FLAG_COMMAND_LINE_ARGS = 0x20;
+    private static final int FLAG_ICON_FILENAME = 0x40;
+    private static final int FLAG_ADDITIONAL_INFO = 0x80;
+
+    private Win32Lnk(final String pPath) throws IOException {
+        super(pPath);
+        File target = parse(this);
+        if (target == this) {
+            // NOTE: This is a workaround
+            // target = this causes infinite loops in some methods
+            target = new File(pPath);
+        }
+        this.target = target;
+    }
+
+    Win32Lnk(final File pPath) throws IOException {
+        this(pPath.getPath());
+    }
+
+    /**
+     * Parses a {@code .lnk} file to find the real file.
+     *
+     * @param pPath the path to the {@code .lnk} file
+     * @return a new file object that
+     * @throws java.io.IOException if the {@code .lnk} cannot be parsed
+     */
+    static File parse(final File pPath) throws IOException {
+        if (!pPath.getName().endsWith(".lnk")) {
+            return pPath;
+        }
+
+        File result = pPath;
+
+        LittleEndianDataInputStream in = new LittleEndianDataInputStream(new BufferedInputStream(new FileInputStream(pPath)));
+        try {
+            byte[] magic = new byte[4];
+            in.readFully(magic);
+
+            byte[] guid = new byte[16];
+            in.readFully(guid);
+
+            if (!(Arrays.equals(LNK_MAGIC, magic) && Arrays.equals(LNK_GUID, guid))) {
+                //System.out.println("Not a symlink");
+                // Not a symlink
+                return pPath;
+            }
+
+            // Get the flags
+            int flags = in.readInt();
+            //System.out.println("flags: " + Integer.toBinaryString(flags & 0xff));
+
+            // Get to the file settings
+            /*int attributes = */in.readInt();
+
+            // File attributes
+            // 0 Target is read only.
+            // 1 Target is hidden.
+            // 2 Target is a system file.
+            // 3 Target is a volume label. (Not possible)
+            // 4 Target is a directory.
+            // 5 Target has been modified since last backup. (archive)
+            // 6 Target is encrypted (NTFS EFS)
+            // 7 Target is Normal??
+            // 8 Target is temporary.
+            // 9 Target is a sparse file.
+            // 10 Target has reparse point data.
+            // 11 Target is compressed.
+            // 12 Target is offline.
+            //System.out.println("attributes: " + Integer.toBinaryString(attributes));
+            // NOTE: Cygwin .lnks are not directory links, can't rely on this.. :-/
+
+            in.skipBytes(48); // TODO: Make sense of this data...
+
+            // Skipped data:
+            // long time 1 (creation)
+            // long time 2 (modification)
+            // long time 3 (last access)
+            // int file length
+            // int icon number
+            // int ShowVnd value
+            // int hotkey
+            // int, int - unknown: 0,0
+
+            // If the shell settings are present, skip them
+            if ((flags & FLAG_ITEM_ID_LIST) != 0) {
+                // Shell Item Id List present
+                //System.out.println("Shell Item Id List present");
+                int shellLen = in.readShort(); // Short
+                //System.out.println("shellLen: " + shellLen);
+
+                // TODO: Probably need to parse this data, to determine
+                // Cygwin folders...
+
+                /*
+                int read = 2;
+                int itemLen = in.readShort();
+                while (itemLen > 0) {
+                    System.out.println("--> ITEM: " + itemLen);
+
+                    BufferedReader reader = new BufferedReader(new InputStreamReader(new SubStream(in, itemLen - 2)));
+                    //byte[] itemBytes = new byte[itemLen - 2]; // NOTE: Lenght included
+                    //in.readFully(itemBytes);
+
+                    String item = reader.readLine();
+                    System.out.println("item: \"" + item + "\"");
+
+                    itemLen = in.readShort();
+                    read += itemLen;
+                }
+
+                System.out.println("read: " + read);
+                */
+
+                in.skipBytes(shellLen);
+            }
+
+            if ((flags & FLAG_FILE_LOC_INFO) != 0) {
+                // File Location Info Table present
+                //System.out.println("File Location Info Table present");
+
+                // 0h 1 dword This is the total length of this structure and all following data
+                // 4h 1 dword This is a pointer to first offset after this structure. 1Ch
+                // 8h 1 dword Flags
+                // Ch 1 dword Offset of local volume info
+                // 10h 1 dword Offset of base pathname on local system
+                // 14h 1 dword Offset of network volume info
+                // 18h 1 dword Offset of remaining pathname
+
+                // Flags:
+                // Bit Meaning
+                // 0 Available on a local volume
+                // 1 Available on a network share
+                // TODO: Make sure the path is on a local disk, etc..
+
+                int tableLen = in.readInt(); // Int
+                //System.out.println("tableLen: " + tableLen);
+
+                in.readInt(); // Skip
+
+                int locFlags = in.readInt();
+                //System.out.println("locFlags: " + Integer.toBinaryString(locFlags));
+                if ((locFlags & 0x01) != 0) {
+                    //System.out.println("Available local");
+                }
+                if ((locFlags & 0x02) != 0) {
+                    //System.err.println("Available on network path");
+                }
+
+                // Get the local volume and local system values
+                in.skipBytes(4); // TODO: see above for structure
+
+                int localSysOff = in.readInt();
+                //System.out.println("localSysOff: " + localSysOff);
+                in.skipBytes(localSysOff - 20);  // Relative to start of chunk
+
+                byte[] pathBytes = new byte[tableLen - localSysOff - 1];
+                in.readFully(pathBytes, 0, pathBytes.length);
+                String path = new String(pathBytes, 0, pathBytes.length - 1);
+                /*
+                ByteArrayOutputStream bytes = new ByteArrayOutputStream();
+                byte read;
+                // Read bytes until the null (0) character
+                while (true) {
+                    read = in.readByte();
+                    if (read == 0) {
+                        break;
+                    }
+                    bytes.write(read & 0xff);
+                }
+
+                String path = new String(bytes.toByteArray(), 0, bytes.size());
+                //*/
+
+                // Recurse to end of link chain
+                // TODO: This may cause endless loop if cyclic chain...
+                //System.out.println("path: \"" + path + "\"");
+                try {
+                    result = parse(new File(path));
+                }
+                catch (StackOverflowError e) {
+                    throw new IOException("Cannot resolve cyclic link: " + e.getMessage());
+                }
+            }
+
+            if ((flags & FLAG_DESC_STRING) != 0) {
+                // Description String present, skip it.
+                //System.out.println("Description String present");
+
+                // The string length is the first word which must also be skipped.
+                int descLen = in.readShort();
+                //System.out.println("descLen: " + descLen);
+
+                byte[] descBytes = new byte[descLen];
+                in.readFully(descBytes, 0, descLen);
+
+                //String desc = new String(descBytes, 0, descLen);
+                //System.out.println("desc: " + desc);
+            }
+
+            if ((flags & FLAG_REL_PATH_STRING) != 0) {
+                // Relative Path String present
+                //System.out.println("Relative Path String present");
+
+                // The string length is the first word which must also be skipped.
+                int pathLen = in.readShort();
+                //System.out.println("pathLen: " + pathLen);
+
+                byte[] pathBytes = new byte[pathLen];
+                in.readFully(pathBytes, 0, pathLen);
+
+                String path = new String(pathBytes, 0, pathLen);
+
+                // TODO: This may cause endless loop if cyclic chain...
+                //System.out.println("path: \"" + path + "\"");
+                if (result == pPath) {
+                    try {
+                        result = parse(new File(pPath.getParentFile(), path));
+                    }
+                    catch (StackOverflowError e) {
+                        throw new IOException("Cannot resolve cyclic link: " + e.getMessage());
+                    }
+                }
+            }
+
+            if ((flags & FLAG_WORKING_DIRECTORY) != 0) {
+                //System.out.println("Working Directory present");
+            }
+            if ((flags & FLAG_COMMAND_LINE_ARGS) != 0) {
+                //System.out.println("Command Line Arguments present");
+                // NOTE: This means this .lnk is not a folder, don't follow
+                result = pPath;
+            }
+            if ((flags & FLAG_ICON_FILENAME) != 0) {
+                //System.out.println("Icon Filename present");
+            }
+            if ((flags & FLAG_ADDITIONAL_INFO) != 0) {
+                //System.out.println("Additional Info present");
+            }
+        }
+        finally {
+            in.close();
+        }
+
+        return result;
+    }
+
+    /*
+    private static String getNullDelimitedString(byte[] bytes, int off) {
+        int len = 0;
+        // Count bytes until the null (0) character
+        while (true) {
+            if (bytes[off + len] == 0) {
+                break;
+            }
+            len++;
+        }
+
+        System.err.println("--> " + len);
+
+        return new String(bytes, off, len);
+    }
+    */
+
+    /**
+     * Converts two bytes into a short.
+     * <p>
+     * NOTE: this is little endian because it's for an
+     * Intel only OS
+     * </p>
+     *
+     * @ param bytes
+     * @ param off
+     * @return the bytes as a short.
+     */
+    /*
+    private static int bytes2short(byte[] bytes, int off) {
+        return ((bytes[off + 1] & 0xff) << 8) | (bytes[off] & 0xff);
+    }
+    */
+
+    public File getTarget() {
+        return target;
+    }
+
+    // java.io.File overrides below
+
+    @Override
+    public boolean isDirectory() {
+        return target.isDirectory();
+    }
+
+    @Override
+    public boolean canRead() {
+        return target.canRead();
+    }
+
+    @Override
+    public boolean canWrite() {
+        return target.canWrite();
+    }
+
+    // NOTE: equals is implemented using compareto == 0
+    /*
+    public int compareTo(File pathname) {
+        // TODO: Verify this
+        // Probably not a good idea, as it IS NOT THE SAME file
+        // It's probably better to not override
+        return target.compareTo(pathname);
+    }
+    */
+
+    // Should probably never allow creating a new .lnk
+    // public boolean createNewFile() throws IOException
+
+    // Deletes only the .lnk
+    // public boolean delete() {
+    //public void deleteOnExit() {
+
+    @Override
+    public boolean exists() {
+        return target.exists();
+    }
+
+    // A .lnk may be absolute
+    //public File getAbsoluteFile() {
+    //public String getAbsolutePath() {
+
+    // Theses should be resolved according to the API (for Unix).
+    @Override
+    public File getCanonicalFile() throws IOException {
+        return target.getCanonicalFile();
+    }
+
+    @Override
+    public String getCanonicalPath() throws IOException {
+        return target.getCanonicalPath();
+    }
+
+    //public String getName() {
+
+    // I guess the parent should be the parent of the .lnk, not the target
+    //public String getParent() {
+    //public File getParentFile() {
+
+    // public boolean isAbsolute() {
+    @Override
+    public boolean isFile() {
+        return target.isFile();
+    }
+
+    @Override
+    public boolean isHidden() {
+        return target.isHidden();
+    }
+
+    @Override
+    public long lastModified() {
+        return target.lastModified();
+    }
+
+    @Override
+    public long length() {
+        return target.length();
+    }
+
+    @Override
+    public String[] list() {
+        return target.list();
+    }
+
+    @Override
+    public String[] list(final FilenameFilter filter) {
+        return target.list(filter);
+    }
+
+    @Override
+    public File[] listFiles() {
+        return Win32File.wrap(target.listFiles());
+    }
+
+    @Override
+    public File[] listFiles(final FileFilter filter) {
+        return Win32File.wrap(target.listFiles(filter));
+    }
+
+    @Override
+    public File[] listFiles(final FilenameFilter filter) {
+        return Win32File.wrap(target.listFiles(filter));
+    }
+
+    // Makes no sense, does it?
+    //public boolean mkdir() {
+    //public boolean mkdirs() {
+
+    // Only rename the lnk
+    //public boolean renameTo(File dest) {
+
+    @Override
+    public boolean setLastModified(long time) {
+        return target.setLastModified(time);
+    }
+
+    @Override
+    public boolean setReadOnly() {
+        return target.setReadOnly();
+    }
+
+    @Override
+    public String toString() {
+        if (target.equals(this)) {
+            return super.toString();
+        }
+        return super.toString() + " -> " + target.toString();
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/WriterOutputStream.java

@@ -1,239 +1,240 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io;
-
-import com.twelvemonkeys.lang.DateUtil;
-
-import java.io.*;
-import java.nio.ByteBuffer;
-import java.nio.CharBuffer;
-import java.nio.charset.Charset;
-
-/**
- * Wraps a {@code Writer} in an {@code OutputStream}.
- * <p/>
- * <em>Instances of this class are not thread-safe.</em>
- * <p/>
- * <em>NOTE: This class is probably not the right way of solving your problem,
- * however it might prove useful in JSPs etc.
- * If possible, it's always better to use the {@code Writer}'s underlying
- * {@code OutputStream}, or wrap it's native backing.
- * </em>
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/WriterOutputStream.java#2 $
- */
-public class WriterOutputStream extends OutputStream {
-    protected Writer writer;
-    final protected Decoder decoder;
-    final ByteArrayOutputStream bufferStream = new FastByteArrayOutputStream(1024);
-
-    private volatile boolean isFlushing = false; // Ugly but critical...
-
-    private static final boolean NIO_AVAILABLE = isNIOAvailable();
-
-    private static boolean isNIOAvailable() {
-        try {
-            Class.forName("java.nio.charset.Charset");
-            return true;
-        }
-        catch (Throwable t) {
-            // Ignore
-        }
-
-        return false;
-    }
-
-    public WriterOutputStream(final Writer pWriter, final String pCharset) {
-        writer = pWriter;
-        decoder = getDecoder(pCharset);
-    }
-
-    public WriterOutputStream(final Writer pWriter) {
-        this(pWriter, null);
-    }
-
-    private static Decoder getDecoder(final String pCharset) {
-        // NOTE: The CharsetDecoder is typically 10-20% faster than
-        // StringDecoder according to my tests
-        // StringEncoder is horribly slow on 1.2 systems, but there's no
-        // alternative...
-        if (NIO_AVAILABLE) {
-            return new CharsetDecoder(pCharset);
-        }
-
-        return new StringDecoder(pCharset);
-    }
-
-    @Override
-    public void close() throws IOException {
-        flush();
-        writer.close();
-        writer = null;
-    }
-
-    @Override
-    public void flush() throws IOException {
-        flushBuffer();
-        writer.flush();
-    }
-
-    @Override
-    public final void write(byte[] pBytes) throws IOException {
-        if (pBytes == null) {
-            throw new NullPointerException("bytes == null");
-        }
-        write(pBytes, 0, pBytes.length);
-    }
-
-    @Override
-    public final void write(byte[] pBytes, int pOffset, int pLength) throws IOException {
-        flushBuffer();
-        decoder.decodeTo(writer, pBytes, pOffset, pLength);
-    }
-
-    @Override
-    public final void write(int pByte)  {
-        // TODO: Is it possible to know if this is a good place in the stream to
-        // flush? It might be in the middle of a multi-byte encoded character..
-        bufferStream.write(pByte);
-    }
-
-    private void flushBuffer() throws IOException {
-        if (!isFlushing && bufferStream.size() > 0) {
-            isFlushing = true;
-            bufferStream.writeTo(this); // NOTE: Avoids cloning buffer array
-            bufferStream.reset();
-            isFlushing = false;
-        }
-    }
-
-    ///////////////////////////////////////////////////////////////////////////
-    public static void main(String[] pArgs) throws IOException {
-        int iterations = 1000000;
-
-        byte[] bytes = "������ klashf lkash ljah lhaaklhghdfgu ksd".getBytes("UTF-8");
-
-        Decoder d;
-        long start;
-        long time;
-        Writer sink = new PrintWriter(new NullOutputStream());
-        StringWriter writer;
-        String str;
-
-        d = new StringDecoder("UTF-8");
-        for (int i = 0; i < 10000; i++) {
-            d.decodeTo(sink, bytes, 0, bytes.length);
-        }
-        start = System.currentTimeMillis();
-        for (int i = 0; i < iterations; i++) {
-            d.decodeTo(sink, bytes, 0, bytes.length);
-        }
-        time = DateUtil.delta(start);
-        System.out.println("StringDecoder");
-        System.out.println("time: " + time);
-
-        writer = new StringWriter();
-        d.decodeTo(writer, bytes, 0, bytes.length);
-        str = writer.toString();
-        System.out.println("str: \"" + str + "\"");
-        System.out.println("chars.length: " + str.length());
-        System.out.println();
-
-        if (NIO_AVAILABLE) {
-            d = new CharsetDecoder("UTF-8");
-            for (int i = 0; i < 10000; i++) {
-                d.decodeTo(sink, bytes, 0, bytes.length);
-            }
-            start = System.currentTimeMillis();
-            for (int i = 0; i < iterations; i++) {
-                d.decodeTo(sink, bytes, 0, bytes.length);
-            }
-            time = DateUtil.delta(start);
-            System.out.println("CharsetDecoder");
-            System.out.println("time: " + time);
-            writer = new StringWriter();
-            d.decodeTo(writer, bytes, 0, bytes.length);
-            str = writer.toString();
-            System.out.println("str: \"" + str + "\"");
-            System.out.println("chars.length: " + str.length());
-            System.out.println();
-        }
-
-        OutputStream os = new WriterOutputStream(new PrintWriter(System.out), "UTF-8");
-        os.write(bytes);
-        os.flush();
-        System.out.println();
-
-        for (byte b : bytes) {
-            os.write(b & 0xff);
-        }
-        os.flush();
-    }
-
-    ///////////////////////////////////////////////////////////////////////////
-    private static interface Decoder {
-        void decodeTo(Writer pWriter, byte[] pBytes, int pOffset, int pLength) throws IOException;
-    }
-
-    private static final class CharsetDecoder implements Decoder {
-        final Charset mCharset;
-
-        CharsetDecoder(String pCharset) {
-            // Handle null-case, to get default charset
-            String charset = pCharset != null ? pCharset :
-                    System.getProperty("file.encoding", "ISO-8859-1");
-            mCharset = Charset.forName(charset);
-        }
-
-        public void decodeTo(Writer pWriter, byte[] pBytes, int pOffset, int pLength) throws IOException {
-            CharBuffer cb = mCharset.decode(ByteBuffer.wrap(pBytes, pOffset, pLength));
-            pWriter.write(cb.array(), 0, cb.length());
-        }
-    }
-
-    private static final class StringDecoder implements Decoder {
-        final String mCharset;
-
-        StringDecoder(String pCharset) {
-            mCharset = pCharset;
-        }
-
-        public void decodeTo(Writer pWriter, byte[] pBytes, int pOffset, int pLength) throws IOException {
-            String str = mCharset == null ?
-                    new String(pBytes, pOffset, pLength) :
-                    new String(pBytes, pOffset, pLength, mCharset);
-
-            pWriter.write(str);
-        }
-    }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io;
+
+import com.twelvemonkeys.lang.DateUtil;
+
+import java.io.*;
+import java.nio.ByteBuffer;
+import java.nio.CharBuffer;
+import java.nio.charset.Charset;
+
+/**
+ * Wraps a {@code Writer} in an {@code OutputStream}.
+ * <p>
+ * <em>Instances of this class are not thread-safe.</em>
+ * </p>
+ * <p>
+ * <em>NOTE: This class is probably not the right way of solving your problem,
+ * however it might prove useful in JSPs etc.
+ * If possible, it's always better to use the {@code Writer}'s underlying
+ * {@code OutputStream}, or wrap it's native backing.
+ * </em>
+ * </p>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/WriterOutputStream.java#2 $
+ */
+public class WriterOutputStream extends OutputStream {
+    protected Writer writer;
+    final protected Decoder decoder;
+    final ByteArrayOutputStream bufferStream = new FastByteArrayOutputStream(1024);
+
+    private volatile boolean isFlushing = false; // Ugly but critical...
+
+    private static final boolean NIO_AVAILABLE = isNIOAvailable();
+
+    private static boolean isNIOAvailable() {
+        try {
+            Class.forName("java.nio.charset.Charset");
+            return true;
+        }
+        catch (Throwable t) {
+            // Ignore
+        }
+
+        return false;
+    }
+
+    public WriterOutputStream(final Writer pWriter, final String pCharset) {
+        writer = pWriter;
+        decoder = getDecoder(pCharset);
+    }
+
+    public WriterOutputStream(final Writer pWriter) {
+        this(pWriter, null);
+    }
+
+    private static Decoder getDecoder(final String pCharset) {
+        // NOTE: The CharsetDecoder is typically 10-20% faster than
+        // StringDecoder according to my tests
+        // StringEncoder is horribly slow on 1.2 systems, but there's no
+        // alternative...
+        if (NIO_AVAILABLE) {
+            return new CharsetDecoder(pCharset);
+        }
+
+        return new StringDecoder(pCharset);
+    }
+
+    @Override
+    public void close() throws IOException {
+        flush();
+        writer.close();
+        writer = null;
+    }
+
+    @Override
+    public void flush() throws IOException {
+        flushBuffer();
+        writer.flush();
+    }
+
+    @Override
+    public final void write(byte[] pBytes) throws IOException {
+        if (pBytes == null) {
+            throw new NullPointerException("bytes == null");
+        }
+        write(pBytes, 0, pBytes.length);
+    }
+
+    @Override
+    public final void write(byte[] pBytes, int pOffset, int pLength) throws IOException {
+        flushBuffer();
+        decoder.decodeTo(writer, pBytes, pOffset, pLength);
+    }
+
+    @Override
+    public final void write(int pByte)  {
+        // TODO: Is it possible to know if this is a good place in the stream to
+        // flush? It might be in the middle of a multi-byte encoded character..
+        bufferStream.write(pByte);
+    }
+
+    private void flushBuffer() throws IOException {
+        if (!isFlushing && bufferStream.size() > 0) {
+            isFlushing = true;
+            bufferStream.writeTo(this); // NOTE: Avoids cloning buffer array
+            bufferStream.reset();
+            isFlushing = false;
+        }
+    }
+
+    ///////////////////////////////////////////////////////////////////////////
+    public static void main(String[] pArgs) throws IOException {
+        int iterations = 1000000;
+
+        byte[] bytes = "������ klashf lkash ljah lhaaklhghdfgu ksd".getBytes("UTF-8");
+
+        Decoder d;
+        long start;
+        long time;
+        Writer sink = new PrintWriter(new NullOutputStream());
+        StringWriter writer;
+        String str;
+
+        d = new StringDecoder("UTF-8");
+        for (int i = 0; i < 10000; i++) {
+            d.decodeTo(sink, bytes, 0, bytes.length);
+        }
+        start = System.currentTimeMillis();
+        for (int i = 0; i < iterations; i++) {
+            d.decodeTo(sink, bytes, 0, bytes.length);
+        }
+        time = DateUtil.delta(start);
+        System.out.println("StringDecoder");
+        System.out.println("time: " + time);
+
+        writer = new StringWriter();
+        d.decodeTo(writer, bytes, 0, bytes.length);
+        str = writer.toString();
+        System.out.println("str: \"" + str + "\"");
+        System.out.println("chars.length: " + str.length());
+        System.out.println();
+
+        if (NIO_AVAILABLE) {
+            d = new CharsetDecoder("UTF-8");
+            for (int i = 0; i < 10000; i++) {
+                d.decodeTo(sink, bytes, 0, bytes.length);
+            }
+            start = System.currentTimeMillis();
+            for (int i = 0; i < iterations; i++) {
+                d.decodeTo(sink, bytes, 0, bytes.length);
+            }
+            time = DateUtil.delta(start);
+            System.out.println("CharsetDecoder");
+            System.out.println("time: " + time);
+            writer = new StringWriter();
+            d.decodeTo(writer, bytes, 0, bytes.length);
+            str = writer.toString();
+            System.out.println("str: \"" + str + "\"");
+            System.out.println("chars.length: " + str.length());
+            System.out.println();
+        }
+
+        OutputStream os = new WriterOutputStream(new PrintWriter(System.out), "UTF-8");
+        os.write(bytes);
+        os.flush();
+        System.out.println();
+
+        for (byte b : bytes) {
+            os.write(b & 0xff);
+        }
+        os.flush();
+    }
+
+    ///////////////////////////////////////////////////////////////////////////
+    private static interface Decoder {
+        void decodeTo(Writer pWriter, byte[] pBytes, int pOffset, int pLength) throws IOException;
+    }
+
+    private static final class CharsetDecoder implements Decoder {
+        final Charset mCharset;
+
+        CharsetDecoder(String pCharset) {
+            // Handle null-case, to get default charset
+            String charset = pCharset != null ? pCharset :
+                    System.getProperty("file.encoding", "ISO-8859-1");
+            mCharset = Charset.forName(charset);
+        }
+
+        public void decodeTo(Writer pWriter, byte[] pBytes, int pOffset, int pLength) throws IOException {
+            CharBuffer cb = mCharset.decode(ByteBuffer.wrap(pBytes, pOffset, pLength));
+            pWriter.write(cb.array(), 0, cb.length());
+        }
+    }
+
+    private static final class StringDecoder implements Decoder {
+        final String mCharset;
+
+        StringDecoder(String pCharset) {
+            mCharset = pCharset;
+        }
+
+        public void decodeTo(Writer pWriter, byte[] pBytes, int pOffset, int pLength) throws IOException {
+            String str = mCharset == null ?
+                    new String(pBytes, pOffset, pLength) :
+                    new String(pBytes, pOffset, pLength, mCharset);
+
+            pWriter.write(str);
+        }
+    }
 }

common/common-io/src/main/java/com/twelvemonkeys/io/enc/Base64Decoder.java

@@ -1,188 +1,188 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.nio.ByteBuffer;
-
-/**
- * {@code Decoder} implementation for standard base64 encoding.
- * <p/>
- * @see <a href="http://tools.ietf.org/html/rfc1421">RFC 1421</a>
- * @see <a href="http://tools.ietf.org/html/rfc2045"RFC 2045</a>
- *
- * @see Base64Encoder
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Base64Decoder.java#2 $
- */
-public final class Base64Decoder implements Decoder {
-    /**
-     * This array maps the characters to their 6 bit values
-     */
-    final static byte[] PEM_ARRAY = {
-            //0   1    2    3    4    5    6    7
-            'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', // 0
-            'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', // 1
-            'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', // 2
-            'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', // 3
-            'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', // 4
-            'o', 'p', 'q', 'r', 's', 't', 'u', 'v', // 5
-            'w', 'x', 'y', 'z', '0', '1', '2', '3', // 6
-            '4', '5', '6', '7', '8', '9', '+', '/'  // 7
-    };
-
-    final static byte[] PEM_CONVERT_ARRAY;
-
-    private byte[] decodeBuffer = new byte[4];
-
-    static {
-        PEM_CONVERT_ARRAY = new byte[256];
-
-        for (int i = 0; i < 255; i++) {
-            PEM_CONVERT_ARRAY[i] = -1;
-        }
-
-        for (int i = 0; i < PEM_ARRAY.length; i++) {
-            PEM_CONVERT_ARRAY[PEM_ARRAY[i]] = (byte) i;
-        }
-    }
-
-    protected static int readFully(final InputStream pStream, final byte pBytes[], final int pOffset, final int pLength)
-            throws IOException
-    {
-        for (int i = 0; i < pLength; i++) {
-            int read = pStream.read();
-
-            if (read == -1) {
-                return i != 0 ? i : -1;
-            }
-
-            pBytes[i + pOffset] = (byte) read;
-        }
-
-        return pLength;
-    }
-
-    protected boolean decodeAtom(final InputStream pInput, final ByteBuffer pOutput, final int pLength)
-            throws IOException {
-
-        byte byte0 = -1;
-        byte byte1 = -1;
-        byte byte2 = -1;
-        byte byte3 = -1;
-
-        if (pLength < 2) {
-            throw new IOException("BASE64Decoder: Not enough bytes for an atom.");
-        }
-
-        int read;
-
-        // Skip line feeds
-        do {
-            read = pInput.read();
-
-            if (read == -1) {
-                return false;
-            }
-        } while (read == 10 || read == 13);
-
-        decodeBuffer[0] = (byte) read;
-        read = readFully(pInput, decodeBuffer, 1, pLength - 1);
-
-        if (read == -1) {
-            return false;
-        }
-
-        int length = pLength;
-
-        if (length > 3 && decodeBuffer[3] == 61) {
-            length = 3;
-        }
-
-        if (length > 2 && decodeBuffer[2] == 61) {
-            length = 2;
-        }
-
-        switch (length) {
-            case 4:
-                byte3 = PEM_CONVERT_ARRAY[decodeBuffer[3] & 255];
-                // fall through
-            case 3:
-                byte2 = PEM_CONVERT_ARRAY[decodeBuffer[2] & 255];
-                // fall through
-            case 2:
-                byte1 = PEM_CONVERT_ARRAY[decodeBuffer[1] & 255];
-                byte0 = PEM_CONVERT_ARRAY[decodeBuffer[0] & 255];
-                // fall through
-            default:
-                switch (length) {
-                    case 2:
-                        pOutput.put((byte) (byte0 << 2 & 252 | byte1 >>> 4 & 3));
-                        break;
-                    case 3:
-                        pOutput.put((byte) (byte0 << 2 & 252 | byte1 >>> 4 & 3));
-                        pOutput.put((byte) (byte1 << 4 & 240 | byte2 >>> 2 & 15));
-                        break;
-                    case 4:
-                        pOutput.put((byte) (byte0 << 2 & 252 | byte1 >>> 4 & 3));
-                        pOutput.put((byte) (byte1 << 4 & 240 | byte2 >>> 2 & 15));
-                        pOutput.put((byte) (byte2 << 6 & 192 | byte3 & 63));
-                        break;
-                }
-
-                break;
-        }
-
-        return true;
-    }
-
-    public int decode(final InputStream stream, final ByteBuffer buffer) throws IOException {
-        do {
-            int k = 72;
-            int i;
-
-            for (i = 0; i + 4 < k; i += 4) {
-                if(!decodeAtom(stream, buffer, 4)) {
-                    break;
-                }
-            }
-
-            if (!decodeAtom(stream, buffer, k - i)) {
-                break;
-            }
-        }
-        while (buffer.remaining() > 54); // 72 char lines should produce no more than 54 bytes
-
-        return buffer.position();
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * {@code Decoder} implementation for standard base64 encoding.
+ *
+ * @see <a href="http://tools.ietf.org/html/rfc1421">RFC 1421</a>
+ * @see <a href="http://tools.ietf.org/html/rfc2045">RFC 2045</a>
+ *
+ * @see Base64Encoder
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Base64Decoder.java#2 $
+ */
+public final class Base64Decoder implements Decoder {
+    /**
+     * This array maps the characters to their 6 bit values
+     */
+    final static byte[] PEM_ARRAY = {
+            //0   1    2    3    4    5    6    7
+            'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', // 0
+            'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', // 1
+            'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', // 2
+            'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', // 3
+            'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', // 4
+            'o', 'p', 'q', 'r', 's', 't', 'u', 'v', // 5
+            'w', 'x', 'y', 'z', '0', '1', '2', '3', // 6
+            '4', '5', '6', '7', '8', '9', '+', '/'  // 7
+    };
+
+    final static byte[] PEM_CONVERT_ARRAY;
+
+    private byte[] decodeBuffer = new byte[4];
+
+    static {
+        PEM_CONVERT_ARRAY = new byte[256];
+
+        for (int i = 0; i < 255; i++) {
+            PEM_CONVERT_ARRAY[i] = -1;
+        }
+
+        for (int i = 0; i < PEM_ARRAY.length; i++) {
+            PEM_CONVERT_ARRAY[PEM_ARRAY[i]] = (byte) i;
+        }
+    }
+
+    protected static int readFully(final InputStream pStream, final byte pBytes[], final int pOffset, final int pLength)
+            throws IOException
+    {
+        for (int i = 0; i < pLength; i++) {
+            int read = pStream.read();
+
+            if (read == -1) {
+                return i != 0 ? i : -1;
+            }
+
+            pBytes[i + pOffset] = (byte) read;
+        }
+
+        return pLength;
+    }
+
+    protected boolean decodeAtom(final InputStream pInput, final ByteBuffer pOutput, final int pLength)
+            throws IOException {
+
+        byte byte0 = -1;
+        byte byte1 = -1;
+        byte byte2 = -1;
+        byte byte3 = -1;
+
+        if (pLength < 2) {
+            throw new IOException("BASE64Decoder: Not enough bytes for an atom.");
+        }
+
+        int read;
+
+        // Skip line feeds
+        do {
+            read = pInput.read();
+
+            if (read == -1) {
+                return false;
+            }
+        } while (read == 10 || read == 13);
+
+        decodeBuffer[0] = (byte) read;
+        read = readFully(pInput, decodeBuffer, 1, pLength - 1);
+
+        if (read == -1) {
+            return false;
+        }
+
+        int length = pLength;
+
+        if (length > 3 && decodeBuffer[3] == 61) {
+            length = 3;
+        }
+
+        if (length > 2 && decodeBuffer[2] == 61) {
+            length = 2;
+        }
+
+        switch (length) {
+            case 4:
+                byte3 = PEM_CONVERT_ARRAY[decodeBuffer[3] & 255];
+                // fall through
+            case 3:
+                byte2 = PEM_CONVERT_ARRAY[decodeBuffer[2] & 255];
+                // fall through
+            case 2:
+                byte1 = PEM_CONVERT_ARRAY[decodeBuffer[1] & 255];
+                byte0 = PEM_CONVERT_ARRAY[decodeBuffer[0] & 255];
+                // fall through
+            default:
+                switch (length) {
+                    case 2:
+                        pOutput.put((byte) (byte0 << 2 & 252 | byte1 >>> 4 & 3));
+                        break;
+                    case 3:
+                        pOutput.put((byte) (byte0 << 2 & 252 | byte1 >>> 4 & 3));
+                        pOutput.put((byte) (byte1 << 4 & 240 | byte2 >>> 2 & 15));
+                        break;
+                    case 4:
+                        pOutput.put((byte) (byte0 << 2 & 252 | byte1 >>> 4 & 3));
+                        pOutput.put((byte) (byte1 << 4 & 240 | byte2 >>> 2 & 15));
+                        pOutput.put((byte) (byte2 << 6 & 192 | byte3 & 63));
+                        break;
+                }
+
+                break;
+        }
+
+        return true;
+    }
+
+    public int decode(final InputStream stream, final ByteBuffer buffer) throws IOException {
+        do {
+            int k = 72;
+            int i;
+
+            for (i = 0; i + 4 < k; i += 4) {
+                if(!decodeAtom(stream, buffer, 4)) {
+                    break;
+                }
+            }
+
+            if (!decodeAtom(stream, buffer, k - i)) {
+                break;
+            }
+        }
+        while (buffer.remaining() > 54); // 72 char lines should produce no more than 54 bytes
+
+        return buffer.position();
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/Base64Encoder.java

@@ -1,106 +1,106 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-
-/**
- * {@code Encoder} implementation for standard base64 encoding.
- * <p/>
- * @see <a href="http://tools.ietf.org/html/rfc1421">RFC 1421</a>
- * @see <a href="http://tools.ietf.org/html/rfc2045"RFC 2045</a>
- *
- * @see Base64Decoder
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Base64Encoder.java#2 $
- */
-public class Base64Encoder implements Encoder {
-
-    public void encode(final OutputStream stream, final ByteBuffer buffer)
-            throws IOException
-    {
-
-        // TODO: Implement
-        // NOTE: This is impossible, given the current spec, as we need to either:
-        //  - buffer all data in the EncoderStream
-        //  - or have flush/end method(s) in the Encoder
-        // to ensure proper end of stream handling
-
-        int length;
-
-        // TODO: Temp impl, will only work for single writes
-        while (buffer.hasRemaining()) {
-            byte a, b, c;
-
-//            if ((buffer.remaining()) > 2) {
-//                length = 3;
-//            }
-//            else {
-//                length = buffer.remaining();
-//            }
-            length = Math.min(3, buffer.remaining());
-
-            switch (length) {
-                case 1:
-                    a = buffer.get();
-                    b = 0;
-                    stream.write(Base64Decoder.PEM_ARRAY[(a >>> 2) & 0x3F]);
-                    stream.write(Base64Decoder.PEM_ARRAY[((a << 4) & 0x30) + ((b >>> 4) & 0xf)]);
-                    stream.write('=');
-                    stream.write('=');
-                    break;
-
-                case 2:
-                    a = buffer.get();
-                    b = buffer.get();
-                    c = 0;
-                    stream.write(Base64Decoder.PEM_ARRAY[(a >>> 2) & 0x3F]);
-                    stream.write(Base64Decoder.PEM_ARRAY[((a << 4) & 0x30) + ((b >>> 4) & 0xf)]);
-                    stream.write(Base64Decoder.PEM_ARRAY[((b << 2) & 0x3c) + ((c >>> 6) & 0x3)]);
-                    stream.write('=');
-                    break;
-
-                default:
-                    a = buffer.get();
-                    b = buffer.get();
-                    c = buffer.get();
-                    stream.write(Base64Decoder.PEM_ARRAY[(a >>> 2) & 0x3F]);
-                    stream.write(Base64Decoder.PEM_ARRAY[((a << 4) & 0x30) + ((b >>> 4) & 0xf)]);
-                    stream.write(Base64Decoder.PEM_ARRAY[((b << 2) & 0x3c) + ((c >>> 6) & 0x3)]);
-                    stream.write(Base64Decoder.PEM_ARRAY[c & 0x3F]);
-                    break;
-            }
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * {@code Encoder} implementation for standard base64 encoding.
+ *
+ * @see <a href="http://tools.ietf.org/html/rfc1421">RFC 1421</a>
+ * @see <a href="http://tools.ietf.org/html/rfc2045">RFC 2045</a>
+ *
+ * @see Base64Decoder
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Base64Encoder.java#2 $
+ */
+public class Base64Encoder implements Encoder {
+
+    public void encode(final OutputStream stream, final ByteBuffer buffer)
+            throws IOException
+    {
+
+        // TODO: Implement
+        // NOTE: This is impossible, given the current spec, as we need to either:
+        //  - buffer all data in the EncoderStream
+        //  - or have flush/end method(s) in the Encoder
+        // to ensure proper end of stream handling
+
+        int length;
+
+        // TODO: Temp impl, will only work for single writes
+        while (buffer.hasRemaining()) {
+            byte a, b, c;
+
+//            if ((buffer.remaining()) > 2) {
+//                length = 3;
+//            }
+//            else {
+//                length = buffer.remaining();
+//            }
+            length = Math.min(3, buffer.remaining());
+
+            switch (length) {
+                case 1:
+                    a = buffer.get();
+                    b = 0;
+                    stream.write(Base64Decoder.PEM_ARRAY[(a >>> 2) & 0x3F]);
+                    stream.write(Base64Decoder.PEM_ARRAY[((a << 4) & 0x30) + ((b >>> 4) & 0xf)]);
+                    stream.write('=');
+                    stream.write('=');
+                    break;
+
+                case 2:
+                    a = buffer.get();
+                    b = buffer.get();
+                    c = 0;
+                    stream.write(Base64Decoder.PEM_ARRAY[(a >>> 2) & 0x3F]);
+                    stream.write(Base64Decoder.PEM_ARRAY[((a << 4) & 0x30) + ((b >>> 4) & 0xf)]);
+                    stream.write(Base64Decoder.PEM_ARRAY[((b << 2) & 0x3c) + ((c >>> 6) & 0x3)]);
+                    stream.write('=');
+                    break;
+
+                default:
+                    a = buffer.get();
+                    b = buffer.get();
+                    c = buffer.get();
+                    stream.write(Base64Decoder.PEM_ARRAY[(a >>> 2) & 0x3F]);
+                    stream.write(Base64Decoder.PEM_ARRAY[((a << 4) & 0x30) + ((b >>> 4) & 0xf)]);
+                    stream.write(Base64Decoder.PEM_ARRAY[((b << 2) & 0x3c) + ((c >>> 6) & 0x3)]);
+                    stream.write(Base64Decoder.PEM_ARRAY[c & 0x3F]);
+                    break;
+            }
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/DecodeException.java

@@ -1,56 +1,55 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.IOException;
-
-/**
- * Thrown by {@code Decoder}s when encoded data can not be decoded.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/DecodeException.java#2 $
- */
-public class DecodeException extends IOException {
-
-    public DecodeException(final String pMessage) {
-        super(pMessage);
-    }
-
-    public DecodeException(final String pMessage, final Throwable pCause) {
-        super(pMessage);
-        initCause(pCause);
-    }
-
-    public DecodeException(final Throwable pCause) {
-        this(pCause.getMessage(), pCause);
-    }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.IOException;
+
+/**
+ * Thrown by {@code Decoder}s when encoded data can not be decoded.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/DecodeException.java#2 $
+ */
+public class DecodeException extends IOException {
+
+    public DecodeException(final String pMessage) {
+        super(pMessage);
+    }
+
+    public DecodeException(final String pMessage, final Throwable pCause) {
+        super(pMessage);
+        initCause(pCause);
+    }
+
+    public DecodeException(final Throwable pCause) {
+        this(pCause.getMessage(), pCause);
+    }
 }

common/common-io/src/main/java/com/twelvemonkeys/io/enc/Decoder.java

@@ -1,68 +1,69 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.nio.ByteBuffer;
-
-/**
- * Interface for decoders.
- * A {@code Decoder} may be used with a {@code DecoderStream}, to perform
- * on-the-fly decoding from an {@code InputStream}.
- * <p/>
- * Important note: Decoder implementations are typically not synchronized.
- * <p/>
- * @see Encoder
- * @see DecoderStream
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Decoder.java#2 $
- */
-public interface Decoder {
-    
-    /**
-     * Decodes up to {@code buffer.length} bytes from the given input stream,
-     * into the given buffer.
-     *
-     * @param stream the input stream to decode data from
-     * @param buffer buffer to store the read data
-     *
-     * @return the total number of bytes read into the buffer, or {@code 0}
-     * if there is no more data because the end of the stream has been reached.
-     *
-     * @throws DecodeException if encoded data is corrupt.
-     * @throws IOException if an I/O error occurs.
-     * @throws java.io.EOFException if a premature end-of-file is encountered.
-     * @throws java.lang.NullPointerException if either argument is {@code null}.
-     */
-    int decode(InputStream stream, ByteBuffer buffer) throws IOException;
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * Interface for decoders.
+ * A {@code Decoder} may be used with a {@code DecoderStream}, to perform
+ * on-the-fly decoding from an {@code InputStream}.
+ * <p>
+ * Important note: Decoder implementations are typically not synchronized.
+ * </p>
+ *
+ * @see Encoder
+ * @see DecoderStream
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Decoder.java#2 $
+ */
+public interface Decoder {
+    
+    /**
+     * Decodes up to {@code buffer.length} bytes from the given input stream,
+     * into the given buffer.
+     *
+     * @param stream the input stream to decode data from
+     * @param buffer buffer to store the read data
+     *
+     * @return the total number of bytes read into the buffer, or {@code 0}
+     * if there is no more data because the end of the stream has been reached.
+     *
+     * @throws DecodeException if encoded data is corrupt.
+     * @throws IOException if an I/O error occurs.
+     * @throws java.io.EOFException if a premature end-of-file is encountered.
+     * @throws java.lang.NullPointerException if either argument is {@code null}.
+     */
+    int decode(InputStream stream, ByteBuffer buffer) throws IOException;
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/DecoderStream.java

@@ -1,200 +1,199 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.FilterInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.nio.ByteBuffer;
-
-/**
- * An {@code InputStream} that provides on-the-fly decoding from an underlying
- * stream.
- * <p/>
- * @see EncoderStream
- * @see Decoder
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/DecoderStream.java#2 $
- */
-public final class DecoderStream extends FilterInputStream {
-    protected final ByteBuffer buffer;
-    protected final Decoder decoder;
-
-    /**
-     * Creates a new decoder stream and chains it to the
-     * input stream specified by the {@code pStream} argument.
-     * The stream will use a default decode buffer size.
-     *
-     * @param pStream the underlying input stream.
-     * @param pDecoder the decoder that will be used to decode the underlying stream
-     *
-     * @see java.io.FilterInputStream#in
-     */
-    public DecoderStream(final InputStream pStream, final Decoder pDecoder) {
-        // TODO: Let the decoder decide preferred buffer size 
-        this(pStream, pDecoder, 1024);
-    }
-
-    /**
-     * Creates a new decoder stream and chains it to the
-     * input stream specified by the {@code pStream} argument.
-     *
-     * @param pStream the underlying input stream.
-     * @param pDecoder the decoder that will be used to decode the underlying stream
-     * @param pBufferSize the size of the decode buffer
-     *
-     * @see java.io.FilterInputStream#in
-     */
-    public DecoderStream(final InputStream pStream, final Decoder pDecoder, final int pBufferSize) {
-        super(pStream);
-
-        decoder = pDecoder;
-        buffer = ByteBuffer.allocate(pBufferSize);
-        buffer.flip();
-    }
-
-    public int available() throws IOException {
-        return buffer.remaining();
-    }
-
-    public int read() throws IOException {
-        if (!buffer.hasRemaining()) {
-            if (fill() < 0) {
-                return -1;
-            }
-        }
-
-        return buffer.get() & 0xff;
-    }
-
-    public int read(final byte pBytes[], final int pOffset, final int pLength) throws IOException {
-        if (pBytes == null) {
-            throw new NullPointerException();
-        }
-        else if ((pOffset < 0) || (pOffset > pBytes.length) || (pLength < 0) ||
-                ((pOffset + pLength) > pBytes.length) || ((pOffset + pLength) < 0)) {
-            throw new IndexOutOfBoundsException("bytes.length=" + pBytes.length + " offset=" + pOffset + " length=" + pLength);
-        }
-        else if (pLength == 0) {
-            return 0;
-        }
-
-        // End of file?
-        if (!buffer.hasRemaining()) {
-            if (fill() < 0) {
-                return -1;
-            }
-        }
-
-        // Read until we have read pLength bytes, or have reached EOF
-        int count = 0;
-        int off = pOffset;
-
-        while (pLength > count) {
-            if (!buffer.hasRemaining()) {
-                if (fill() < 0) {
-                    break;
-                }
-            }
-
-            // Copy as many bytes as possible
-            int dstLen = Math.min(pLength - count, buffer.remaining());
-            buffer.get(pBytes, off, dstLen);
-
-            // Update offset (rest)
-            off += dstLen;
-
-            // Increase count
-            count += dstLen;
-        }
-
-        return count;
-    }
-
-    public long skip(final long pLength) throws IOException {
-        // End of file?
-        if (!buffer.hasRemaining()) {
-            if (fill() < 0) {
-                return 0; // Yes, 0, not -1
-            }
-        }
-
-        // Skip until we have skipped pLength bytes, or have reached EOF
-        long total = 0;
-
-        while (total < pLength) {
-            if (!buffer.hasRemaining()) {
-                if (fill() < 0) {
-                    break;
-                }
-            }
-
-            // NOTE: Skipped can never be more than avail, which is an int, so the cast is safe
-            int skipped = (int) Math.min(pLength - total, buffer.remaining());
-            buffer.position(buffer.position() + skipped);
-            total += skipped;
-        }
-
-        return total;
-    }
-
-    /**
-     * Fills the buffer, by decoding data from the underlying input stream.
-     *
-     * @return the number of bytes decoded, or {@code -1} if the end of the
-     * file is reached
-     *
-     * @throws IOException if an I/O error occurs
-     */
-    protected int fill() throws IOException {
-        buffer.clear();
-        int read = decoder.decode(in, buffer);
-
-        // TODO: Enforce this in test case, leave here to aid debugging
-        if (read > buffer.capacity()) {
-            throw new AssertionError(
-                    String.format(
-                            "Decode beyond buffer (%d): %d (using %s decoder)",
-                            buffer.capacity(), read, decoder.getClass().getName()
-                    )
-            );
-        }
-
-        buffer.flip();
-
-        if (read == 0) {
-            return -1;
-        }
-
-        return read;
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.FilterInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * An {@code InputStream} that provides on-the-fly decoding from an underlying stream.
+ *
+ * @see EncoderStream
+ * @see Decoder
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/DecoderStream.java#2 $
+ */
+public final class DecoderStream extends FilterInputStream {
+    private final ByteBuffer buffer;
+    private final Decoder decoder;
+
+    /**
+     * Creates a new decoder stream and chains it to the
+     * input stream specified by the {@code stream} argument.
+     * The stream will use a default decode buffer size.
+     *
+     * @param stream the underlying input stream.
+     * @param decoder the decoder that will be used to decode the underlying stream
+     *
+     * @see java.io.FilterInputStream#in
+     */
+    public DecoderStream(final InputStream stream, final Decoder decoder) {
+        // TODO: Let the decoder decide preferred buffer size
+        this(stream, decoder, 1024);
+    }
+
+    /**
+     * Creates a new decoder stream and chains it to the
+     * input stream specified by the {@code stream} argument.
+     *
+     * @param stream the underlying input stream.
+     * @param decoder the decoder that will be used to decode the underlying stream
+     * @param bufferSize the size of the decode buffer
+     *
+     * @see java.io.FilterInputStream#in
+     */
+    public DecoderStream(final InputStream stream, final Decoder decoder, final int bufferSize) {
+        super(stream);
+
+        this.decoder = decoder;
+        buffer = ByteBuffer.allocate(bufferSize); // TODO: Allow decoder to specify minimum buffer size
+        buffer.flip();
+    }
+
+    public int available() throws IOException {
+        return buffer.remaining();
+    }
+
+    public int read() throws IOException {
+        if (!buffer.hasRemaining()) {
+            if (fill() < 0) {
+                return -1;
+            }
+        }
+
+        return buffer.get() & 0xff;
+    }
+
+    public int read(final byte[] bytes, final int offset, final int length) throws IOException {
+        if (bytes == null) {
+            throw new NullPointerException();
+        }
+        else if ((offset < 0) || (offset > bytes.length) || (length < 0) ||
+                ((offset + length) > bytes.length) || ((offset + length) < 0)) {
+            throw new IndexOutOfBoundsException("bytes.length=" + bytes.length + " offset=" + offset + " length=" + length);
+        }
+        else if (length == 0) {
+            return 0;
+        }
+
+        // End of file?
+        if (!buffer.hasRemaining()) {
+            if (fill() < 0) {
+                return -1;
+            }
+        }
+
+        // Read until we have read length bytes, or have reached EOF
+        int count = 0;
+        int off = offset;
+
+        while (length > count) {
+            if (!buffer.hasRemaining()) {
+                if (fill() < 0) {
+                    break;
+                }
+            }
+
+            // Copy as many bytes as possible
+            int dstLen = Math.min(length - count, buffer.remaining());
+            buffer.get(bytes, off, dstLen);
+
+            // Update offset (rest)
+            off += dstLen;
+
+            // Increase count
+            count += dstLen;
+        }
+
+        return count;
+    }
+
+    public long skip(final long length) throws IOException {
+        // End of file?
+        if (!buffer.hasRemaining()) {
+            if (fill() < 0) {
+                return 0; // Yes, 0, not -1
+            }
+        }
+
+        // Skip until we have skipped length bytes, or have reached EOF
+        long total = 0;
+
+        while (total < length) {
+            if (!buffer.hasRemaining()) {
+                if (fill() < 0) {
+                    break;
+                }
+            }
+
+            // NOTE: Skipped can never be more than avail, which is an int, so the cast is safe
+            int skipped = (int) Math.min(length - total, buffer.remaining());
+            buffer.position(buffer.position() + skipped);
+            total += skipped;
+        }
+
+        return total;
+    }
+
+    /**
+     * Fills the buffer, by decoding data from the underlying input stream.
+     *
+     * @return the number of bytes decoded, or {@code -1} if the end of the
+     * file is reached
+     *
+     * @throws IOException if an I/O error occurs
+     */
+    private int fill() throws IOException {
+        buffer.clear();
+        int read = decoder.decode(in, buffer);
+
+        // TODO: Enforce this in test case, leave here to aid debugging
+        if (read > buffer.capacity()) {
+            throw new AssertionError(
+                    String.format(
+                            "Decode beyond buffer (%d): %d (using %s decoder)",
+                            buffer.capacity(), read, decoder.getClass().getName()
+                    )
+            );
+        }
+
+        buffer.flip();
+
+        if (read == 0) {
+            return -1;
+        }
+
+        return read;
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/Encoder.java

@@ -1,65 +1,66 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-
-/**
- * Interface for encoders.
- * An {@code Encoder} may be used with an {@code EncoderStream}, to perform
- * on-the-fly encoding to an {@code OutputStream}.
- * <p/>
- * Important note: Encoder implementations are typically not synchronized.
- *
- * @see Decoder
- * @see EncoderStream
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Encoder.java#2 $
- */
-public interface Encoder {
-    
-    /**
-     * Encodes up to {@code buffer.remaining()} bytes into the given input stream,
-     * from the given buffer.
-     *
-     * @param stream the output stream to encode data to
-     * @param buffer buffer to read data from
-     *
-     * @throws java.io.IOException if an I/O error occurs
-     */
-    void encode(OutputStream stream, ByteBuffer buffer) throws IOException;
-
-    //TODO: int requiredBufferSize(): -1 == any, otherwise, use this buffer size
-    // void flush()?
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * Interface for encoders.
+ * An {@code Encoder} may be used with an {@code EncoderStream}, to perform
+ * on-the-fly encoding to an {@code OutputStream}.
+ * <p>
+ * Important note: Encoder implementations are typically not synchronized.
+ * </p>
+ *
+ * @see Decoder
+ * @see EncoderStream
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/Encoder.java#2 $
+ */
+public interface Encoder {
+    
+    /**
+     * Encodes up to {@code buffer.remaining()} bytes into the given input stream,
+     * from the given buffer.
+     *
+     * @param stream the output stream to encode data to
+     * @param buffer buffer to read data from
+     *
+     * @throws java.io.IOException if an I/O error occurs
+     */
+    void encode(OutputStream stream, ByteBuffer buffer) throws IOException;
+
+    //TODO: int requiredBufferSize(): -1 == any, otherwise, use this buffer size
+    // void flush()?
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/EncoderStream.java

@@ -1,137 +1,134 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.FilterOutputStream;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-
-/**
- * An {@code OutputStream} that provides on-the-fly encoding to an underlying
- * stream.
- * <p/>
- * @see DecoderStream
- * @see Encoder
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/EncoderStream.java#2 $
- */
-public final class EncoderStream extends FilterOutputStream {
-    // TODO: This class need a test case ASAP!!!
-
-    protected final Encoder encoder;
-    private final boolean flushOnWrite;
-
-    protected final ByteBuffer buffer;
-
-    /**
-     * Creates an output stream filter built on top of the specified
-     * underlying output stream.
-     *
-     * @param pStream the underlying output stream
-     * @param pEncoder the encoder to use
-     */
-    public EncoderStream(final OutputStream pStream, final Encoder pEncoder) {
-        this(pStream, pEncoder, false);
-    }
-
-    /**
-     * Creates an output stream filter built on top of the specified
-     * underlying output stream.
-     *
-     * @param pStream the underlying output stream
-     * @param pEncoder the encoder to use
-     * @param pFlushOnWrite if {@code true}, calls to the byte-array
-     * {@code write} methods will automatically flush the buffer.
-     */
-    public EncoderStream(final OutputStream pStream, final Encoder pEncoder, final boolean pFlushOnWrite) {
-        super(pStream);
-
-        encoder = pEncoder;
-        flushOnWrite = pFlushOnWrite;
-
-        buffer = ByteBuffer.allocate(1024);
-        buffer.flip();
-    }
-
-    public void close() throws IOException {
-        flush();
-        super.close();
-    }
-
-    public void flush() throws IOException {
-        encodeBuffer();
-        super.flush();
-    }
-
-    private void encodeBuffer() throws IOException {
-        if (buffer.position() != 0) {
-            buffer.flip();
-
-            // Make sure all remaining data in buffer is written to the stream
-            encoder.encode(out, buffer);
-
-            // Reset buffer
-            buffer.clear();
-        }
-    }
-
-    public final void write(final byte[] pBytes) throws IOException {
-        write(pBytes, 0, pBytes.length);
-    }
-
-    // TODO: Verify that this works for the general case (it probably won't)...
-    // TODO: We might need a way to explicitly flush the encoder, or specify
-    // that the encoder can't buffer. In that case, the encoder should probably
-    // tell the EncoderStream how large buffer it prefers... 
-    public void write(final byte[] pBytes, final int pOffset, final int pLength) throws IOException {
-        if (!flushOnWrite && pLength < buffer.remaining()) {
-            // Buffer data
-            buffer.put(pBytes, pOffset, pLength);
-        }
-        else {
-            // Encode data already in the buffer
-            encodeBuffer();
-
-            // Encode rest without buffering
-            encoder.encode(out, ByteBuffer.wrap(pBytes, pOffset, pLength));
-        }
-    }
-
-    public void write(final int pByte) throws IOException {
-        if (!buffer.hasRemaining()) {
-            encodeBuffer(); // Resets bufferPos to 0
-        }
-
-        buffer.put((byte) pByte);
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.FilterOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * An {@code OutputStream} that provides on-the-fly encoding to an underlying stream.
+ *
+ * @see DecoderStream
+ * @see Encoder
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/EncoderStream.java#2 $
+ */
+public final class EncoderStream extends FilterOutputStream {
+
+    private final Encoder encoder;
+    private final boolean flushOnWrite;
+
+    private final ByteBuffer buffer;
+
+    /**
+     * Creates an output stream filter built on top of the specified
+     * underlying output stream.
+     *
+     * @param stream the underlying output stream
+     * @param encoder the encoder to use
+     */
+    public EncoderStream(final OutputStream stream, final Encoder encoder) {
+        this(stream, encoder, false);
+    }
+
+    /**
+     * Creates an output stream filter built on top of the specified
+     * underlying output stream.
+     *
+     * @param stream the underlying output stream
+     * @param encoder the encoder to use
+     * @param flushOnWrite if {@code true}, calls to the byte-array
+     * {@code write} methods will automatically flush the buffer.
+     */
+    public EncoderStream(final OutputStream stream, final Encoder encoder, final boolean flushOnWrite) {
+        super(stream);
+
+        this.encoder = encoder;
+        this.flushOnWrite = flushOnWrite;
+
+        buffer = ByteBuffer.allocate(1024);
+    }
+
+    public void close() throws IOException {
+        flush();
+        super.close();
+    }
+
+    public void flush() throws IOException {
+        encodeBuffer();
+        super.flush();
+    }
+
+    private void encodeBuffer() throws IOException {
+        if (buffer.position() != 0) {
+            buffer.flip();
+
+            // Make sure all remaining data in buffer is written to the stream
+            encoder.encode(out, buffer);
+
+            // Reset buffer
+            buffer.clear();
+        }
+    }
+
+    public void write(final byte[] bytes) throws IOException {
+        write(bytes, 0, bytes.length);
+    }
+
+    // TODO: Verify that this works for the general case (it probably won't)...
+    // TODO: We might need a way to explicitly flush the encoder, or specify
+    // that the encoder can't buffer. In that case, the encoder should probably
+    // tell the EncoderStream how large buffer it prefers...
+    public void write(final byte[] values, final int offset, final int length) throws IOException {
+        if (!flushOnWrite && length < buffer.remaining()) {
+            // Buffer data
+            buffer.put(values, offset, length);
+        }
+        else {
+            // Encode data already in the buffer
+            encodeBuffer();
+
+            // Encode rest without buffering
+            encoder.encode(out, ByteBuffer.wrap(values, offset, length));
+        }
+    }
+
+    public void write(final int value) throws IOException {
+        if (!buffer.hasRemaining()) {
+            encodeBuffer(); // Resets bufferPos to 0
+        }
+
+        buffer.put((byte) value);
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/PackBitsDecoder.java

@@ -1,210 +1,194 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.EOFException;
-import java.io.IOException;
-import java.io.InputStream;
-import java.nio.ByteBuffer;
-
-/**
- * Decoder implementation for Apple PackBits run-length encoding.
- * <p/>
- * <small>From Wikipedia, the free encyclopedia</small><br/>
- * PackBits is a fast, simple compression scheme for run-length encoding of
- * data.
- * <p/>
- * Apple introduced the PackBits format with the release of MacPaint on the
- * Macintosh computer. This compression scheme is one of the types of
- * compression that can be used in TIFF-files.
- * <p/>
- * A PackBits data stream consists of packets of one byte of header followed by
- * data. The header is a signed byte; the data can be signed, unsigned, or
- * packed (such as MacPaint pixels).
- * <p/>
- * <table><tr><th>Header byte</th><th>Data</th></tr>
- * <tr><td>0 to 127</td>    <td>1 + <i>n</i> literal bytes of data</td></tr>
- * <tr><td>0 to -127</td>   <td>One byte of data, repeated 1 - <i>n</i> times in
- *                           the decompressed output</td></tr>
- * <tr><td>-128</td>        <td>No operation</td></tr></table>
- * <p/>
- * Note that interpreting 0 as positive or negative makes no difference in the
- * output. Runs of two bytes adjacent to non-runs are typically written as
- * literal data.
- * <p/>
- * See <a href="http://developer.apple.com/technotes/tn/tn1023.html">Understanding PackBits</a>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/PackBitsDecoder.java#1 $
- */
-public final class PackBitsDecoder implements Decoder {
-    // TODO: Look at ICNSImageReader#unpackbits... What is this weirdness?
-
-    private final boolean disableNoOp;
-    private final byte[] sample;
-
-    private int leftOfRun;
-    private boolean splitRun;
-    private boolean reachedEOF;
-
-    /** Creates a {@code PackBitsDecoder}. */
-    public PackBitsDecoder() {
-        this(1, false);
-    }
-
-    /**
-     * Creates a {@code PackBitsDecoder}, with optional compatibility mode.
-     * <p/>
-     * As some implementations of PackBits-like encoders treat {@code -128} as length of
-     * a compressed run, instead of a no-op, it's possible to disable no-ops for compatibility.
-     * Should be used with caution, even though, most known encoders never write no-ops in the compressed streams.
-     *
-     * @param disableNoOp {@code true} if {@code -128} should be treated as a compressed run, and not a no-op
-     */
-    public PackBitsDecoder(final boolean disableNoOp) {
-        this(1, disableNoOp);
-    }
-
-    /**
-     * Creates a {@code PackBitsDecoder}, with optional compatibility mode.
-     * <p/>
-     * As some implementations of PackBits-like encoders treat {@code -128} as length of
-     * a compressed run, instead of a no-op, it's possible to disable no-ops for compatibility.
-     * Should be used with caution, even though, most known encoders never write no-ops in the compressed streams.
-     *
-     * @param disableNoOp {@code true} if {@code -128} should be treated as a compressed run, and not a no-op
-     */
-    public PackBitsDecoder(int sampleSize, final boolean disableNoOp) {
-        this.sample = new byte[sampleSize];
-        this.disableNoOp = disableNoOp;
-    }
-
-    /**
-     * Decodes bytes from the given input stream, to the given buffer.
-     *
-     * @param stream the stream to decode from
-     * @param buffer a byte array, minimum 128 (or 129 if no-op is disabled) bytes long
-     * @return The number of bytes decoded
-     *
-     * @throws java.io.IOException
-     */
-    public int decode(final InputStream stream, final ByteBuffer buffer) throws IOException {
-        if (reachedEOF) {
-            return -1;
-        }
-
-        // TODO: Don't decode more than single runs, because some writers add pad bytes inside the stream...
-        while (buffer.hasRemaining()) {
-            int n;
-            
-            if (splitRun) {
-                // Continue run
-                n = leftOfRun;
-                splitRun = false;
-            }
-            else {
-                // Start new run
-                int b = stream.read();
-                if (b < 0) {
-                    reachedEOF = true;
-                    break;
-                }
-                n = (byte) b;
-            }
-
-            // Split run at or before max
-            if (n >= 0 && n + 1 > buffer.remaining()) {
-                leftOfRun = n;
-                splitRun = true;
-                break;
-            }
-            else if (n < 0 && -n + 1 > buffer.remaining()) {
-                leftOfRun = n;
-                splitRun = true;
-                break;
-            }
-
-            try {
-                if (n >= 0) {
-                    // Copy next n + 1 bytes literally
-                    readFully(stream, buffer, sample.length * (n + 1));
-                }
-                // Allow -128 for compatibility, see above
-                else if (disableNoOp || n != -128) {
-                    // Replicate the next byte -n + 1 times
-                    for (int s = 0; s < sample.length; s++) {
-                        sample[s] = readByte(stream);
-                    }
-
-                    for (int i = -n + 1; i > 0; i--) {
-                        buffer.put(sample);
-                    }
-                }
-                // else NOOP (-128)
-            }
-            catch (IndexOutOfBoundsException e) {
-                throw new DecodeException("Error in PackBits decompression, data seems corrupt", e);
-            }
-        }
-
-        return buffer.position();
-    }
-
-    static byte readByte(final InputStream pStream) throws IOException {
-        int read = pStream.read();
-
-        if (read < 0) {
-            throw new EOFException("Unexpected end of PackBits stream");
-        }
-
-        return (byte) read;
-    }
-
-    static void readFully(final InputStream pStream, final ByteBuffer pBuffer, final int pLength) throws IOException {
-        if (pLength < 0) {
-            throw new IndexOutOfBoundsException(String.format("Negative length: %d", pLength));
-        }
-
-        int total = 0;
-
-        while (total < pLength) {
-            int count = pStream.read(pBuffer.array(), pBuffer.arrayOffset() + pBuffer.position() + total, pLength - total);
-
-            if (count < 0) {
-                throw new EOFException("Unexpected end of PackBits stream");
-            }
-
-            total += count;
-        }
-
-        pBuffer.position(pBuffer.position() + total);
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.EOFException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * Decoder implementation for Apple PackBits run-length encoding.
+ * <p>
+ * <small>From Wikipedia, the free encyclopedia</small>
+ * <br>
+ * PackBits is a fast, simple compression scheme for run-length encoding of
+ * data.
+ * </p>
+ * <p>
+ * Apple introduced the PackBits format with the release of MacPaint on the
+ * Macintosh computer. This compression scheme is one of the types of
+ * compression that can be used in TIFF-files.
+ * </p>
+ * <p>
+ * A PackBits data stream consists of packets of one byte of header followed by
+ * data. The header is a signed byte; the data can be signed, unsigned, or
+ * packed (such as MacPaint pixels).
+ * </p>
+ * <table>
+ *     <caption>PackBits</caption>
+ *     <tr><th>Header byte</th><th>Data</th></tr>
+ *     <tr><td>0 to 127</td>    <td>1 + <i>n</i> literal bytes of data</td></tr>
+ *     <tr><td>0 to -127</td>   <td>One byte of data, repeated 1 - <i>n</i> times in the decompressed output</td></tr>
+ *     <tr><td>-128</td>        <td>No operation</td></tr>
+ * </table>
+ * <p>
+ * Note that interpreting 0 as positive or negative makes no difference in the
+ * output. Runs of two bytes adjacent to non-runs are typically written as
+ * literal data.
+ * </p>
+ *
+ * @see <a href="http://developer.apple.com/technotes/tn/tn1023.html">Understanding PackBits</a>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/PackBitsDecoder.java#1 $
+ */
+public final class PackBitsDecoder implements Decoder {
+    // TODO: Look at ICNSImageReader#unpackbits... What is this weirdness?
+
+    private final boolean disableNoOp;
+    private final byte[] sample;
+
+    private boolean reachedEOF;
+
+    /** Creates a {@code PackBitsDecoder}. */
+    public PackBitsDecoder() {
+        this(1, false);
+    }
+
+    /**
+     * Creates a {@code PackBitsDecoder}, with optional compatibility mode.
+     * <p>
+     * As some implementations of PackBits-like encoders treat {@code -128} as length of
+     * a compressed run, instead of a no-op, it's possible to disable no-ops for compatibility.
+     * Should be used with caution, even though, most known encoders never write no-ops in the compressed streams.
+     * </p>
+     *
+     * @param disableNoOp {@code true} if {@code -128} should be treated as a compressed run, and not a no-op
+     */
+    public PackBitsDecoder(final boolean disableNoOp) {
+        this(1, disableNoOp);
+    }
+
+    /**
+     * Creates a {@code PackBitsDecoder}, with optional compatibility mode.
+     * <p>
+     * As some implementations of PackBits-like encoders treat {@code -128} as length of
+     * a compressed run, instead of a no-op, it's possible to disable no-ops for compatibility.
+     * Should be used with caution, even though, most known encoders never write no-ops in the compressed streams.
+     * </p>
+     *
+     * @param disableNoOp {@code true} if {@code -128} should be treated as a compressed run, and not a no-op
+     */
+    public PackBitsDecoder(int sampleSize, final boolean disableNoOp) {
+        this.sample = new byte[sampleSize];
+        this.disableNoOp = disableNoOp;
+    }
+
+    /**
+     * Decodes bytes from the given input stream, to the given buffer.
+     *
+     * @param stream the stream to decode from
+     * @param buffer a byte array, minimum 128 (or 129 if no-op is disabled) bytes long
+     * @return The number of bytes decoded
+     *
+     * @throws java.io.IOException if a problem occurs during decoding.
+     */
+    public int decode(final InputStream stream, final ByteBuffer buffer) throws IOException {
+        if (reachedEOF) {
+            return -1;
+        }
+
+        // NOTE: We don't decode more than single runs, because some writers add pad bytes inside the stream...
+        // Start new run
+        int b = stream.read();
+        if (b < 0) {
+            reachedEOF = true;
+            return 0;
+        }
+
+        int n = (byte) b;
+
+        try {
+            if (n >= 0) {
+                // Copy next n + 1 bytes literally
+                readFully(stream, buffer, sample.length * (n + 1));
+            }
+            // Allow -128 for compatibility, see above
+            else if (disableNoOp || n != -128) {
+                // Replicate the next byte -n + 1 times
+                for (int s = 0; s < sample.length; s++) {
+                    sample[s] = readByte(stream);
+                }
+
+                for (int i = -n + 1; i > 0; i--) {
+                    buffer.put(sample);
+                }
+            }
+            // else NOOP (-128)
+        }
+        catch (IndexOutOfBoundsException e) {
+            throw new DecodeException("Error in PackBits decompression, data seems corrupt", e);
+        }
+
+        return buffer.position();
+    }
+
+    static byte readByte(final InputStream pStream) throws IOException {
+        int read = pStream.read();
+
+        if (read < 0) {
+            throw new EOFException("Unexpected end of PackBits stream");
+        }
+
+        return (byte) read;
+    }
+
+    static void readFully(final InputStream pStream, final ByteBuffer pBuffer, final int pLength) throws IOException {
+        if (pLength < 0) {
+            throw new IndexOutOfBoundsException(String.format("Negative length: %d", pLength));
+        }
+
+        int total = 0;
+
+        while (total < pLength) {
+            int count = pStream.read(pBuffer.array(), pBuffer.arrayOffset() + pBuffer.position() + total, pLength - total);
+
+            if (count < 0) {
+                throw new EOFException("Unexpected end of PackBits stream");
+            }
+
+            total += count;
+        }
+
+        pBuffer.position(pBuffer.position() + total);
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/enc/PackBitsEncoder.java

@@ -1,132 +1,138 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.enc;
-
-import java.io.IOException;
-import java.io.OutputStream;
-import java.nio.ByteBuffer;
-
-/**
- * Encoder implementation for Apple PackBits run-length encoding.
- * <p/>
- * From Wikipedia, the free encyclopedia<br/>
- * PackBits is a fast, simple compression scheme for run-length encoding of
- * data.
- * <p/>
- * Apple introduced the PackBits format with the release of MacPaint on the
- * Macintosh computer. This compression scheme is one of the types of
- * compression that can be used in TIFF-files.
- * <p/>
- * A PackBits data stream consists of packets of one byte of header followed by
- * data. The header is a signed byte; the data can be signed, unsigned, or
- * packed (such as MacPaint pixels).
- * <p/>
- * <table><tr><th>Header byte</th><th>Data</th></tr>
- * <tr><td>0 to 127</td>    <td>1 + <i>n</i> literal bytes of data</td></tr>
- * <tr><td>0 to -127</td>   <td>One byte of data, repeated 1 - <i>n</i> times in
- *                           the decompressed output</td></tr>
- * <tr><td>-128</td>        <td>No operation</td></tr></table>
- * <p/>
- * Note that interpreting 0 as positive or negative makes no difference in the
- * output. Runs of two bytes adjacent to non-runs are typically written as
- * literal data.
- * <p/>
- * See <a href="http://developer.apple.com/technotes/tn/tn1023.html">Understanding PackBits</a>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/PackBitsEncoder.java#1 $
- */
-public final class PackBitsEncoder implements Encoder {
-
-    final private byte[] buffer = new byte[128];
-
-    /**
-     * Creates a {@code PackBitsEncoder}.
-     */
-    public PackBitsEncoder() {
-    }
-
-    public void encode(final OutputStream stream, final ByteBuffer buffer) throws IOException {
-        encode(stream, buffer.array(), buffer.arrayOffset() + buffer.position(), buffer.remaining());
-        buffer.position(buffer.remaining());
-    }
-
-    private void encode(OutputStream pStream, byte[] pBuffer, int pOffset, int pLength) throws IOException {
-        // NOTE: It's best to encode a 2 byte repeat
-        // run as a replicate run except when preceded and followed by a
-        // literal run, in which case it's best to merge the three into one
-        // literal run. Always encode 3 byte repeats as replicate runs.
-        // NOTE: Worst case: output = input + (input + 127) / 128
-
-        int offset = pOffset;
-        final int max = pOffset + pLength - 1;
-        final int maxMinus1 = max - 1;
-
-        while (offset <= max) {
-            // Compressed run
-            int run = 1;
-            byte replicate = pBuffer[offset];
-            while (run < 127 && offset < max && pBuffer[offset] == pBuffer[offset + 1]) {
-                offset++;
-                run++;
-            }
-
-            if (run > 1) {
-                offset++;
-                pStream.write(-(run - 1));
-                pStream.write(replicate);
-            }
-
-            // Literal run
-            run = 0;
-            while ((run < 128 && ((offset < max && pBuffer[offset] != pBuffer[offset + 1])
-                    || (offset < maxMinus1 && pBuffer[offset] != pBuffer[offset + 2])))) {
-                buffer[run++] = pBuffer[offset++];
-            }
-
-            // If last byte, include it in literal run, if space
-            if (offset == max && run > 0 && run < 128) {
-                buffer[run++] = pBuffer[offset++];
-            }
-
-            if (run > 0) {
-                pStream.write(run - 1);
-                pStream.write(buffer, 0, run);
-            }
-
-            // If last byte, and not space, start new literal run
-            if (offset == max && (run <= 0 || run >= 128)) {
-                pStream.write(0);
-                pStream.write(pBuffer[offset++]);
-            }
-        }
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+
+/**
+ * Encoder implementation for Apple PackBits run-length encoding.
+ * <p>
+ * From Wikipedia, the free encyclopedia
+ * <br>
+ * PackBits is a fast, simple compression scheme for run-length encoding of
+ * data.
+ * </p>
+ * <p>
+ * Apple introduced the PackBits format with the release of MacPaint on the
+ * Macintosh computer. This compression scheme is one of the types of
+ * compression that can be used in TIFF-files.
+ * </p>
+ * <p>
+ * A PackBits data stream consists of packets of one byte of header followed by
+ * data. The header is a signed byte; the data can be signed, unsigned, or
+ * packed (such as MacPaint pixels).
+ * </p>
+ * <table>
+ *     <caption>PackBits</caption>
+ *     <tr><th>Header byte</th><th>Data</th></tr>
+ *     <tr><td>0 to 127</td>    <td>1 + <i>n</i> literal bytes of data</td></tr>
+ *     <tr><td>0 to -127</td>   <td>One byte of data, repeated 1 - <i>n</i> times in     the decompressed output</td></tr>
+ *     <tr><td>-128</td>        <td>No operation</td></tr>
+ * </table>
+ * <p>
+ * Note that interpreting 0 as positive or negative makes no difference in the
+ * output. Runs of two bytes adjacent to non-runs are typically written as
+ * literal data.
+ * </p>
+ *
+ * @see <a href="http://developer.apple.com/technotes/tn/tn1023.html">Understanding PackBits</a>
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/enc/PackBitsEncoder.java#1 $
+ */
+public final class PackBitsEncoder implements Encoder {
+
+    final private byte[] buffer = new byte[128];
+
+    /**
+     * Creates a {@code PackBitsEncoder}.
+     */
+    public PackBitsEncoder() {
+    }
+
+    public void encode(final OutputStream stream, final ByteBuffer buffer) throws IOException {
+        encode(stream, buffer.array(), buffer.arrayOffset() + buffer.position(), buffer.remaining());
+        buffer.position(buffer.remaining());
+    }
+
+    private void encode(OutputStream pStream, byte[] pBuffer, int pOffset, int pLength) throws IOException {
+        // NOTE: It's best to encode a 2 byte repeat
+        // run as a replicate run except when preceded and followed by a
+        // literal run, in which case it's best to merge the three into one
+        // literal run. Always encode 3 byte repeats as replicate runs.
+        // NOTE: Worst case: output = input + (input + 127) / 128
+
+        int offset = pOffset;
+        final int max = pOffset + pLength - 1;
+        final int maxMinus1 = max - 1;
+
+        while (offset <= max) {
+            // Compressed run
+            int run = 1;
+            byte replicate = pBuffer[offset];
+            while (run < 127 && offset < max && pBuffer[offset] == pBuffer[offset + 1]) {
+                offset++;
+                run++;
+            }
+
+            if (run > 1) {
+                offset++;
+                pStream.write(-(run - 1));
+                pStream.write(replicate);
+            }
+
+            // Literal run
+            run = 0;
+            while ((run < 128 && ((offset < max && pBuffer[offset] != pBuffer[offset + 1])
+                    || (offset < maxMinus1 && pBuffer[offset] != pBuffer[offset + 2])))) {
+                buffer[run++] = pBuffer[offset++];
+            }
+
+            // If last byte, include it in literal run, if space
+            if (offset == max && run > 0 && run < 128) {
+                buffer[run++] = pBuffer[offset++];
+            }
+
+            if (run > 0) {
+                pStream.write(run - 1);
+                pStream.write(buffer, 0, run);
+            }
+
+            // If last byte, and not space, start new literal run
+            if (offset == max && (run <= 0 || run >= 128)) {
+                pStream.write(0);
+                pStream.write(pBuffer[offset++]);
+            }
+        }
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/io/ole2/Entry.java

@@ -1,342 +1,344 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.io.ole2;
-
-import com.twelvemonkeys.io.SeekableInputStream;
-
-import java.io.DataInput;
-import java.io.IOException;
-import java.nio.charset.Charset;
-import java.util.Collections;
-import java.util.SortedSet;
-import java.util.TreeSet;
-
-/**
- * Represents an OLE 2 compound document entry.
- * This is similar to a file in a file system, or an entry in a ZIP or JAR file.
- *
- * @author <a href="mailto:harald.kuhr@gmail.no">Harald Kuhr</a>
- * @author last modified by $Author: haku $
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/ole2/Entry.java#4 $
- * @see com.twelvemonkeys.io.ole2.CompoundDocument
- */
-// TODO: Consider extending java.io.File...
-public final class Entry implements Comparable<Entry> {
-    String name;
-    byte type;
-    byte nodeColor;
-
-    int prevDId;
-    int nextDId;
-    int rootNodeDId;
-
-    long createdTimestamp;
-    long modifiedTimestamp;
-
-    int startSId;
-    int streamSize;
-
-    CompoundDocument document;
-    Entry parent;
-    SortedSet<Entry> children;
-
-    public final static int LENGTH = 128;
-
-    static final int EMPTY = 0;
-    static final int USER_STORAGE = 1;
-    static final int USER_STREAM = 2;
-    static final int LOCK_BYTES = 3;
-    static final int PROPERTY = 4;
-    static final int ROOT_STORAGE = 5;
-
-    private static final SortedSet<Entry> NO_CHILDREN = Collections.unmodifiableSortedSet(new TreeSet<Entry>());
-
-    private Entry() {
-    }
-
-    /**
-     * Reads an entry from the input.
-     *
-     * @param pInput the input data
-     * @return the {@code Entry} read from the input data
-     * @throws IOException if an i/o exception occurs during reading
-     */
-    static Entry readEntry(final DataInput pInput) throws IOException {
-        Entry p = new Entry();
-        p.read(pInput);
-        return p;
-    }
-
-    /**
-     * Reads this entry
-     *
-     * @param pInput the input data
-     * @throws IOException if an i/o exception occurs during reading
-     */
-    private void read(final DataInput pInput) throws IOException {
-        byte[] bytes = new byte[64];
-        pInput.readFully(bytes);
-
-        // NOTE: Length is in bytes, including the null-terminator...
-        int nameLength = pInput.readShort();
-        name = new String(bytes, 0, nameLength - 2, Charset.forName("UTF-16LE"));
-//        System.out.println("name: " + name);
-
-        type = pInput.readByte();
-//        System.out.println("type: " + type);
-
-        nodeColor = pInput.readByte();
-//        System.out.println("nodeColor: " + nodeColor);
-
-        prevDId = pInput.readInt();
-//        System.out.println("prevDId: " + prevDId);
-        nextDId = pInput.readInt();
-//        System.out.println("nextDId: " + nextDId);
-        rootNodeDId = pInput.readInt();
-//        System.out.println("rootNodeDId: " + rootNodeDId);
-
-        // UID (16) + user flags (4), ignored
-        if (pInput.skipBytes(20) != 20) {
-            throw new CorruptDocumentException();
-        }
-
-        createdTimestamp = CompoundDocument.toJavaTimeInMillis(pInput.readLong());
-        modifiedTimestamp = CompoundDocument.toJavaTimeInMillis(pInput.readLong());
-
-        startSId = pInput.readInt();
-//        System.out.println("startSId: " + startSId);
-        streamSize = pInput.readInt();
-//        System.out.println("streamSize: " + streamSize);
-
-        // Reserved
-        pInput.readInt();
-    }
-
-    /**
-     * If {@code true} this {@code Entry} is the root {@code Entry}.
-     *
-     * @return {@code true} if this is the root {@code Entry}
-     */
-    public boolean isRoot() {
-        return type == ROOT_STORAGE;
-    }
-
-    /**
-     * If {@code true} this {@code Entry} is a directory
-     * {@code Entry}.
-     *
-     * @return {@code true} if this is a directory {@code Entry}
-     */
-    public boolean isDirectory() {
-        return type == USER_STORAGE;
-    }
-
-    /**
-     * If {@code true} this {@code Entry} is a file (document)
-     * {@code Entry}.
-     *
-     * @return {@code true} if this is a document {@code Entry}
-     */
-    public boolean isFile() {
-        return type == USER_STREAM;
-    }
-
-    /**
-     * Returns the name of this {@code Entry}
-     *
-     * @return the name of this {@code Entry}
-     */
-    public String getName() {
-        return name;
-    }
-
-    /**
-     * Returns the {@code InputStream} for this {@code Entry}
-     *
-     * @return an {@code InputStream} containing the data for this
-     *         {@code Entry} or {@code null} if this is a directory {@code Entry}
-     * @throws java.io.IOException if an I/O exception occurs
-     * @see #length()
-     */
-    public SeekableInputStream getInputStream() throws IOException {
-        if (!isFile()) {
-            return null;
-        }
-
-        return document.getInputStreamForSId(startSId, streamSize);
-    }
-
-    /**
-     * Returns the length of this entry
-     *
-     * @return the length of the stream for this entry, or {@code 0} if this is
-     *         a directory {@code Entry}
-     * @see #getInputStream()
-     */
-    public long length() {
-        if (!isFile()) {
-            return 0L;
-        }
-
-        return streamSize;
-    }
-
-    /**
-     * Returns the time that this entry was created.
-     * The time is converted from its internal representation to standard Java
-     * representation, milliseconds since the epoch
-     * (00:00:00 GMT, January 1, 1970).
-     * <p/>
-     * Note that most applications leaves this value empty ({@code 0L}).
-     *
-     * @return  A {@code long} value representing the time this entry was
-     *          created, measured in milliseconds since the epoch
-     *          (00:00:00 GMT, January 1, 1970), or {@code 0L} if no
-     *          creation time stamp exists for this entry.
-     */
-    public long created() {
-        return createdTimestamp;
-    }
-
-    /**
-     * Returns the time that this entry was last modified.
-     * The time is converted from its internal representation to standard Java
-     * representation, milliseconds since the epoch
-     * (00:00:00 GMT, January 1, 1970).
-     * <p/>
-     * Note that many applications leaves this value empty ({@code 0L}).
-     *
-     * @return  A {@code long} value representing the time this entry was
-     *          last modified, measured in milliseconds since the epoch
-     *          (00:00:00 GMT, January 1, 1970), or {@code 0L} if no
-     *          modification time stamp exists for this entry.
-     */
-    public long lastModified() {
-        return modifiedTimestamp;
-    }
-
-    /**
-     * Return the parent of this {@code Entry}
-     *
-     * @return the parent of this {@code Entry}, or {@code null} if this is
-     *         the root {@code Entry}
-     */
-    public Entry getParentEntry() {
-        return parent;
-    }
-
-    /**
-     * Returns the child of this {@code Entry} with the given name.
-     *
-     * @param pName the name of the child {@code Entry}
-     * @return the child {@code Entry} or {@code null} if thee is no such
-     *         child
-     * @throws java.io.IOException if an I/O exception occurs
-     */
-    public Entry getChildEntry(final String pName) throws IOException {
-        if (isFile() || rootNodeDId == -1) {
-            return null;
-        }
-
-        Entry dummy = new Entry();
-        dummy.name = pName;
-        dummy.parent = this;
-
-        SortedSet child = getChildEntries().tailSet(dummy);
-        return (Entry) child.first();
-    }
-
-    /**
-     * Returns the children of this {@code Entry}.
-     *
-     * @return a {@code SortedSet} of {@code Entry} objects
-     * @throws java.io.IOException if an I/O exception occurs
-     */
-    public SortedSet<Entry> getChildEntries() throws IOException {
-        if (children == null) {
-            if (isFile() || rootNodeDId == -1) {
-                children = NO_CHILDREN;
-            }
-            else {
-                // Start at root node in R/B tree, and read to the left and right,
-                // re-build tree, according to the docs
-                children = Collections.unmodifiableSortedSet(document.getEntries(rootNodeDId, this));
-            }
-        }
-
-        return children;
-    }
-
-    @Override
-    public String toString() {
-        return "\"" + name + "\""
-                + " (" + (isFile() ? "Document" : (isDirectory() ? "Directory" : "Root"))
-                + (parent != null ? ", parent: \"" + parent.getName() + "\"" : "")
-                + (isFile() ? "" : ", children: " + (children != null ? String.valueOf(children.size()) : "(unknown)"))
-                + ", SId=" + startSId + ", length=" + streamSize + ")";
-    }
-
-    @Override
-    public boolean equals(final Object pOther) {
-        if (pOther == this) {
-            return true;
-        }
-        if (!(pOther instanceof Entry)) {
-            return false;
-        }
-
-        Entry other = (Entry) pOther;
-        return name.equals(other.name) && (parent == other.parent
-                || (parent != null && parent.equals(other.parent)));
-    }
-
-    @Override
-    public int hashCode() {
-        return name.hashCode() ^ startSId;
-    }
-
-    public int compareTo(final Entry pOther) {
-        if (this == pOther) {
-            return 0;
-        }
-
-        // NOTE: This is the sorting algorthm defined by the Compound Document:
-        //  - first sort by name length
-        //  - if lengths are equal, sort by comparing strings, case sensitive 
-
-        int diff = name.length() - pOther.name.length();
-        if (diff != 0) {
-            return diff;
-        }
-
-        return name.compareTo(pOther.name);
-    }
-}
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.ole2;
+
+import com.twelvemonkeys.io.SeekableInputStream;
+
+import java.io.DataInput;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.Collections;
+import java.util.SortedSet;
+import java.util.TreeSet;
+
+/**
+ * Represents an OLE 2 compound document entry.
+ * This is similar to a file in a file system, or an entry in a ZIP or JAR file.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.no">Harald Kuhr</a>
+ * @author last modified by $Author: haku $
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/ole2/Entry.java#4 $
+ * @see com.twelvemonkeys.io.ole2.CompoundDocument
+ */
+// TODO: Consider extending java.io.File...
+public final class Entry implements Comparable<Entry> {
+    String name;
+    byte type;
+    byte nodeColor;
+
+    int prevDId;
+    int nextDId;
+    int rootNodeDId;
+
+    long createdTimestamp;
+    long modifiedTimestamp;
+
+    int startSId;
+    int streamSize;
+
+    CompoundDocument document;
+    Entry parent;
+    SortedSet<Entry> children;
+
+    public final static int LENGTH = 128;
+
+    static final int EMPTY = 0;
+    static final int USER_STORAGE = 1;
+    static final int USER_STREAM = 2;
+    static final int LOCK_BYTES = 3;
+    static final int PROPERTY = 4;
+    static final int ROOT_STORAGE = 5;
+
+    private static final SortedSet<Entry> NO_CHILDREN = Collections.unmodifiableSortedSet(new TreeSet<Entry>());
+
+    private Entry() {
+    }
+
+    /**
+     * Reads an entry from the input.
+     *
+     * @param pInput the input data
+     * @return the {@code Entry} read from the input data
+     * @throws IOException if an i/o exception occurs during reading
+     */
+    static Entry readEntry(final DataInput pInput) throws IOException {
+        Entry p = new Entry();
+        p.read(pInput);
+        return p;
+    }
+
+    /**
+     * Reads this entry
+     *
+     * @param pInput the input data
+     * @throws IOException if an i/o exception occurs during reading
+     */
+    private void read(final DataInput pInput) throws IOException {
+        byte[] bytes = new byte[64];
+        pInput.readFully(bytes);
+
+        // NOTE: Length is in bytes, including the null-terminator...
+        int nameLength = pInput.readShort();
+        name = new String(bytes, 0, nameLength - 2, Charset.forName("UTF-16LE"));
+//        System.out.println("name: " + name);
+
+        type = pInput.readByte();
+//        System.out.println("type: " + type);
+
+        nodeColor = pInput.readByte();
+//        System.out.println("nodeColor: " + nodeColor);
+
+        prevDId = pInput.readInt();
+//        System.out.println("prevDId: " + prevDId);
+        nextDId = pInput.readInt();
+//        System.out.println("nextDId: " + nextDId);
+        rootNodeDId = pInput.readInt();
+//        System.out.println("rootNodeDId: " + rootNodeDId);
+
+        // UID (16) + user flags (4), ignored
+        if (pInput.skipBytes(20) != 20) {
+            throw new CorruptDocumentException();
+        }
+
+        createdTimestamp = CompoundDocument.toJavaTimeInMillis(pInput.readLong());
+        modifiedTimestamp = CompoundDocument.toJavaTimeInMillis(pInput.readLong());
+
+        startSId = pInput.readInt();
+//        System.out.println("startSId: " + startSId);
+        streamSize = pInput.readInt();
+//        System.out.println("streamSize: " + streamSize);
+
+        // Reserved
+        pInput.readInt();
+    }
+
+    /**
+     * If {@code true} this {@code Entry} is the root {@code Entry}.
+     *
+     * @return {@code true} if this is the root {@code Entry}
+     */
+    public boolean isRoot() {
+        return type == ROOT_STORAGE;
+    }
+
+    /**
+     * If {@code true} this {@code Entry} is a directory
+     * {@code Entry}.
+     *
+     * @return {@code true} if this is a directory {@code Entry}
+     */
+    public boolean isDirectory() {
+        return type == USER_STORAGE;
+    }
+
+    /**
+     * If {@code true} this {@code Entry} is a file (document)
+     * {@code Entry}.
+     *
+     * @return {@code true} if this is a document {@code Entry}
+     */
+    public boolean isFile() {
+        return type == USER_STREAM;
+    }
+
+    /**
+     * Returns the name of this {@code Entry}
+     *
+     * @return the name of this {@code Entry}
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Returns the {@code InputStream} for this {@code Entry}
+     *
+     * @return an {@code InputStream} containing the data for this
+     *         {@code Entry} or {@code null} if this is a directory {@code Entry}
+     * @throws java.io.IOException if an I/O exception occurs
+     * @see #length()
+     */
+    public SeekableInputStream getInputStream() throws IOException {
+        if (!isFile()) {
+            return null;
+        }
+
+        return document.getInputStreamForSId(startSId, streamSize);
+    }
+
+    /**
+     * Returns the length of this entry
+     *
+     * @return the length of the stream for this entry, or {@code 0} if this is
+     *         a directory {@code Entry}
+     * @see #getInputStream()
+     */
+    public long length() {
+        if (!isFile()) {
+            return 0L;
+        }
+
+        return streamSize;
+    }
+
+    /**
+     * Returns the time that this entry was created.
+     * The time is converted from its internal representation to standard Java
+     * representation, milliseconds since the epoch
+     * (00:00:00 GMT, January 1, 1970).
+     * <p>
+     * Note that most applications leaves this value empty ({@code 0L}).
+     * </p>
+     *
+     * @return  A {@code long} value representing the time this entry was
+     *          created, measured in milliseconds since the epoch
+     *          (00:00:00 GMT, January 1, 1970), or {@code 0L} if no
+     *          creation time stamp exists for this entry.
+     */
+    public long created() {
+        return createdTimestamp;
+    }
+
+    /**
+     * Returns the time that this entry was last modified.
+     * The time is converted from its internal representation to standard Java
+     * representation, milliseconds since the epoch
+     * (00:00:00 GMT, January 1, 1970).
+     * <p>
+     * Note that many applications leaves this value empty ({@code 0L}).
+     * </p>
+     *
+     * @return  A {@code long} value representing the time this entry was
+     *          last modified, measured in milliseconds since the epoch
+     *          (00:00:00 GMT, January 1, 1970), or {@code 0L} if no
+     *          modification time stamp exists for this entry.
+     */
+    public long lastModified() {
+        return modifiedTimestamp;
+    }
+
+    /**
+     * Return the parent of this {@code Entry}
+     *
+     * @return the parent of this {@code Entry}, or {@code null} if this is
+     *         the root {@code Entry}
+     */
+    public Entry getParentEntry() {
+        return parent;
+    }
+
+    /**
+     * Returns the child of this {@code Entry} with the given name.
+     *
+     * @param pName the name of the child {@code Entry}
+     * @return the child {@code Entry} or {@code null} if thee is no such
+     *         child
+     * @throws java.io.IOException if an I/O exception occurs
+     */
+    public Entry getChildEntry(final String pName) throws IOException {
+        if (isFile() || rootNodeDId == -1) {
+            return null;
+        }
+
+        Entry dummy = new Entry();
+        dummy.name = pName;
+        dummy.parent = this;
+
+        SortedSet child = getChildEntries().tailSet(dummy);
+        return (Entry) child.first();
+    }
+
+    /**
+     * Returns the children of this {@code Entry}.
+     *
+     * @return a {@code SortedSet} of {@code Entry} objects
+     * @throws java.io.IOException if an I/O exception occurs
+     */
+    public SortedSet<Entry> getChildEntries() throws IOException {
+        if (children == null) {
+            if (isFile() || rootNodeDId == -1) {
+                children = NO_CHILDREN;
+            }
+            else {
+                // Start at root node in R/B tree, and read to the left and right,
+                // re-build tree, according to the docs
+                children = Collections.unmodifiableSortedSet(document.getEntries(rootNodeDId, this));
+            }
+        }
+
+        return children;
+    }
+
+    @Override
+    public String toString() {
+        return "\"" + name + "\""
+                + " (" + (isFile() ? "Document" : (isDirectory() ? "Directory" : "Root"))
+                + (parent != null ? ", parent: \"" + parent.getName() + "\"" : "")
+                + (isFile() ? "" : ", children: " + (children != null ? String.valueOf(children.size()) : "(unknown)"))
+                + ", SId=" + startSId + ", length=" + streamSize + ")";
+    }
+
+    @Override
+    public boolean equals(final Object pOther) {
+        if (pOther == this) {
+            return true;
+        }
+        if (!(pOther instanceof Entry)) {
+            return false;
+        }
+
+        Entry other = (Entry) pOther;
+        return name.equals(other.name) && (parent == other.parent
+                || (parent != null && parent.equals(other.parent)));
+    }
+
+    @Override
+    public int hashCode() {
+        return name.hashCode() ^ startSId;
+    }
+
+    public int compareTo(final Entry pOther) {
+        if (this == pOther) {
+            return 0;
+        }
+
+        // NOTE: This is the sorting algorthm defined by the Compound Document:
+        //  - first sort by name length
+        //  - if lengths are equal, sort by comparing strings, case sensitive 
+
+        int diff = name.length() - pOther.name.length();
+        if (diff != 0) {
+            return diff;
+        }
+
+        return name.compareTo(pOther.name);
+    }
+}

common/common-io/src/main/java/com/twelvemonkeys/net/MIMEUtil.java

@@ -1,314 +1,313 @@
-/*
- * Copyright (c) 2008, Harald Kuhr
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice, this
- *   list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- *   this list of conditions and the following disclaimer in the documentation
- *   and/or other materials provided with the distribution.
- *
- * * Neither the name of the copyright holder nor the names of its
- *   contributors may be used to endorse or promote products derived from
- *   this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
-package com.twelvemonkeys.net;
-
-import com.twelvemonkeys.lang.StringUtil;
-import com.twelvemonkeys.lang.SystemUtil;
-
-import java.io.IOException;
-import java.util.*;
-
-/**
- * Contains mappings from file extension to mime-types and from mime-type to file-types.
- * <p/>
- *
- * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
- * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/MIMEUtil.java#5 $
- *
- * @see <A href="http://www.iana.org/assignments/media-types/">MIME Media Types</A>
- */
-public final class MIMEUtil {
-    // TODO: Piggy-back on the mappings form the JRE? (1.6 comes with javax.activation)
-    // TODO: Piggy-back on mappings from javax.activation?
-    // See: http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/activation/MimetypesFileTypeMap.html
-    // See: http://java.sun.com/javase/6/docs/api/javax/activation/MimetypesFileTypeMap.html
-    // TODO: Use the format (and lookup) specified by the above URLs
-    // TODO: Allow 3rd party to add mappings? Will need application context support to do it safe.. :-P
-
-    private static Map<String, List<String>> sExtToMIME = new HashMap<String, List<String>>();
-    private static Map<String, List<String>> sUnmodifiableExtToMIME = Collections.unmodifiableMap(sExtToMIME);
-
-    private static Map<String, List<String>> sMIMEToExt = new HashMap<String, List<String>>();
-    private static Map<String, List<String>> sUnmodifiableMIMEToExt = Collections.unmodifiableMap(sMIMEToExt);
-
-    static {
-        // Load mapping for MIMEUtil
-        try {
-            Properties mappings = SystemUtil.loadProperties(MIMEUtil.class);
-
-            for (Map.Entry entry : mappings.entrySet()) {
-                // Convert and break up extensions and mimeTypes
-                String extStr = StringUtil.toLowerCase((String) entry.getKey());
-                List<String> extensions =
-                        Collections.unmodifiableList(Arrays.asList(StringUtil.toStringArray(extStr, ";, ")));
-
-                String typeStr = StringUtil.toLowerCase((String) entry.getValue());
-                List<String> mimeTypes =
-                        Collections.unmodifiableList(Arrays.asList(StringUtil.toStringArray(typeStr, ";, ")));
-
-                // TODO: Handle duplicates in MIME to extension mapping, like
-                // xhtml=application/xhtml+xml;application/xml
-                // xml=text/xml;application/xml
-
-                // Populate normal and reverse MIME-mappings
-                for (String extension : extensions) {
-                    sExtToMIME.put(extension, mimeTypes);
-                }
-
-                for (String mimeType : mimeTypes) {
-                    sMIMEToExt.put(mimeType, extensions);
-                }
-            }
-        }
-        catch (IOException e) {
-            System.err.println("Could not read properties for MIMEUtil: " + e.getMessage());
-            e.printStackTrace();
-        }
-    }
-
-    // Disallow construction
-    private MIMEUtil() {
-    }
-
-    /**
-     * Returns the default MIME type for the given file extension.
-     *
-     * @param pFileExt the file extension
-     *
-     * @return a {@code String} containing the MIME type, or {@code null} if
-     * there are no known MIME types for the given file extension.
-     */
-    public static String getMIMEType(final String pFileExt) {
-        List<String> types = sExtToMIME.get(StringUtil.toLowerCase(pFileExt));
-        return (types == null || types.isEmpty()) ? null : types.get(0);
-    }
-
-    /**
-     * Returns all MIME types for the given file extension.
-     *
-     * @param pFileExt the file extension
-     *
-     * @return a {@link List} of {@code String}s containing the MIME types, or an empty
-     * list, if there are no known MIME types for the given file extension.
-     */
-    public static List<String> getMIMETypes(final String pFileExt) {
-        List<String> types = sExtToMIME.get(StringUtil.toLowerCase(pFileExt));
-        return maskNull(types);
-    }
-
-    /**
-     * Returns an unmodifiabale {@link Map} view of the extension to
-     * MIME mapping, to use as the default mapping in client applications.
-     *
-     * @return an unmodifiabale {@code Map} view of the extension to
-     * MIME mapping.
-     */
-    public static Map<String, List<String>> getMIMETypeMappings() {
-        return sUnmodifiableExtToMIME;
-    }
-
-    /**
-     * Returns the default file extension for the given MIME type.
-     * Specifying a wildcard type will return {@code null}.
-     *
-     * @param pMIME the MIME type
-     *
-     * @return a {@code String} containing the file extension, or {@code null}
-     * if there are no known file extensions for the given MIME type.
-     */
-    public static String getExtension(final String pMIME) {
-        String mime = bareMIME(StringUtil.toLowerCase(pMIME));
-        List<String> extensions = sMIMEToExt.get(mime);
-        return (extensions == null || extensions.isEmpty()) ? null : extensions.get(0);
-    }
-
-    /**
-     * Returns all file extension for the given MIME type.
-     * The default extension will be the first in the list.
-     * Note that no specific order is given for wildcard types (image/*, *&#47;* etc).
-     *
-     * @param pMIME the MIME type
-     *
-     * @return a {@link List} of {@code String}s containing the MIME types, or an empty
-     * list, if there are no known file extensions for the given MIME type.
-     */
-    public static List<String> getExtensions(final String pMIME) {
-        String mime = bareMIME(StringUtil.toLowerCase(pMIME));
-        if (mime.endsWith("/*")) {
-            return getExtensionForWildcard(mime);
-        }
-        List<String> extensions = sMIMEToExt.get(mime);
-        return maskNull(extensions);
-    }
-
-    // Gets all extensions for a wildcard MIME type
-    private static List<String> getExtensionForWildcard(final String pMIME) {
-        final String family = pMIME.substring(0, pMIME.length() - 1);
-        Set<String> extensions = new LinkedHashSet<String>();
-        for (Map.Entry<String, List<String>> mimeToExt : sMIMEToExt.entrySet()) {
-            if ("*/".equals(family) || mimeToExt.getKey().startsWith(family)) {
-                extensions.addAll(mimeToExt.getValue());
-            }
-        }
-        return Collections.unmodifiableList(new ArrayList<String>(extensions));
-    }
-
-    /**
-     * Returns an unmodifiabale {@link Map} view of the MIME to
-     * extension mapping, to use as the default mapping in client applications.
-     *
-     * @return an unmodifiabale {@code Map} view of the MIME to
-     * extension mapping.
-     */
-    public static Map<String, List<String>> getExtensionMappings() {
-        return sUnmodifiableMIMEToExt;
-    }
-
-    /**
-     * Tests wehter the type is a subtype of the type family.
-     *
-     * @param pTypeFamily the MIME type family ({@code image/*, *&#47;*}, etc)
-     * @param pType the MIME type
-     * @return {@code true} if {@code pType} is a subtype of {@code pTypeFamily}, otherwise {@code false}
-     */
-    // TODO: Rename? isSubtype?
-    // TODO: Make public
-    static boolean includes(final String pTypeFamily, final String pType) {
-        // TODO: Handle null in a well-defined way
-        // - Is null family same as */*?
-        // - Is null subtype of any family? Subtype of no family?
-
-        String type = bareMIME(pType);
-        return type.equals(pTypeFamily)
-                || "*/*".equals(pTypeFamily)
-                || pTypeFamily.endsWith("/*") && pTypeFamily.startsWith(type.substring(0, type.indexOf('/')));
-    }
-
-    /**
-     * Removes any charset or extra info from the mime-type string (anything after a semicolon, {@code ;}, inclusive).
-     *
-     * @param pMIME the mime-type string
-     * @return the bare mime-type
-     */
-    public static String bareMIME(final String pMIME) {
-        int idx;
-        if (pMIME != null && (idx = pMIME.indexOf(';')) >= 0) {
-            return pMIME.substring(0, idx);
-        }
-        return pMIME;
-    }
-
-    // Returns the list or empty list if list is null
-    private static List<String> maskNull(List<String> pTypes) {
-        return (pTypes == null) ? Collections.<String>emptyList() : pTypes;
-    }
-
-    /**
-     * For debugging. Prints all known MIME types and file extensions.
-     *
-     * @param pArgs command line arguments
-     */
-    public static void main(String[] pArgs) {
-        if (pArgs.length > 1) {
-            String type = pArgs[0];
-            String family = pArgs[1];
-            boolean incuded = includes(family, type);
-            System.out.println(
-                    "Mime type family " + family
-                    + (incuded ? " includes " : " does not include ")
-                    + "type " + type
-            );
-        }
-        if (pArgs.length > 0) {
-            String str = pArgs[0];
-
-            if (str.indexOf('/') >= 0) {
-                // MIME
-                String extension = getExtension(str);
-                System.out.println("Default extension for MIME type '" + str + "' is "
-                        + (extension != null ? ": '" + extension + "'" : "unknown") + ".");
-                System.out.println("All possible: " + getExtensions(str));
-            }
-            else {
-                // EXT
-                String mimeType = getMIMEType(str);
-                System.out.println("Default MIME type for extension '" + str + "' is "
-                        + (mimeType != null ? ": '" + mimeType + "'" : "unknown") + ".");
-                System.out.println("All possible: " + getMIMETypes(str));
-            }
-
-            return;
-        }
-
-        Set set = sMIMEToExt.keySet();
-        String[] mimeTypes = new String[set.size()];
-        int i = 0;
-        for (Iterator iterator = set.iterator(); iterator.hasNext(); i++) {
-            String mime = (String) iterator.next();
-            mimeTypes[i] = mime;
-        }
-        Arrays.sort(mimeTypes);
-
-        System.out.println("Known MIME types (" + mimeTypes.length + "):");
-        for (int j = 0; j < mimeTypes.length; j++) {
-            String mimeType = mimeTypes[j];
-
-            if (j != 0) {
-                System.out.print(", ");
-            }
-
-            System.out.print(mimeType);
-        }
-
-        System.out.println("\n");
-
-        set = sExtToMIME.keySet();
-        String[] extensions = new String[set.size()];
-        i = 0;
-        for (Iterator iterator = set.iterator(); iterator.hasNext(); i++) {
-            String ext = (String) iterator.next();
-            extensions[i] = ext;
-        }
-        Arrays.sort(extensions);
-
-        System.out.println("Known file types (" + extensions.length + "):");
-        for (int j = 0; j < extensions.length; j++) {
-            String extension = extensions[j];
-
-            if (j != 0) {
-                System.out.print(", ");
-            }
-
-            System.out.print(extension);
-        }
-        System.out.println();
-    }
+/*
+ * Copyright (c) 2008, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.net;
+
+import com.twelvemonkeys.lang.StringUtil;
+import com.twelvemonkeys.lang.SystemUtil;
+
+import java.io.IOException;
+import java.util.*;
+
+/**
+ * Contains mappings from file extension to mime-types and from mime-type to file-types.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/MIMEUtil.java#5 $
+ *
+ * @see <A href="http://www.iana.org/assignments/media-types/">MIME Media Types</A>
+ */
+public final class MIMEUtil {
+    // TODO: Piggy-back on the mappings form the JRE? (1.6 comes with javax.activation)
+    // TODO: Piggy-back on mappings from javax.activation?
+    // See: http://java.sun.com/j2ee/sdk_1.3/techdocs/api/javax/activation/MimetypesFileTypeMap.html
+    // See: http://java.sun.com/javase/6/docs/api/javax/activation/MimetypesFileTypeMap.html
+    // TODO: Use the format (and lookup) specified by the above URLs
+    // TODO: Allow 3rd party to add mappings? Will need application context support to do it safe.. :-P
+
+    private static Map<String, List<String>> sExtToMIME = new HashMap<String, List<String>>();
+    private static Map<String, List<String>> sUnmodifiableExtToMIME = Collections.unmodifiableMap(sExtToMIME);
+
+    private static Map<String, List<String>> sMIMEToExt = new HashMap<String, List<String>>();
+    private static Map<String, List<String>> sUnmodifiableMIMEToExt = Collections.unmodifiableMap(sMIMEToExt);
+
+    static {
+        // Load mapping for MIMEUtil
+        try {
+            Properties mappings = SystemUtil.loadProperties(MIMEUtil.class);
+
+            for (Map.Entry entry : mappings.entrySet()) {
+                // Convert and break up extensions and mimeTypes
+                String extStr = StringUtil.toLowerCase((String) entry.getKey());
+                List<String> extensions =
+                        Collections.unmodifiableList(Arrays.asList(StringUtil.toStringArray(extStr, ";, ")));
+
+                String typeStr = StringUtil.toLowerCase((String) entry.getValue());
+                List<String> mimeTypes =
+                        Collections.unmodifiableList(Arrays.asList(StringUtil.toStringArray(typeStr, ";, ")));
+
+                // TODO: Handle duplicates in MIME to extension mapping, like
+                // xhtml=application/xhtml+xml;application/xml
+                // xml=text/xml;application/xml
+
+                // Populate normal and reverse MIME-mappings
+                for (String extension : extensions) {
+                    sExtToMIME.put(extension, mimeTypes);
+                }
+
+                for (String mimeType : mimeTypes) {
+                    sMIMEToExt.put(mimeType, extensions);
+                }
+            }
+        }
+        catch (IOException e) {
+            System.err.println("Could not read properties for MIMEUtil: " + e.getMessage());
+            e.printStackTrace();
+        }
+    }
+
+    // Disallow construction
+    private MIMEUtil() {
+    }
+
+    /**
+     * Returns the default MIME type for the given file extension.
+     *
+     * @param pFileExt the file extension
+     *
+     * @return a {@code String} containing the MIME type, or {@code null} if
+     * there are no known MIME types for the given file extension.
+     */
+    public static String getMIMEType(final String pFileExt) {
+        List<String> types = sExtToMIME.get(StringUtil.toLowerCase(pFileExt));
+        return (types == null || types.isEmpty()) ? null : types.get(0);
+    }
+
+    /**
+     * Returns all MIME types for the given file extension.
+     *
+     * @param pFileExt the file extension
+     *
+     * @return a {@link List} of {@code String}s containing the MIME types, or an empty
+     * list, if there are no known MIME types for the given file extension.
+     */
+    public static List<String> getMIMETypes(final String pFileExt) {
+        List<String> types = sExtToMIME.get(StringUtil.toLowerCase(pFileExt));
+        return maskNull(types);
+    }
+
+    /**
+     * Returns an unmodifiabale {@link Map} view of the extension to
+     * MIME mapping, to use as the default mapping in client applications.
+     *
+     * @return an unmodifiabale {@code Map} view of the extension to
+     * MIME mapping.
+     */
+    public static Map<String, List<String>> getMIMETypeMappings() {
+        return sUnmodifiableExtToMIME;
+    }
+
+    /**
+     * Returns the default file extension for the given MIME type.
+     * Specifying a wildcard type will return {@code null}.
+     *
+     * @param pMIME the MIME type
+     *
+     * @return a {@code String} containing the file extension, or {@code null}
+     * if there are no known file extensions for the given MIME type.
+     */
+    public static String getExtension(final String pMIME) {
+        String mime = bareMIME(StringUtil.toLowerCase(pMIME));
+        List<String> extensions = sMIMEToExt.get(mime);
+        return (extensions == null || extensions.isEmpty()) ? null : extensions.get(0);
+    }
+
+    /**
+     * Returns all file extension for the given MIME type.
+     * The default extension will be the first in the list.
+     * Note that no specific order is given for wildcard types (image/*, *&#47;* etc).
+     *
+     * @param pMIME the MIME type
+     *
+     * @return a {@link List} of {@code String}s containing the MIME types, or an empty
+     * list, if there are no known file extensions for the given MIME type.
+     */
+    public static List<String> getExtensions(final String pMIME) {
+        String mime = bareMIME(StringUtil.toLowerCase(pMIME));
+        if (mime.endsWith("/*")) {
+            return getExtensionForWildcard(mime);
+        }
+        List<String> extensions = sMIMEToExt.get(mime);
+        return maskNull(extensions);
+    }
+
+    // Gets all extensions for a wildcard MIME type
+    private static List<String> getExtensionForWildcard(final String pMIME) {
+        final String family = pMIME.substring(0, pMIME.length() - 1);
+        Set<String> extensions = new LinkedHashSet<String>();
+        for (Map.Entry<String, List<String>> mimeToExt : sMIMEToExt.entrySet()) {
+            if ("*/".equals(family) || mimeToExt.getKey().startsWith(family)) {
+                extensions.addAll(mimeToExt.getValue());
+            }
+        }
+        return Collections.unmodifiableList(new ArrayList<String>(extensions));
+    }
+
+    /**
+     * Returns an unmodifiabale {@link Map} view of the MIME to
+     * extension mapping, to use as the default mapping in client applications.
+     *
+     * @return an unmodifiabale {@code Map} view of the MIME to
+     * extension mapping.
+     */
+    public static Map<String, List<String>> getExtensionMappings() {
+        return sUnmodifiableMIMEToExt;
+    }
+
+    /**
+     * Tests wehter the type is a subtype of the type family.
+     *
+     * @param pTypeFamily the MIME type family ({@code image/*, *&#47;*}, etc)
+     * @param pType the MIME type
+     * @return {@code true} if {@code pType} is a subtype of {@code pTypeFamily}, otherwise {@code false}
+     */
+    // TODO: Rename? isSubtype?
+    // TODO: Make public
+    static boolean includes(final String pTypeFamily, final String pType) {
+        // TODO: Handle null in a well-defined way
+        // - Is null family same as */*?
+        // - Is null subtype of any family? Subtype of no family?
+
+        String type = bareMIME(pType);
+        return type.equals(pTypeFamily)
+                || "*/*".equals(pTypeFamily)
+                || pTypeFamily.endsWith("/*") && pTypeFamily.startsWith(type.substring(0, type.indexOf('/')));
+    }
+
+    /**
+     * Removes any charset or extra info from the mime-type string (anything after a semicolon, {@code ;}, inclusive).
+     *
+     * @param pMIME the mime-type string
+     * @return the bare mime-type
+     */
+    public static String bareMIME(final String pMIME) {
+        int idx;
+        if (pMIME != null && (idx = pMIME.indexOf(';')) >= 0) {
+            return pMIME.substring(0, idx);
+        }
+        return pMIME;
+    }
+
+    // Returns the list or empty list if list is null
+    private static List<String> maskNull(List<String> pTypes) {
+        return (pTypes == null) ? Collections.<String>emptyList() : pTypes;
+    }
+
+    /**
+     * For debugging. Prints all known MIME types and file extensions.
+     *
+     * @param pArgs command line arguments
+     */
+    public static void main(String[] pArgs) {
+        if (pArgs.length > 1) {
+            String type = pArgs[0];
+            String family = pArgs[1];
+            boolean incuded = includes(family, type);
+            System.out.println(
+                    "Mime type family " + family
+                    + (incuded ? " includes " : " does not include ")
+                    + "type " + type
+            );
+        }
+        if (pArgs.length > 0) {
+            String str = pArgs[0];
+
+            if (str.indexOf('/') >= 0) {
+                // MIME
+                String extension = getExtension(str);
+                System.out.println("Default extension for MIME type '" + str + "' is "
+                        + (extension != null ? ": '" + extension + "'" : "unknown") + ".");
+                System.out.println("All possible: " + getExtensions(str));
+            }
+            else {
+                // EXT
+                String mimeType = getMIMEType(str);
+                System.out.println("Default MIME type for extension '" + str + "' is "
+                        + (mimeType != null ? ": '" + mimeType + "'" : "unknown") + ".");
+                System.out.println("All possible: " + getMIMETypes(str));
+            }
+
+            return;
+        }
+
+        Set set = sMIMEToExt.keySet();
+        String[] mimeTypes = new String[set.size()];
+        int i = 0;
+        for (Iterator iterator = set.iterator(); iterator.hasNext(); i++) {
+            String mime = (String) iterator.next();
+            mimeTypes[i] = mime;
+        }
+        Arrays.sort(mimeTypes);
+
+        System.out.println("Known MIME types (" + mimeTypes.length + "):");
+        for (int j = 0; j < mimeTypes.length; j++) {
+            String mimeType = mimeTypes[j];
+
+            if (j != 0) {
+                System.out.print(", ");
+            }
+
+            System.out.print(mimeType);
+        }
+
+        System.out.println("\n");
+
+        set = sExtToMIME.keySet();
+        String[] extensions = new String[set.size()];
+        i = 0;
+        for (Iterator iterator = set.iterator(); iterator.hasNext(); i++) {
+            String ext = (String) iterator.next();
+            extensions[i] = ext;
+        }
+        Arrays.sort(extensions);
+
+        System.out.println("Known file types (" + extensions.length + "):");
+        for (int j = 0; j < extensions.length; j++) {
+            String extension = extensions[j];
+
+            if (j != 0) {
+                System.out.print(", ");
+            }
+
+            System.out.print(extension);
+        }
+        System.out.println();
+    }
 }

common/common-io/src/main/java/com/twelvemonkeys/xml/DOMSerializer.java

@@ -29,6 +29,9 @@
 
 package com.twelvemonkeys.xml;
 
+import java.io.OutputStream;
+import java.io.Writer;
+
 import org.w3c.dom.DOMConfiguration;
 import org.w3c.dom.DOMImplementationList;
 import org.w3c.dom.Document;
@@ -38,9 +41,6 @@ import org.w3c.dom.ls.DOMImplementationLS;
 import org.w3c.dom.ls.LSOutput;
 import org.w3c.dom.ls.LSSerializer;
 
-import java.io.OutputStream;
-import java.io.Writer;
-
 /**
  * {@code DOMImplementationLS} backed implementation.
  *
@@ -88,22 +88,12 @@ public final class DOMSerializer {
         output.setCharacterStream(pStream);
     }
 
-    /*
-    // TODO: Is it useful?
-    public void setNewLine(final String pNewLine) {
-        serializer.setNewLine(pNewLine);
-    }
-
-    public String getNewLine() {
-        return serializer.getNewLine();
-    }
-    */
-
     /**
      * Specifies wether the serializer should use indentation and optimize for
      * readability.
-     * <p/>
-     * Note: This is a hint, and may be ignored by DOM implemenations. 
+     * <p>
+     * Note: This is a hint, and may be ignored by DOM implementations.
+     * </p>
      *
      * @param pPrettyPrint {@code true} to enable pretty printing
      */
@@ -168,13 +158,7 @@ public final class DOMSerializer {
             try {
                 return DOMImplementationRegistry.newInstance();
             }
-            catch (ClassNotFoundException e) {
-                throw new IllegalStateException(e);
-            }
-            catch (InstantiationException e) {
-                throw new IllegalStateException(e);
-            }
-            catch (IllegalAccessException e) {
+            catch (ClassNotFoundException | InstantiationException | IllegalAccessException e) {
                 throw new IllegalStateException(e);
             }
         }

common/common-io/src/main/java/com/twelvemonkeys/xml/XMLSerializer.java

@@ -30,16 +30,23 @@
 
 package com.twelvemonkeys.xml;
 
-import com.twelvemonkeys.lang.StringUtil;
-import org.w3c.dom.*;
-import org.xml.sax.SAXException;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.PrintWriter;
+import java.nio.charset.Charset;
+import java.util.Date;
 
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
-import java.io.*;
-import java.nio.charset.Charset;
-import java.util.Date;
+
+import org.w3c.dom.*;
+import org.xml.sax.SAXException;
+
+import com.twelvemonkeys.lang.StringUtil;
 
 /**
  * XMLSerializer
@@ -290,7 +297,7 @@ public class XMLSerializer {
     }
 
     private static int appendAndEscape(final String pString, int pStart, final int pEnd, final StringBuilder pBuilder, final String pEntity) {
-        pBuilder.append(pString.substring(pStart, pEnd));
+        pBuilder.append(pString, pStart, pEnd);
         pBuilder.append(pEntity);
         return pEnd + 1;
     }
@@ -389,9 +396,10 @@ public class XMLSerializer {
     private void writeDocument(final PrintWriter pOut, final Node pNode, final SerializationContext pContext) {
         // Document fragments might not have child nodes...
         if (pNode.hasChildNodes()) {
-            NodeList nodes = pNode.getChildNodes();
-            for (int i = 0; i < nodes.getLength(); i++) {
-                writeNodeRecursive(pOut, nodes.item(i), pContext);
+            Node child = pNode.getFirstChild();
+            while (child != null) {
+                writeNodeRecursive(pOut, child, pContext);
+                child = child.getNextSibling();
             }
         }
     }
@@ -448,9 +456,10 @@ public class XMLSerializer {
                 pOut.println();
             }
 
-            NodeList children = pNode.getChildNodes();
-            for (int i = 0; i < children.getLength(); i++) {
-                writeNodeRecursive(pOut, children.item(i), pContext.push());
+            Node child = pNode.getFirstChild();
+            while (child != null) {
+                writeNodeRecursive(pOut, child, pContext.push());
+                child = child.getNextSibling();
             }
 
             if (!pContext.preserveSpace) {
@@ -525,8 +534,7 @@ public class XMLSerializer {
             builder = factory.newDocumentBuilder();
         }
         catch (ParserConfigurationException e) {
-            //noinspection ThrowableInstanceNeverThrown BOGUS
-            throw (IOException) new IOException(e.getMessage()).initCause(e);
+            throw new IOException(e);
         }
 
         DOMImplementation dom = builder.getDOMImplementation();

common/common-io/src/test/java/com/twelvemonkeys/io/CompoundReaderTest.java

@@ -32,7 +32,6 @@ package com.twelvemonkeys.io;
 
 import com.twelvemonkeys.lang.StringUtil;
 import com.twelvemonkeys.util.CollectionUtil;
-import org.junit.Test;
 
 import java.io.IOException;
 import java.io.Reader;
@@ -40,7 +39,8 @@ import java.io.StringReader;
 import java.util.ArrayList;
 import java.util.List;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * CompoundReaderTestCase

common/common-io/src/test/java/com/twelvemonkeys/io/FastByteArrayOutputStreamTest.java

@@ -30,12 +30,11 @@
 
 package com.twelvemonkeys.io;
 
-import org.junit.Test;
-
 import java.io.IOException;
 import java.io.InputStream;
 
-import static org.junit.Assert.assertEquals;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * FastByteArrayOutputStreamTestCase

common/common-io/src/test/java/com/twelvemonkeys/io/FileSeekableStreamTest.java

@@ -30,11 +30,10 @@
 
 package com.twelvemonkeys.io;
 
-import org.junit.Test;
-
 import java.io.*;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * MemoryCacheSeekableStreamTestCase
@@ -92,13 +91,13 @@ public class FileSeekableStreamTest extends SeekableInputStreamAbstractTest {
         try {
             FileUtil.read(stream); // Read until EOF
 
-            assertEquals("EOF not reached (test case broken)", -1, stream.read());
-            assertFalse("Underlying stream closed before close", closed[0]);
+            assertEquals(-1, stream.read(), "EOF not reached (test case broken)");
+            assertFalse(closed[0], "Underlying stream closed before close");
         }
         finally {
             stream.close();
         }
 
-        assertTrue("Underlying stream not closed", closed[0]);
+        assertTrue(closed[0], "Underlying stream not closed");
     }
 }

common/common-io/src/test/java/com/twelvemonkeys/io/InputStreamAbstractTest.java

@@ -46,14 +46,14 @@
 package com.twelvemonkeys.io;
 
 import com.twelvemonkeys.lang.ObjectAbstractTest;
-import org.junit.Test;
 
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Random;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * InputStreamAbstractTestCase
@@ -104,15 +104,15 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
         int size = 5;
         InputStream input = makeInputStream(makeOrderedArray(size));
         for (int i = 0; i < size; i++) {
-            assertTrue("Check Size [" + i + "]", (size - i) >= input.available());
-            assertEquals("Check Value [" + i + "]", i, input.read());
+            assertTrue((size - i) >= input.available(), "Check Size [" + i + "]");
+            assertEquals(i, input.read(), "Check Value [" + i + "]");
         }
-        assertEquals("Available after contents all read", 0, input.available());
+        assertEquals(0, input.available(), "Available after contents all read");
 
         // Test reading after the end of file
         try {
             int result = input.read();
-            assertEquals("Wrong value read after end of file", -1, result);
+            assertEquals( -1, result, "Wrong value read after end of file");
         }
         catch (IOException e) {
             fail("Should not have thrown an IOException: " + e.getMessage());
@@ -122,12 +122,12 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
     @Test
     public void testAvailable() throws Exception {
         InputStream input = makeInputStream(1);
-        assertFalse("Unexpected EOF", input.read() < 0);
-        assertEquals("Available after contents all read", 0, input.available());
+        assertFalse(input.read() < 0, "Unexpected EOF");
+        assertEquals(0, input.available(), "Available after contents all read");
 
         // Check availbale is zero after End of file
-        assertEquals("End of File", -1, input.read());
-        assertEquals("Available after End of File", 0, input.available());
+        assertEquals(-1, input.read(), "End of File");
+        assertEquals( 0, input.available(), "Available after End of File");
     }
 
     @Test
@@ -138,26 +138,26 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
 
         // Read into array
         int count1 = input.read(bytes);
-        assertEquals("Read 1", bytes.length, count1);
+        assertEquals(bytes.length, count1, "Read 1");
         for (int i = 0; i < count1; i++) {
-            assertEquals("Check Bytes 1", i, bytes[i]);
+            assertEquals(i, bytes[i], "Check Bytes 1");
         }
 
         // Read into array
         int count2 = input.read(bytes);
-        assertEquals("Read 2", 5, count2);
+        assertEquals(5, count2, "Read 2");
         for (int i = 0; i < count2; i++) {
-            assertEquals("Check Bytes 2", count1 + i, bytes[i]);
+            assertEquals(count1 + i, bytes[i], "Check Bytes 2");
         }
 
         // End of File
         int count3 = input.read(bytes);
-        assertEquals("Read 3 (EOF)", -1, count3);
+        assertEquals(-1, count3, "Read 3 (EOF)");
 
         // Test reading after the end of file
         try {
             int result = input.read(bytes);
-            assertEquals("Wrong value read after end of file", -1, result);
+            assertEquals(-1, result, "Wrong value read after end of file");
         }
         catch (IOException e) {
             fail("Should not have thrown an IOException: " + e.getMessage());
@@ -170,20 +170,20 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
         int offset = 2;
         int lth = 4;
         int count5 = input.read(bytes, offset, lth);
-        assertEquals("Read 5", lth, count5);
+        assertEquals(lth, count5, "Read 5");
         for (int i = offset; i < lth; i++) {
-            assertEquals("Check Bytes 2", i - offset, bytes[i]);
+            assertEquals(i - offset, bytes[i], "Check Bytes 2");
         }
     }
 
     @Test
     public void testEOF() throws Exception {
         InputStream input = makeInputStream(makeOrderedArray(2));
-        assertEquals("Read 1", 0, input.read());
-        assertEquals("Read 2", 1, input.read());
-        assertEquals("Read 3", -1, input.read());
-        assertEquals("Read 4", -1, input.read());
-        assertEquals("Read 5", -1, input.read());
+        assertEquals(0, input.read(), "Read 1");
+        assertEquals(1, input.read(), "Read 2");
+        assertEquals(-1, input.read(), "Read 3");
+        assertEquals(-1, input.read(), "Read 4");
+        assertEquals(-1, input.read(), "Read 5");
     }
 
     @Test
@@ -205,7 +205,7 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
             fail("Should throw IOException");
         }
         catch (IOException e) {
-            assertTrue("Wrong messge: " + e.getMessage(), e.getMessage().contains("reset"));
+            assertTrue(e.getMessage().contains("reset"), "Wrong messge: " + e.getMessage());
         }
     }
 
@@ -223,10 +223,10 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
         // No mark may either throw exception, or reset to beginning of stream.
         try {
             input.reset();
-            assertEquals("Re-read of reset data should be same", 0, input.read());
+            assertEquals(0, input.read(), "Re-read of reset data should be same");
         }
         catch (Exception e) {
-            assertTrue("Wrong no mark IOException message", e.getMessage().contains("mark"));
+            assertTrue(e.getMessage().contains("mark"), "Wrong no mark IOException message");
         }
     }
 
@@ -249,7 +249,7 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
 
         // Read further
         for (int i = 0; i < 3; i++) {
-            assertEquals("Read After Mark [" + i + "]", (position + i), input.read());
+            assertEquals((position + i), input.read(), "Read After Mark [" + i + "]");
         }
 
         // Reset
@@ -257,7 +257,7 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
 
         // Read from marked position
         for (int i = 0; i < readlimit + 1; i++) {
-            assertEquals("Read After Reset [" + i + "]", (position + i), input.read());
+            assertEquals((position + i), input.read(), "Read After Reset [" + i + "]");
         }
     }
 
@@ -280,16 +280,16 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
 
         // Read past marked position
         for (int i = 0; i < readlimit + 1; i++) {
-            assertEquals("Read After Reset [" + i + "]", (position + i), input.read());
+            assertEquals((position + i), input.read(), "Read After Reset [" + i + "]");
         }
 
         // Reset after read limit passed, may either throw exception, or reset to last mark
         try {
             input.reset();
-            assertEquals("Re-read of reset data should be same", 1, input.read());
+            assertEquals(1, input.read(), "Re-read of reset data should be same");
         }
         catch (Exception e) {
-            assertTrue("Wrong read-limit IOException message", e.getMessage().contains("mark"));
+            assertTrue(e.getMessage().contains("mark"), "Wrong read-limit IOException message");
         }
     }
 
@@ -302,29 +302,29 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
         }
 
         int first = input.read();
-        assertTrue("Expected to read positive value", first >= 0);
+        assertTrue(first >= 0, "Expected to read positive value");
 
         int readlimit = 5;
 
         // Mark
         input.mark(readlimit);
         int read = input.read();
-        assertTrue("Expected to read positive value", read >= 0);
+        assertTrue(read >= 0, "Expected to read positive value");
 
         assertTrue(input.read() >= 0);
         assertTrue(input.read() >= 0);
 
         input.reset();
-        assertEquals("Expected value read differs from actual", read, input.read());
+        assertEquals(read, input.read(), "Expected value read differs from actual");
 
         // Reset after read limit passed, may either throw exception, or reset to last good mark
         try {
             input.reset();
             int reRead = input.read();
-            assertTrue("Re-read of reset data should be same as initially marked or first", reRead == read || reRead == first);
+            assertTrue(reRead == read || reRead == first, "Re-read of reset data should be same as initially marked or first");
         }
         catch (Exception e) {
-            assertTrue("Wrong read-limit IOException message", e.getMessage().contains("mark"));
+            assertTrue(e.getMessage().contains("mark"), "Wrong read-limit IOException message");
         }
     }
 
@@ -332,17 +332,17 @@ public abstract class InputStreamAbstractTest extends ObjectAbstractTest {
     public void testSkip() throws Exception {
         InputStream input = makeInputStream(makeOrderedArray(10));
 
-        assertEquals("Unexpected value read", 0, input.read());
-        assertEquals("Unexpected value read", 1, input.read());
-        assertEquals("Unexpected number of bytes skipped", 5, input.skip(5));
-        assertEquals("Unexpected value read", 7, input.read());
+        assertEquals(0, input.read(), "Unexpected value read");
+        assertEquals(1, input.read(), "Unexpected value read");
+        assertEquals(5, input.skip(5), "Unexpected number of bytes skipped");
+        assertEquals(7, input.read(), "Unexpected value read");
 
-        assertEquals("Unexpected number of bytes skipped", 2, input.skip(5)); // only 2 left to skip
-        assertEquals("Unexpected value read after EOF", -1, input.read());
+        assertEquals(2, input.skip(5), "Unexpected number of bytes skipped"); // only 2 left to skip
+        assertEquals(-1, input.read(), "Unexpected value read after EOF");
 
         // Spec says skip might return 0 or negative after EOF...
-        assertTrue("Positive value skipped after EOF", input.skip(5) <= 0); // End of file
-        assertEquals("Unexpected value read after EOF", -1, input.read());
+        assertTrue(input.skip(5) <= 0, "Positive value skipped after EOF"); // End of file
+        assertEquals(-1, input.read(), "Unexpected value read after EOF");
     }
 
     @Test

common/common-io/src/test/java/com/twelvemonkeys/io/LittleEndianDataInputStreamTest.java

@@ -30,12 +30,11 @@
 
 package com.twelvemonkeys.io;
 
-import org.junit.Test;
-
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * LittleEndianDataInputStreamTest

common/common-io/src/test/java/com/twelvemonkeys/io/OutputStreamAbstractTest.java

@@ -31,13 +31,12 @@
 package com.twelvemonkeys.io;
 
 import com.twelvemonkeys.lang.ObjectAbstractTest;
-import org.junit.Test;
 
 import java.io.IOException;
 import java.io.OutputStream;
 
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.fail;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * InputStreamAbstractTestCase

common/common-io/src/test/java/com/twelvemonkeys/io/ReaderAbstractTest.java

@@ -31,12 +31,12 @@
 package com.twelvemonkeys.io;
 
 import com.twelvemonkeys.lang.ObjectAbstractTest;
-import org.junit.Test;
 
 import java.io.IOException;
 import java.io.Reader;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * ReaderAbstractTestCase
@@ -112,7 +112,7 @@ public abstract class ReaderAbstractTest extends ObjectAbstractTest {
         int toSkip = mInput.length();
         while (toSkip > 0) {
             long skipped = reader.skip(toSkip);
-            assertFalse("Skipped < 0", skipped < 0);
+            assertFalse(skipped < 0, "Skipped < 0");
             toSkip -= skipped;
         }
 

common/common-io/src/test/java/com/twelvemonkeys/io/SeekableAbstractTest.java

@@ -30,10 +30,8 @@
 
 package com.twelvemonkeys.io;
 
-import org.junit.Test;
-
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * SeekableAbstractTestCase

common/common-io/src/test/java/com/twelvemonkeys/io/SeekableInputStreamAbstractTest.java

@@ -30,14 +30,13 @@
 
 package com.twelvemonkeys.io;
 
-import org.junit.Test;
-
 import java.io.ByteArrayInputStream;
 import java.io.EOFException;
 import java.io.IOException;
 import java.io.InputStream;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * SeekableInputStreamAbstractTest
@@ -79,25 +78,25 @@ public abstract class SeekableInputStreamAbstractTest extends InputStreamAbstrac
             return; // Not supported, skip test
         }
 
-        assertTrue("Expected to read positive value", input.read() >= 0);
+        assertTrue(input.read() >= 0, "Expected to read positive value");
 
         int readlimit = 5;
 
         // Mark
         input.mark(readlimit);
         int read = input.read();
-        assertTrue("Expected to read positive value", read >= 0);
+        assertTrue(read >= 0, "Expected to read positive value");
 
         input.reset();
-        assertEquals("Expected value read differs from actual", read, input.read());
+        assertEquals(read, input.read(), "Expected value read differs from actual");
 
         // Reset after read limit passed, may either throw exception, or reset to last good mark
         try {
             input.reset();
-            assertEquals("Re-read of reset data should be first", 0, input.read());
+            assertEquals(0, input.read(), "Re-read of reset data should be first");
         }
         catch (Exception e) {
-            assertTrue("Wrong read-limit IOException message", e.getMessage().contains("mark"));
+            assertTrue(e.getMessage().contains("mark"), "Wrong read-limit IOException message");
         }
     }
 
@@ -127,7 +126,7 @@ public abstract class SeekableInputStreamAbstractTest extends InputStreamAbstrac
 
         seekable.seek(pos);
         long streamPos = seekable.getStreamPosition();
-        assertEquals("Stream positon should match seeked position", pos, streamPos);
+        assertEquals(pos, streamPos, "Stream positon should match seeked position");
     }
 
     @Test
@@ -137,7 +136,7 @@ public abstract class SeekableInputStreamAbstractTest extends InputStreamAbstrac
         seekable.seek(pos);
         seekable.flushBefore(pos);
         long flushedPos = seekable.getFlushedPosition();
-        assertEquals("Flushed positon should match position", pos, flushedPos);
+        assertEquals(pos, flushedPos, "Flushed positon should match position");
 
         try {
             seekable.seek(pos - 1);
@@ -382,13 +381,13 @@ public abstract class SeekableInputStreamAbstractTest extends InputStreamAbstrac
         int val;
 
         val = stream.read();
-        assertFalse("Unexepected EOF", val == -1);
+        assertFalse(val == -1, "Unexepected EOF");
         val = stream.read();
-        assertFalse("Unexepected EOF", val == -1);
+        assertFalse(val == -1, "Unexepected EOF");
         val = stream.read();
-        assertFalse("Unexepected EOF", val == -1);
+        assertFalse(val == -1, "Unexepected EOF");
         val = stream.read();
-        assertFalse("Unexepected EOF", val == -1);
+        assertFalse(val == -1, "Unexepected EOF");
 
         stream.seek(0);
 
@@ -422,19 +421,19 @@ public abstract class SeekableInputStreamAbstractTest extends InputStreamAbstrac
 
         stream.seek(0);
         for (int i = 0; i < bytes.length; i += 2) {
-            assertEquals("Wrong stream position", i, stream.getStreamPosition());
+            assertEquals(i, stream.getStreamPosition(), "Wrong stream position");
             int count = stream.read(buffer, 0, 2);
             assertEquals(2, count);
-            assertEquals(String.format("Wrong value read at pos %d", stream.getStreamPosition()), bytes[i], buffer[0]);
-            assertEquals(String.format("Wrong value read at pos %d", stream.getStreamPosition()), bytes[i + 1], buffer[1]);
+            assertEquals(bytes[i], buffer[0], String.format("Wrong value read at pos %d", stream.getStreamPosition()));
+            assertEquals(bytes[i + 1], buffer[1], String.format("Wrong value read at pos %d", stream.getStreamPosition()));
         }
 
         stream.seek(0);
         for (int i = 0; i < bytes.length; i++) {
-            assertEquals("Wrong stream position", i, stream.getStreamPosition());
+            assertEquals(i, stream.getStreamPosition(), "Wrong stream position");
             int actual = stream.read();
-            assertEquals(String.format("Wrong value read at pos %d", stream.getStreamPosition()), bytes[i] & 0xff, actual);
-            assertEquals(String.format("Wrong value read at pos %d", stream.getStreamPosition()), bytes[i], (byte) actual);
+            assertEquals(bytes[i] & 0xff, actual, String.format("Wrong value read at pos %d", stream.getStreamPosition()));
+            assertEquals(bytes[i], (byte) actual, String.format("Wrong value read at pos %d", stream.getStreamPosition()));
         }
 
     }
@@ -456,14 +455,14 @@ public abstract class SeekableInputStreamAbstractTest extends InputStreamAbstrac
         try {
             FileUtil.read(stream); // Read until EOF
 
-            assertEquals("EOF not reached (test case broken)", -1, stream.read());
-            assertFalse("Underlying stream closed before close", closed[0]);
+            assertEquals(-1, stream.read(), "EOF not reached (test case broken)");
+            assertFalse(closed[0], "Underlying stream closed before close");
         }
         finally {
             stream.close();
         }
 
-        assertTrue("Underlying stream not closed", closed[0]);
+        assertTrue(closed[0], "Underlying stream not closed");
 
     }
 

common/common-io/src/test/java/com/twelvemonkeys/io/StringArrayReaderTest.java

@@ -31,12 +31,12 @@
 package com.twelvemonkeys.io;
 
 import com.twelvemonkeys.lang.StringUtil;
-import org.junit.Test;
 
 import java.io.IOException;
 import java.io.Reader;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * StringArrayReaderTestCase

common/common-io/src/test/java/com/twelvemonkeys/io/SubStreamTest.java

@@ -0,0 +1,119 @@
+package com.twelvemonkeys.io;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.time.Duration;
+import java.util.Arrays;
+import java.util.Random;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+
+/**
+ * SubStreamTest.
+ *
+ * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>
+ * @author last modified by $Author: haraldk$
+ * @version $Id: SubStreamTest.java,v 1.0 07/11/2023 haraldk Exp$
+ */
+public class SubStreamTest {
+
+    private final Random rng = new Random(2918475687L);
+
+    @SuppressWarnings("resource")
+    @Test
+    public void testCreateNullStream() {
+        assertThrows(IllegalArgumentException.class, () -> {
+            new SubStream(null, 42);
+        });
+    }
+
+    @Test
+    public void testCreateNegativeLength() {
+        assertThrows(IllegalArgumentException.class, () -> {
+            new SubStream(new ByteArrayInputStream(new byte[1]), -1);
+        });
+    }
+
+    @Test
+    public void testReadAll() throws IOException {
+        byte[] buf = new byte[128];
+        rng.nextBytes(buf);
+
+        try (InputStream stream = new SubStream(new ByteArrayInputStream(buf), buf.length)) {
+            for (byte b : buf) {
+                assertEquals(b, (byte) stream.read());
+            }
+
+            assertEquals(-1, stream.read());
+        }
+    }
+
+    @Test
+    public void testReadAllArray() throws IOException {
+        byte[] buf = new byte[128];
+        rng.nextBytes(buf);
+
+        try (InputStream stream = new SubStream(new ByteArrayInputStream(buf), buf.length)) {
+            byte[] temp = new byte[buf.length / 4];
+            for (int i = 0; i < 4; i++) {
+                assertEquals(temp.length, stream.read(temp)); // Depends on ByteArrayInputStream specifics...
+                assertArrayEquals(Arrays.copyOfRange(buf, i * temp.length, (i + 1) * temp.length), temp);
+            }
+
+            assertEquals(-1, stream.read());
+        }
+    }
+
+    @Test
+    public void testSkipAll() throws IOException {
+        byte[] buf = new byte[128];
+
+        try (InputStream stream = new SubStream(new ByteArrayInputStream(buf), buf.length)) {
+            assertEquals(128, stream.skip(buf.length)); // Depends on ByteArrayInputStream specifics...
+            assertEquals(-1, stream.read());
+        }
+    }
+
+    @SuppressWarnings("EmptyTryBlock")
+    @Test
+    public void testCloseConsumesAll() throws IOException {
+        ByteArrayInputStream stream = new ByteArrayInputStream(new byte[128]);
+
+        try (InputStream ignore = new SubStream(stream, 128)) {
+            // Nothing here...
+        }
+
+        assertEquals(0, stream.available());
+        assertEquals(-1, stream.read());
+    }
+
+    @SuppressWarnings("EmptyTryBlock")
+    @Test
+    public void testCloseConsumesAllLongStream() throws IOException {
+        ByteArrayInputStream stream = new ByteArrayInputStream(new byte[256]);
+
+        try (InputStream ignore = new SubStream(stream, 128)) {
+            // Nothing here...
+        }
+
+        assertEquals(128, stream.available());
+        assertEquals(0, stream.read());
+    }
+
+    @SuppressWarnings("EmptyTryBlock")
+    @Test
+    public void testCloseConsumesAllShortStream() throws IOException {
+        assertTimeoutPreemptively(Duration.ofMillis(500), () -> {
+            ByteArrayInputStream stream = new ByteArrayInputStream(new byte[13]);
+
+            try (InputStream ignore = new SubStream(stream, 42)) {
+                // Nothing here...
+            }
+
+            assertEquals(0, stream.available());
+            assertEquals(-1, stream.read());
+        });
+    }
+}

common/common-io/src/test/java/com/twelvemonkeys/io/enc/Base64DecoderTest.java

@@ -31,15 +31,13 @@
 package com.twelvemonkeys.io.enc;
 
 import com.twelvemonkeys.io.FileUtil;
-import org.junit.Test;
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
-
-import static org.junit.Assert.assertEquals;
-
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 /**
  * Base64DecoderTest
  * <p/>
@@ -66,7 +64,7 @@ public class Base64DecoderTest extends DecoderAbstractTest {
 
         FileUtil.copy(in, bytes);
 
-        assertEquals("Strings does not match", "", new String(bytes.toByteArray()));
+        assertEquals("", new String(bytes.toByteArray()), "Strings does not match");
     }
 
     @Test
@@ -78,7 +76,7 @@ public class Base64DecoderTest extends DecoderAbstractTest {
 
         FileUtil.copy(in, bytes);
 
-        assertEquals("Strings does not match", "test", new String(bytes.toByteArray()));
+        assertEquals("test", new String(bytes.toByteArray()), "Strings does not match");
     }
 
     @Test
@@ -93,11 +91,12 @@ public class Base64DecoderTest extends DecoderAbstractTest {
 
         FileUtil.copy(in, bytes);
 
-        assertEquals("Strings does not match",
+        assertEquals(
                      "Lorem ipsum dolor sit amet, consectetuer adipiscing " +
                      "elit. Fusce est. Morbi luctus consectetuer justo. Vivamus " +
                      "dapibus laoreet purus. Nunc viverra dictum nisl. Integer " +
                      "ullamcorper, nisi in dictum amet.",
-                     new String(bytes.toByteArray()));
+                     new String(bytes.toByteArray()),
+                    "Strings does not match");
     }
 }

common/common-io/src/test/java/com/twelvemonkeys/io/enc/Base64EncoderTest.java

@@ -30,13 +30,12 @@
 
 package com.twelvemonkeys.io.enc;
 
-import org.junit.Test;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.OutputStream;
-
-import static org.junit.Assert.assertEquals;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * Base64EncoderTest
@@ -63,7 +62,7 @@ public class Base64EncoderTest extends EncoderAbstractTest {
         OutputStream out = new EncoderStream(bytes, createEncoder(), true);
         out.write(data.getBytes());
 
-        assertEquals("Strings does not match", "", new String(bytes.toByteArray()));
+        assertEquals("", new String(bytes.toByteArray()), "Strings does not match");
     }
 
     @Test
@@ -74,7 +73,7 @@ public class Base64EncoderTest extends EncoderAbstractTest {
         OutputStream out = new EncoderStream(bytes, createEncoder(), true);
         out.write(data.getBytes());
 
-        assertEquals("Strings does not match", "dGVzdA==", new String(bytes.toByteArray()));
+        assertEquals("dGVzdA==", new String(bytes.toByteArray()), "Strings does not match");
     }
 
     @Test
@@ -88,11 +87,12 @@ public class Base64EncoderTest extends EncoderAbstractTest {
         OutputStream out = new EncoderStream(bytes, createEncoder(), true);
         out.write(data.getBytes());
 
-        assertEquals("Strings does not match",
+        assertEquals(
                      "TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVlciBhZGlwaXNjaW5nIGVsaXQuIEZ1" +
                     "c2NlIGVzdC4gTW9yYmkgbHVjdHVzIGNvbnNlY3RldHVlciBqdXN0by4gVml2YW11cyBkYXBpYnVzIGxh" +
                     "b3JlZXQgcHVydXMuIE51bmMgdml2ZXJyYSBkaWN0dW0gbmlzbC4gSW50ZWdlciB1bGxhbWNvcnBlciwg" +
                     "bmlzaSBpbiBkaWN0dW0gYW1ldC4=",
-                     new String(bytes.toByteArray()));
+                     new String(bytes.toByteArray()),
+                "Strings does not match");
     }
 }

common/common-io/src/test/java/com/twelvemonkeys/io/enc/DecoderAbstractTest.java

@@ -32,12 +32,13 @@ package com.twelvemonkeys.io.enc;
 
 import com.twelvemonkeys.io.FileUtil;
 import com.twelvemonkeys.lang.ObjectAbstractTest;
-import org.junit.Test;
 
+import java.awt.image.ImageProducer;
 import java.io.*;
 import java.nio.ByteBuffer;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * AbstractDecoderTest
@@ -55,13 +56,13 @@ public abstract class DecoderAbstractTest extends ObjectAbstractTest {
         return createDecoder();
     }
 
-    @Test(expected = NullPointerException.class)
+    @Test
     public final void testNullDecode() throws IOException {
         Decoder decoder = createDecoder();
         ByteArrayInputStream bytes = new ByteArrayInputStream(new byte[20]);
-
-        decoder.decode(bytes, null);
-        fail("null should throw NullPointerException");
+        assertThrows(NullPointerException.class, () -> {
+            decoder.decode(bytes, null);
+        });
     }
 
     @Test
@@ -71,7 +72,7 @@ public abstract class DecoderAbstractTest extends ObjectAbstractTest {
 
         try {
             int count = decoder.decode(bytes, ByteBuffer.allocate(128));
-            assertEquals("Should not be able to read any bytes", 0, count);
+            assertEquals( 0, count, "Should not be able to read any bytes");
         }
         catch (EOFException allowed) {
             // Okay
@@ -94,7 +95,7 @@ public abstract class DecoderAbstractTest extends ObjectAbstractTest {
         byte[] encoded = outBytes.toByteArray();
 
         byte[] decoded = FileUtil.read(new DecoderStream(new ByteArrayInputStream(encoded), createDecoder()));
-        assertArrayEquals(String.format("Data %d", pLength), data, decoded);
+        assertArrayEquals(data, decoded, String.format("Data %d", pLength));
 
         InputStream in = new DecoderStream(new ByteArrayInputStream(encoded), createDecoder());
         outBytes = new ByteArrayOutputStream();
@@ -103,7 +104,7 @@ public abstract class DecoderAbstractTest extends ObjectAbstractTest {
         in.close();
 
         decoded = outBytes.toByteArray();
-        assertArrayEquals(String.format("Data %d", pLength), data, decoded);
+        assertArrayEquals(data, decoded, String.format("Data %d", pLength));
     }
 
     @Test

common/common-io/src/test/java/com/twelvemonkeys/io/enc/DecoderStreamTest.java

@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) 2022, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+import java.util.Arrays;
+import java.util.Random;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+
+public class DecoderStreamTest {
+
+    private final Random rng = new Random(5467809876546L);
+
+    private byte[] createData(final int length) {
+        byte[] data = new byte[length];
+        rng.nextBytes(data);
+        return data;
+    }
+
+    @Test
+    public void testDecodeSingleBytes() throws IOException {
+        byte[] data = createData(1327);
+
+        InputStream source = new ByteArrayInputStream(data);
+        try (InputStream stream = new DecoderStream(source, new NullDecoder())) {
+            for (byte datum : data) {
+                int read = stream.read();
+                assertNotEquals(-1, read);
+                assertEquals(datum, (byte) read);
+            }
+
+            assertEquals(-1, stream.read());
+        }
+    }
+
+    @Test
+    public void testDecodeArray() throws IOException {
+        int length = 793;
+        byte[] data = createData(length * 10);
+
+        InputStream source = new ByteArrayInputStream(data);
+        byte[] result = new byte[477];
+
+        try (InputStream stream = new DecoderStream(source, new NullDecoder())) {
+            int dataOffset = 0;
+            while (dataOffset < data.length) {
+                int count = stream.read(result);
+
+                assertFalse(count <= 0);
+                assertArrayEquals(Arrays.copyOfRange(data, dataOffset, dataOffset + count), Arrays.copyOfRange(result, 0, count));
+
+                dataOffset += count;
+            }
+
+            assertEquals(-1, stream.read());
+        }
+    }
+
+    @Test
+    public void testDecodeArrayOffset() throws IOException {
+        int length = 793;
+        byte[] data = createData(length * 10);
+
+        InputStream source = new ByteArrayInputStream(data);
+        byte[] result = new byte[477];
+
+        try (InputStream stream = new DecoderStream(source, new NullDecoder())) {
+            int dataOffset = 0;
+            while (dataOffset < data.length) {
+                int resultOffset = dataOffset % result.length;
+                int count = stream.read(result, resultOffset, result.length - resultOffset);
+
+                assertFalse(count <= 0);
+                assertArrayEquals(Arrays.copyOfRange(data, dataOffset + resultOffset, dataOffset + count), Arrays.copyOfRange(result, resultOffset, count));
+
+                dataOffset += count;
+            }
+
+            assertEquals(-1, stream.read());
+        }
+    }
+
+    private static final class NullDecoder implements Decoder {
+        @Override
+        public int decode(InputStream stream, ByteBuffer buffer) throws IOException {
+            int read = stream.read(buffer.array(), buffer.arrayOffset(), buffer.remaining());
+
+            if (read > 0) {
+                // Set position, should be equivalent to using buffer.put(stream.read()) until EOF or buffer full
+                buffer.position(read);
+            }
+
+            return read;
+        }
+    }
+}

common/common-io/src/test/java/com/twelvemonkeys/io/enc/EncoderAbstractTest.java

@@ -32,14 +32,13 @@ package com.twelvemonkeys.io.enc;
 
 import com.twelvemonkeys.io.FileUtil;
 import com.twelvemonkeys.lang.ObjectAbstractTest;
-import org.junit.Test;
+
 
 import java.io.*;
-import java.util.Arrays;
 import java.util.Random;
 
-import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * AbstractEncoderTest
@@ -73,7 +72,7 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
         }
     }
 
-    private byte[] createData(final int pLength) throws Exception {
+    private byte[] createData(final int pLength) {
         byte[] bytes = new byte[pLength];
         RANDOM.nextBytes(bytes);
         return bytes;
@@ -82,9 +81,8 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
     private void runStreamTest(final int pLength) throws Exception {
         byte[] data = createData(pLength);
         ByteArrayOutputStream outBytes = new ByteArrayOutputStream();
-        OutputStream out = new EncoderStream(outBytes, createEncoder(), true);
 
-        try {
+        try (OutputStream out = new EncoderStream(outBytes, createEncoder(), true)) {
             // Provoke failure for encoders that doesn't take array offset properly into account
             int off = (data.length + 1) / 2;
             out.write(data, 0, off);
@@ -92,9 +90,6 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
                 out.write(data, off, data.length - off);
             }
         }
-        finally {
-            out.close();
-        }
 
         byte[] encoded = outBytes.toByteArray();
 
@@ -102,7 +97,7 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
 //        System.err.println("encoded: " + Arrays.toString(encoded));
 
         byte[] decoded = FileUtil.read(new DecoderStream(new ByteArrayInputStream(encoded), createCompatibleDecoder()));
-        assertTrue(Arrays.equals(data, decoded));
+        assertArrayEquals(data, decoded);
 
         InputStream in = new DecoderStream(new ByteArrayInputStream(encoded), createCompatibleDecoder());
         outBytes = new ByteArrayOutputStream();
@@ -116,7 +111,7 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
         }
 
         decoded = outBytes.toByteArray();
-        assertTrue(Arrays.equals(data, decoded));
+        assertArrayEquals(data, decoded);
     }
 
     @Test
@@ -129,10 +124,6 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
                 e.printStackTrace();
                 fail(e.getMessage() + ": " + i);
             }
-            catch (Exception e) {
-                e.printStackTrace();
-                fail(e.getMessage() + ": " + i);
-            }
         }
 
         for (int i = 100; i < 2000; i += 250) {
@@ -143,10 +134,6 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
                 e.printStackTrace();
                 fail(e.getMessage() + ": " + i);
             }
-            catch (Exception e) {
-                e.printStackTrace();
-                fail(e.getMessage() + ": " + i);
-            }
         }
 
         for (int i = 2000; i < 80000; i += 1000) {
@@ -157,14 +144,8 @@ public abstract class EncoderAbstractTest extends ObjectAbstractTest {
                 e.printStackTrace();
                 fail(e.getMessage() + ": " + i);
             }
-            catch (Exception e) {
-                e.printStackTrace();
-                fail(e.getMessage() + ": " + i);
-            }
         }
     }
 
-    // TODO: Test that the transition from byte[] to ByteBuffer didn't introduce bugs when writing to a wrapped array with offset.
-
-
+    // TODO: Test that the transition from byte[] to ByteBuffer didn't introduce bugs when writing to a wrapped array with offset.
 }

common/common-io/src/test/java/com/twelvemonkeys/io/enc/EncoderStreamTest.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2022, Harald Kuhr
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this
+ *   list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of the copyright holder nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.twelvemonkeys.io.enc;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.ByteBuffer;
+import java.util.Arrays;
+import java.util.Random;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
+
+public class EncoderStreamTest {
+
+    private final Random rng = new Random(5467809876546L);
+
+    private byte[] createData(final int length) {
+        byte[] data = new byte[length];
+        rng.nextBytes(data);
+        return data;
+    }
+
+    @Test
+    public void testEncodeSingleBytes() throws IOException {
+        byte[] data = createData(1327);
+
+        ByteArrayOutputStream result = new ByteArrayOutputStream();
+        try (OutputStream stream = new EncoderStream(result, new NullEncoder())) {
+            for (byte datum : data) {
+                stream.write(datum);
+            }
+        }
+
+        assertArrayEquals(data, result.toByteArray());
+    }
+
+    @Test
+    public void testEncodeArray() throws IOException {
+        byte[] data = createData(1793);
+
+        ByteArrayOutputStream result = new ByteArrayOutputStream();
+        try (OutputStream stream = new EncoderStream(result, new NullEncoder())) {
+            for (int i = 0; i < 10; i++) {
+                stream.write(data);
+            }
+        }
+
+        byte[] encoded = result.toByteArray();
+
+        for (int i = 0; i < 10; i++) {
+            assertArrayEquals(data, Arrays.copyOfRange(encoded, i * data.length, (i + 1) * data.length));
+        }
+    }
+
+    @Test
+    public void testEncodeArrayOffset() throws IOException {
+        byte[] data = createData(87);
+
+        ByteArrayOutputStream result = new ByteArrayOutputStream();
+        try (OutputStream stream = new EncoderStream(result, new NullEncoder())) {
+            for (int i = 0; i < 10; i++) {
+                stream.write(data, 13, 59);
+            }
+        }
+
+        byte[] original = Arrays.copyOfRange(data, 13, 13 + 59);
+        byte[] encoded = result.toByteArray();
+
+        for (int i = 0; i < 10; i++) {
+            assertArrayEquals(original, Arrays.copyOfRange(encoded, i * original.length, (i + 1) * original.length));
+        }
+    }
+
+    private static final class NullEncoder implements Encoder {
+        @Override
+        public void encode(OutputStream stream, ByteBuffer buffer) throws IOException {
+            stream.write(buffer.array(), buffer.arrayOffset(), buffer.remaining());
+        }
+    }
+}

common/common-io/src/test/java/com/twelvemonkeys/io/ole2/CompoundDocumentTest.java

@@ -31,9 +31,9 @@
 package com.twelvemonkeys.io.ole2;
 
 import com.twelvemonkeys.io.MemoryCacheSeekableStream;
-import org.junit.Test;
 
 import javax.imageio.stream.MemoryCacheImageInputStream;
+import java.awt.image.ImageProducer;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -43,8 +43,8 @@ import java.nio.ByteOrder;
 import java.util.SortedSet;
 import java.util.TreeSet;
 
-import static org.junit.Assert.*;
-
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 /**
  * CompoundDocumentTestCase
  *
@@ -59,8 +59,8 @@ public class CompoundDocumentTest {
     protected final CompoundDocument createTestDocument() throws IOException {
         URL input = getClass().getResource(SAMPLE_DATA);
 
-        assertNotNull("Missing test resource!", input);
-        assertEquals("Test resource not a file:// resource", "file", input.getProtocol());
+        assertNotNull(input, "Missing test resource!");
+        assertEquals( "file", input.getProtocol(), "Test resource not a file:// resource");
 
         try {
             return new CompoundDocument(new File(input.toURI()));
@@ -72,71 +72,72 @@ public class CompoundDocumentTest {
 
     @Test
     public void testRoot() throws IOException {
-        CompoundDocument document = createTestDocument();
+        try (CompoundDocument document = createTestDocument()) {
+            Entry root = document.getRootEntry();
 
-        Entry root = document.getRootEntry();
-
-        assertNotNull(root);
-        assertEquals("Root Entry", root.getName());
-        assertTrue(root.isRoot());
-        assertFalse(root.isFile());
-        assertFalse(root.isDirectory());
-        assertEquals(0, root.length());
-        assertNull(root.getInputStream());
+            assertNotNull(root);
+            assertEquals("Root Entry", root.getName());
+            assertTrue(root.isRoot());
+            assertFalse(root.isFile());
+            assertFalse(root.isDirectory());
+            assertEquals(0, root.length());
+            assertNull(root.getInputStream());
+        }
     }
 
     @Test
     public void testContents() throws IOException {
-        CompoundDocument document = createTestDocument();
+        try (CompoundDocument document = createTestDocument()) {
+            Entry root = document.getRootEntry();
 
-        Entry root = document.getRootEntry();
+            assertNotNull(root);
 
-        assertNotNull(root);
+            SortedSet<Entry> children = new TreeSet<Entry>(root.getChildEntries());
+            assertEquals(25, children.size());
 
-        SortedSet<Entry> children = new TreeSet<Entry>(root.getChildEntries());
-        assertEquals(25, children.size());
-
-        // Weirdness in the file format, name is *written backwards* 1-24 + Catalog
-        for (String name : "1,2,3,4,5,6,7,8,9,01,02,11,12,21,22,31,32,41,42,51,61,71,81,91,Catalog".split(",")) {
-            assertEquals(name, children.first().getName());
-            children.remove(children.first());
+            // Weirdness in the file format, name is *written backwards* 1-24 + Catalog
+            for (String name : "1,2,3,4,5,6,7,8,9,01,02,11,12,21,22,31,32,41,42,51,61,71,81,91,Catalog".split(",")) {
+                assertEquals(name, children.first().getName());
+                children.remove(children.first());
+            }
         }
     }
 
-    @Test(expected = UnsupportedOperationException.class)
+    @Test
     public void testChildEntriesUnmodifiable() throws IOException {
-        CompoundDocument document = createTestDocument();
+        try (CompoundDocument document = createTestDocument()) {
+            Entry root = document.getRootEntry();
 
-        Entry root = document.getRootEntry();
+            assertNotNull(root);
 
-        assertNotNull(root);
-
-        SortedSet<Entry> children = root.getChildEntries();
-
-        // Should not be allowed, as it modifies the internal structure
-        children.remove(children.first());
+            SortedSet<Entry> children = root.getChildEntries();
+            assertThrows(UnsupportedOperationException.class, () -> {
+                // Should not be allowed, as it modifies the internal structure
+                children.remove(children.first());
+            });
+        }
     }
 
     @Test
     public void testReadThumbsCatalogFile() throws IOException {
-        CompoundDocument document = createTestDocument();
+        try (CompoundDocument document = createTestDocument()) {
+            Entry root = document.getRootEntry();
 
-        Entry root = document.getRootEntry();
+            assertNotNull(root);
+            assertEquals(25, root.getChildEntries().size());
 
-        assertNotNull(root);
-        assertEquals(25, root.getChildEntries().size());
+            Entry catalog = root.getChildEntry("Catalog");
 
-        Entry catalog = root.getChildEntry("Catalog");
-
-        assertNotNull(catalog);
-        assertNotNull("Input stream may not be null", catalog.getInputStream());
+            assertNotNull(catalog);
+            assertNotNull(catalog.getInputStream(), "Input stream may not be null");
+        }
     }
 
     @Test
     public void testReadCatalogInputStream() throws IOException {
         InputStream input = getClass().getResourceAsStream(SAMPLE_DATA);
 
-        assertNotNull("Missing test resource!", input);
+        assertNotNull(input, "Missing test resource!");
 
         CompoundDocument document = new CompoundDocument(input);
         Entry root = document.getRootEntry();
@@ -145,14 +146,14 @@ public class CompoundDocumentTest {
 
         Entry catalog = root.getChildEntry("Catalog");
         assertNotNull(catalog);
-        assertNotNull("Input stream may not be null", catalog.getInputStream());
+        assertNotNull(catalog.getInputStream(), "Input stream may not be null");
     }
 
     @Test
     public void testReadCatalogSeekableStream() throws IOException {
         InputStream input = getClass().getResourceAsStream(SAMPLE_DATA);
 
-        assertNotNull("Missing test resource!", input);
+        assertNotNull(input, "Missing test resource!");
 
         CompoundDocument document = new CompoundDocument(new MemoryCacheSeekableStream(input));
         Entry root = document.getRootEntry();
@@ -161,14 +162,14 @@ public class CompoundDocumentTest {
 
         Entry catalog = root.getChildEntry("Catalog");
         assertNotNull(catalog);
-        assertNotNull("Input stream may not be null", catalog.getInputStream());
+        assertNotNull(catalog.getInputStream(), "Input stream may not be null");
     }
 
     @Test
     public void testReadCatalogImageInputStream() throws IOException {
         InputStream input = getClass().getResourceAsStream(SAMPLE_DATA);
 
-        assertNotNull("Missing test resource!", input);
+        assertNotNull(input, "Missing test resource!");
 
         MemoryCacheImageInputStream stream = new MemoryCacheImageInputStream(input);
         stream.setByteOrder(ByteOrder.LITTLE_ENDIAN);
@@ -183,6 +184,6 @@ public class CompoundDocumentTest {
         Entry catalog = root.getChildEntry("Catalog");
 
         assertNotNull(catalog);
-        assertNotNull("Input stream may not be null", catalog.getInputStream());
+        assertNotNull(catalog.getInputStream(), "Input stream may not be null");
     }
 }

common/common-io/src/test/java/com/twelvemonkeys/io/ole2/CompoundDocument_SeekableLittleEndianDataInputStreamTest.java

@@ -31,7 +31,7 @@
 package com.twelvemonkeys.io.ole2;
 
 import com.twelvemonkeys.io.*;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 import java.io.ByteArrayInputStream;
 

common/common-io/src/test/java/com/twelvemonkeys/io/ole2/CompoundDocument_StreamTest.java

@@ -33,16 +33,16 @@ package com.twelvemonkeys.io.ole2;
 import com.twelvemonkeys.io.InputStreamAbstractTest;
 import com.twelvemonkeys.io.LittleEndianDataOutputStream;
 import com.twelvemonkeys.io.MemoryCacheSeekableStream;
-import com.twelvemonkeys.io.SeekableInputStream;
-import org.junit.Test;
 
-import java.io.*;
-import java.net.URISyntaxException;
-import java.net.URL;
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.InputStream;
 import java.nio.charset.Charset;
 import java.util.Arrays;
 
-import static org.junit.Assert.*;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * CompoundDocument_StreamTestCase
@@ -51,35 +51,7 @@ import static org.junit.Assert.*;
  * @author last modified by $Author: haraldk$
  * @version $Id: CompoundDocument_StreamTestCase.java,v 1.0 13.10.11 12:01 haraldk Exp$
  */
-//@Ignore("Need proper in-memory creation of CompoundDocuments")
 public class CompoundDocument_StreamTest extends InputStreamAbstractTest {
-    private static final String SAMPLE_DATA = "/Thumbs-camera.db";
-
-    protected final CompoundDocument createTestDocument() throws IOException {
-        URL input = getClass().getResource(SAMPLE_DATA);
-
-        assertNotNull("Missing test resource!", input);
-        assertEquals("Test resource not a file:// resource", "file", input.getProtocol());
-
-        try {
-            return new CompoundDocument(new File(input.toURI()));
-        }
-        catch (URISyntaxException e) {
-            throw new AssertionError(e);
-        }
-    }
-
-    private SeekableInputStream createRealInputStream() {
-        try {
-            Entry first = createTestDocument().getRootEntry().getChildEntries().first();
-            assertNotNull(first);
-            return first.getInputStream();
-        }
-        catch (IOException e) {
-            throw new AssertionError(e);
-        }
-    }
-
     @Override
     protected InputStream makeInputStream(byte[] data) {
         try {
@@ -182,21 +154,19 @@ public class CompoundDocument_StreamTest extends InputStreamAbstractTest {
         return pad;
     }
 
-//    @Ignore
     @Test
-    public void testDev() throws IOException {
+    public void testStreamRead() throws IOException {
         InputStream stream = makeInputStream(makeOrderedArray(32));
 
         int read;
         int count = 0;
         while ((read = stream.read()) >= 0) {
-//            System.out.printf("read %02d: 0x%02x%n", count, read & 0xFF);
             assertEquals(count, read);
             count++;
         }
 
-        assertFalse("Short stream", count < 32);
-        assertFalse("Stream overrun", count > 32);
+        assertFalse(count < 32, "Short stream");
+        assertFalse(count > 32, "Stream overrun");
     }
 
     @Test

common/common-io/src/test/java/com/twelvemonkeys/net/HTTPUtilTest.java

@@ -30,9 +30,8 @@
 
 package com.twelvemonkeys.net;
 
-import org.junit.Test;
-
-import static org.junit.Assert.assertEquals;
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.*;
 
 /**
  * HTTPUtilTest

common/common-lang/pom.xml

@@ -4,13 +4,25 @@
     <parent>
         <groupId>com.twelvemonkeys.common</groupId>
         <artifactId>common</artifactId>
-        <version>3.4</version>
+        <version>3.13.2-SNAPSHOT</version>
     </parent>
     <artifactId>common-lang</artifactId>
     <packaging>jar</packaging>
     <name>TwelveMonkeys :: Common :: Language support</name>
     <description>
-        The TwelveMonkeys Common Language support
+        TwelveMonkeys Common language support classes.
     </description>
 
+    <properties>
+        <project.jpms.module.name>com.twelvemonkeys.common.lang</project.jpms.module.name>
+    </properties>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
 </project>