org.safs.image

Class MakeImageDiff

java.lang.Object

org.safs.image.MakeImageDiff

public class MakeImageDiff
extends java.lang.Object

Sample Windows BAT file command-line usage:

MAKEDIFF.BAT File:
==================

 SET CP=%SAFSDIR%\lib\safs.jar
 SET EX=%SAFSDIR%\jre\bin\java.exe
 
 %EX% -cp %CP% org.safs.image.MakeImageDiff -bench %1 -actual %2 -diff %3
 

INVOCATION:
===========

 makediff pathTo\BenchImage.ext pathTo\ActualImage.ext pathTo\DiffImage.ext
 

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.io.File	actual
(package private) java.lang.String	actualpath
static java.lang.String	ARG_ACTUAL
static java.lang.String	ARG_BENCH
static java.lang.String	ARG_DIFF
(package private) java.io.File	bench
(package private) java.lang.String	benchpath
(package private) java.io.File	diff
(package private) java.awt.image.BufferedImage	diffimg
(package private) java.lang.String	diffpath
static java.lang.String	TXT_HELP

Constructor Summary

Constructors

Constructor and Description
MakeImageDiff()
MakeImageDiff(java.io.File bench, java.io.File actual, java.io.File diff)

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	createImageDiff() Can only be called if processArgs or the Constructor has already provided the necessary bench and actual Files to compare.
java.awt.image.BufferedImage	createImageDiff(java.io.File bench, java.io.File actual, java.io.File diff)
java.awt.image.BufferedImage	getImageDiff()
static void	main(java.lang.String[] args)
void	processArgs(java.lang.String[] args) -bench fullPath/To/BenchmarkImage.ext -actual fullPath/To/ActualImage.ext -diff fullPath/To/DiffImage.ext (optional)

Methods inherited from class java.lang.Object

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

Field Detail

TXT_HELP

public static final java.lang.String TXT_HELP

See Also:

Constant Field Values

ARG_BENCH

public static final java.lang.String ARG_BENCH

See Also:

Constant Field Values

ARG_ACTUAL

public static final java.lang.String ARG_ACTUAL

See Also:

Constant Field Values

ARG_DIFF

public static final java.lang.String ARG_DIFF

See Also:

Constant Field Values

bench

java.io.File bench

actual

java.io.File actual

diff

java.io.File diff

benchpath

java.lang.String benchpath

actualpath

java.lang.String actualpath

diffpath

java.lang.String diffpath

diffimg

java.awt.image.BufferedImage diffimg

Constructor Detail

MakeImageDiff

public MakeImageDiff()

MakeImageDiff

public MakeImageDiff(java.io.File bench,
                     java.io.File actual,
                     java.io.File diff)

Method Detail

processArgs

public void processArgs(java.lang.String[] args)
                 throws java.lang.IllegalArgumentException

-bench fullPath/To/BenchmarkImage.ext
-actual fullPath/To/ActualImage.ext
-diff fullPath/To/DiffImage.ext (optional)

Throws:

java.lang.IllegalArgumentException

createImageDiff

public java.awt.image.BufferedImage createImageDiff()
                                             throws java.lang.IllegalArgumentException,
                                                    java.io.IOException

Can only be called if processArgs or the Constructor has already provided the necessary bench and actual Files to compare.

Returns:

BufferedImage of differences between the bench and actual Files.

Throws:

java.lang.IllegalArgumentException

java.io.IOException

createImageDiff

public java.awt.image.BufferedImage createImageDiff(java.io.File bench,
                                                    java.io.File actual,
                                                    java.io.File diff)
                                             throws java.lang.IllegalArgumentException,
                                                    java.io.IOException

Parameters:

bench - -- Existing image benchmark to compare.

actual - -- Existing image to compare with the benchmark.

diff - File to persist the diff image to the file system. Can be null to be ignored.

Returns:

BufferedImage of differences between the two images.

Throws:

java.lang.IllegalArgumentException

java.io.IOException

getImageDiff

public java.awt.image.BufferedImage getImageDiff()

Returns:

Will be null if no image diff has been created.

See Also:

createImageDiff(File, File, File)

main

public static void main(java.lang.String[] args)