Checksummer (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.updater.util.AbstractProgressable
- - net.imagej.updater.Checksummer

All Implemented Interfaces:

Progress, Progressable
```
public class Checksummer
extends AbstractProgressable
```
A class to checksum and timestamp all the files shown in the Updater's UI.

Author:

Johannes Schindelin, Yap Chin Kiet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class Checksummer.StringAndFile

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`Checksummer.StringAndFile`

Field Summary

Fields
Modifier and Type Field and Description

static String[][] directories

protected static Map<String,Set<String>> extensions
- Fields inherited from class net.imagej.updater.util.AbstractProgressable
  progress

Fields
Modifier and Type	Field and Description
`static String[][]`	`directories`
`protected static Map<String,Set<String>>`	`extensions`

Constructor Summary

Constructors
Constructor and Description

Checksummer(FilesCollection files, Progress progress)

Constructors
Constructor and Description
`Checksummer(FilesCollection files, Progress progress)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addConflict(String filename, String adjective, boolean isCritical, List<File> toDelete)`
`protected static List<File>`	`convert(List<Checksummer.StringAndFile> pairs)`
`protected boolean`	`exists(File file)`
`Map<String,FileObject.Version>`	`getCachedChecksums()`
`protected String`	`getDigest(String path, File file, long timestamp)`
`protected void`	`handle(Checksummer.StringAndFile pair)`
`protected void`	`handle(String unversioned)` Handle a single component, adding conflicts if there are multiple versions.
`protected void`	`handleQueue()`
`protected void`	`initializeQueue()`
`boolean`	`isCandidate(String path)`
`protected static Checksummer.StringAndFile`	`pickNewest(List<Checksummer.StringAndFile> list)`
`protected void`	`queue(String path)`
`protected void`	`queue(String path, File file)`
`void`	`queueDir(String[] dirs, String[] extensions)`
`void`	`queueDir(String dir, Set<String> extensions)`
`protected void`	`queueIfExists(String path)`
`protected void`	`readCachedChecksums()`
`protected void`	`removeConflict(String filename)`
`protected boolean`	`tryToGuessPlatform(FileObject file)`
`void`	`updateFromLocal()`
`void`	`updateFromLocal(List<String> files)`
`protected void`	`writeCachedChecksums()`

Methods inherited from class net.imagej.updater.util.AbstractProgressable
addItem, addProgress, done, itemDone, removeProgress, setCount, setItemCount, setTitle

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

Field Detail

directories

public static final String[][] directories

extensions

protected static final Map<String,Set<String>> extensions

Constructor Detail

Checksummer

public Checksummer(FilesCollection files,
                   Progress progress)

Method Detail

getCachedChecksums

public Map<String,FileObject.Version> getCachedChecksums()

exists
```
protected boolean exists(File file)
```

queueDir

public void queueDir(String[] dirs,
                     String[] extensions)

queueDir

public void queueDir(String dir,
                     Set<String> extensions)

queueIfExists

protected void queueIfExists(String path)

queue
```
protected void queue(String path)
```

queue

protected void queue(String path,
                     File file)

handle
```
protected void handle(String unversioned)
```
Handle a single component, adding conflicts if there are multiple versions.

Parameters:

unversioned - the unversioned name of the component

pickNewest

protected static Checksummer.StringAndFile pickNewest(List<Checksummer.StringAndFile> list)

convert

protected static List<File> convert(List<Checksummer.StringAndFile> pairs)

addConflict

protected void addConflict(String filename,
                           String adjective,
                           boolean isCritical,
                           List<File> toDelete)

removeConflict

protected void removeConflict(String filename)

handle

protected void handle(Checksummer.StringAndFile pair)

handleQueue
```
protected void handleQueue()
```

updateFromLocal

public void updateFromLocal(List<String> files)

tryToGuessPlatform

protected boolean tryToGuessPlatform(FileObject file)

isCandidate

public boolean isCandidate(String path)

initializeQueue
```
protected void initializeQueue()
```

updateFromLocal
```
public void updateFromLocal()
```

readCachedChecksums
```
protected void readCachedChecksums()
```

writeCachedChecksums
```
protected void writeCachedChecksums()
```

getDigest

protected String getDigest(String path,
                           File file,
                           long timestamp)
                    throws IOException,
                           NoSuchAlgorithmException,
                           ZipException

Throws:: IOException; NoSuchAlgorithmException; ZipException

Class Checksummer

Nested Class Summary

Field Summary

Fields inherited from class net.imagej.updater.util.AbstractProgressable

Constructor Summary

Method Summary

Methods inherited from class net.imagej.updater.util.AbstractProgressable

Methods inherited from class java.lang.Object

Field Detail

directories

extensions

Constructor Detail

Checksummer

Method Detail

getCachedChecksums

exists

queueDir

queueDir

queueIfExists

queue

queue

handle

pickNewest

convert

addConflict

removeConflict

handle

handleQueue

updateFromLocal

tryToGuessPlatform

isCandidate

initializeQueue

updateFromLocal

readCachedChecksums

writeCachedChecksums

getDigest