Diff (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.updater.Diff

```
public class Diff
extends Object
```
Show differences between remote and local versions of files. Sometimes it is not obvious why a file is marked locally-modified. This class is supposed to help. It relies heavily on the 'git' executable to generate the diffs, the 'javap' executable to disassemble byte code and the 'hexdump' executable to make hex dumps.

Author:

Johannes Schindelin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Diff.Mode

Nested Classes
Modifier and Type	Class and Description
`static class`	`Diff.Mode`

Constructor Summary

Constructors
Constructor and Description

Diff(PrintStream out)
Deprecated.

Diff(PrintStream out, UpdaterUtil util)
Construct a Diff object.

Constructors
Constructor and Description
`Diff(PrintStream out)` Deprecated.
`Diff(PrintStream out, UpdaterUtil util)` Construct a Diff object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ByteCodeAnalyzer`	`analyzeByteCode(InputStream in, boolean closeStream)` Analyze the byte code of a class file.
`protected static void`	`analyzeByteCode(InputStream in, File outputFile)` Inspect the byte code of a class file.
`protected File`	`cacheFile(URL url, boolean evenLocal)` Cache a file locally.
`protected static void`	`copy(InputStream in, OutputStream out, boolean closeIn, boolean closeOut)` Copy bytes from an `InputStream` to an `OutputStream`.
`protected static float`	`getClassVersion(File file)` Get the version of a class file.
`protected static float`	`getClassVersion(InputStream stream)` Get the version of a class file.
`protected static List<JarEntry>`	`getSortedEntries(JarFile jar)` Make an alphabetically-sorted list of files inside a .jar file.
`protected void`	`hexdump(File inputFile, File outputFile)` Make a hex-dump.
`protected static boolean`	`isLocal(URL url)` Determine whether a URL refers to a local file.
`protected void`	`javap(File file)` Run `javap` on a class file.
`protected File`	`javap(File jarFile, String className)` Run `javap` on a class file.
`protected static long`	`offsetOfFirstDiff(File file1, File file2)` Determine whether two files' contents differ.
`void`	`showDiff(String name, URL remote, URL local, Diff.Mode mode)` Show the differences between `remote` and `local` versions of a file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Diff
```
@Deprecated
public Diff(PrintStream out)
```
    Deprecated.
    
    Construct a Diff object.
    
    Parameters:
    
    out - this is where the output goes
  - Diff
```
public Diff(PrintStream out,
            UpdaterUtil util)
```
    Construct a Diff object.
    
    Parameters:
    
    out - this is where the output goes
    
    util - an instance of UpdaterUtil to access URLs
- Method Detail
  - showDiff
```
public void showDiff(String name,
                     URL remote,
                     URL local,
                     Diff.Mode mode)
              throws IOException,
                     MalformedURLException
```
    Show the differences between remote and local versions of a file.
    
    Parameters:
    
    name - the file name
    
    remote - the URL to the remote version
    
    local - the URL to the local version
    
    mode - how to print the differences
    
    Throws:
    
    IOException
    
    MalformedURLException
  - getSortedEntries
```
protected static List<JarEntry> getSortedEntries(JarFile jar)
```
    Make an alphabetically-sorted list of files inside a .jar file.
    
    Parameters:
    
    jar - the .jar file
    
    Returns:
    
    the sorted list
  - hexdump
```
protected void hexdump(File inputFile,
                       File outputFile)
                throws FileNotFoundException,
                       IOException
```
    Make a hex-dump. This calls the hex-dump program.
    
    Parameters:
    
    inputFile - the file to hex-dump
    
    outputFile - the output file (can be the same as the inputFile
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - analyzeByteCode
```
protected static void analyzeByteCode(InputStream in,
                                      File outputFile)
                               throws FileNotFoundException,
                                      IOException
```
    Inspect the byte code of a class file.
    
    Parameters:
    
    in - the input stream to analyze
    
    outputFile - the output file (can be the same as the inputFile
    
    Throws:
    
    FileNotFoundException
    
    IOException
  - analyzeByteCode
```
public static ByteCodeAnalyzer analyzeByteCode(InputStream in,
                                               boolean closeStream)
                                        throws IOException
```
    Analyze the byte code of a class file.
    
    Throws:
    
    IOException
  - javap
```
protected File javap(File jarFile,
                     String className)
              throws IOException
```
    Run javap on a class file.
    
    Parameters:
    
    jarFile - the .jar file containing the class
    
    className - the name of the class
    
    Returns:
    
    the output file
    
    Throws:
    
    IOException
  - javap
```
protected void javap(File file)
              throws IOException
```
    Run javap on a class file.
    
    Parameters:
    
    file - the .class file (and the output file)
    
    Throws:
    
    IOException
  - getClassVersion
```
protected static float getClassVersion(File file)
                                throws IOException
```
    Get the version of a class file.
    
    Parameters:
    
    file - the .class file
    
    Returns:
    
    the version in dotted format
    
    Throws:
    
    IOException
  - getClassVersion
```
protected static float getClassVersion(InputStream stream)
                                throws IOException
```
    Get the version of a class file.
    
    Parameters:
    
    stream - the InputStream representing the .class file
    
    Returns:
    
    the version in dotted format
    
    Throws:
    
    IOException
  - cacheFile
```
protected File cacheFile(URL url,
                         boolean evenLocal)
                  throws IOException
```
    Cache a file locally.
    
    Parameters:
    
    url - the URL of the file to cache
    
    evenLocal - force "caching" even local files, e.g. to transform the files without destroying the original contents
    
    Returns:
    
    the cached file, or the original file if nothing was cached
    
    Throws:
    
    IOException
  - isLocal
```
protected static boolean isLocal(URL url)
```
    Determine whether a URL refers to a local file.
    
    Parameters:
    
    url - the URL
    
    Returns:
    
    whether the URL is really a local one
  - offsetOfFirstDiff
```
protected static long offsetOfFirstDiff(File file1,
                                        File file2)
                                 throws IOException
```
    Determine whether two files' contents differ.
    
    Parameters:
    
    file1 - the one file
    
    file2 - the other file
    
    Returns:
    
    the offset of the first difference, or -1 if the files' contents are identical
    
    Throws:
    
    IOException
  - copy
```
protected static void copy(InputStream in,
                           OutputStream out,
                           boolean closeIn,
                           boolean closeOut)
                    throws IOException
```
    Copy bytes from an InputStream to an OutputStream.
    
    Parameters:
    
    in - the input
    
    out - the output
    
    closeIn - whether to close in after reading
    
    closeOut - whether to close out after reading
    
    Throws:
    
    IOException

Class Diff

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Diff

Diff

Method Detail

showDiff

getSortedEntries

hexdump

analyzeByteCode

analyzeByteCode

javap

javap

getClassVersion

getClassVersion

cacheFile

isLocal

offsetOfFirstDiff

copy