FileObject (ImageJ2 Javadocs 0-SNAPSHOT API)

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

```
public class FileObject
extends Object
```
This class represents a file handled by the updater.
The ImageJ updater knows about certain files (see Checksummer.directories for details). These files can be local-only, up-to-date, updateable, etc.

Author:

Johannes Schindelin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileObject.Action

static class FileObject.Status

static class FileObject.Version

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileObject.Action`
`static class`	`FileObject.Status`
`static class`	`FileObject.Version`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<String>`	`authors`
`FileObject.Version`	`current`
`protected Map<String,Dependency>`	`dependencies`
`String`	`description`
`boolean`	`descriptionFromPOM`
`boolean`	`executable`
`String`	`filename`
`long`	`filesize`
`String`	`localChecksum`
`String`	`localFilename`
`long`	`localTimestamp`
`boolean`	`metadataChanged`
`String`	`originalUpdateSite`
`protected Map<String,FileObject>`	`overriddenUpdateSites`
`Set<FileObject.Version>`	`previous`
`String`	`updateSite`

Constructor Summary

Constructors
Constructor and Description
`FileObject(String updateSite, String filename, long filesize, String checksum, long timestamp, FileObject.Status status)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`actionSpecified()`
`void`	`addAuthor(String author)`
`void`	`addCategory(String category)`
`void`	`addDependency(Dependency dependency)`
`void`	`addDependency(FilesCollection files, FileObject dependency)`
`void`	`addDependency(String filename, File file)`
`void`	`addDependency(String filename, long timestamp, boolean overrides)`
`void`	`addLink(String link)`
`void`	`addPlatform(String platform)`
`void`	`addPreviousVersion(FileObject.Version version)`
`void`	`addPreviousVersion(String checksum, long timestamp, String filename)` Deprecated.
`void`	`addPreviousVersion(String checksum, long timestamp, String filename, long timestampObsolete)`
`void`	`completeMetadataFrom(FileObject other)` Fill unset metadata with metadata from another object
`FileObject.Action`	`getAction()`
`Iterable<String>`	`getAuthors()`
`String`	`getBaseName()`
`Iterable<String>`	`getCategories()`
`String`	`getChecksum()`
`Iterable<Dependency>`	`getDependencies()`
`String`	`getDescription()`
`Iterable<FileObject>`	`getFileDependencies(FilesCollection files, boolean recursive)`
`String`	`getFilename()`
`String`	`getFilename(boolean stripVersion)`
`String`	`getFilename(long timestamp)` Returns the file name for the given date, as per the update site.
`static String`	`getFilename(String filename, boolean stripVersion)`
`Iterable<String>`	`getLinks()`
`String`	`getLocalFilename(boolean forDisplay)`
`Iterable<String>`	`getPlatforms()`
`Iterable<FileObject.Version>`	`getPrevious()`
`FileObject.Status`	`getStatus()`
`long`	`getTimestamp()`
`boolean`	`hasDependency(String filename)`
`boolean`	`hasPreviousVersion(String checksum)`
`boolean`	`isForPlatform(String platform)`
`boolean`	`isForThisPlatform(FilesCollection files)`
`boolean`	`isInstallable()`
`boolean`	`isLocallyModified()`
`boolean`	`isLocalOnly()`
`boolean`	`isNewerThan(long timestamp)`
`boolean`	`isObsolete()`
`boolean`	`isUninstallable()`
`boolean`	`isUpdateable()`
`boolean`	`isUpdateable(boolean evenForcedUpdates)`
`boolean`	`isUpdateablePlatform(FilesCollection files)`
`boolean`	`isUploadable(FilesCollection files)` Deprecated.
`boolean`	`isUploadable(FilesCollection files, boolean assumeModified)` Tells whether this file can be uploaded to its update site Note: this does not check whether the file is locally modified.
`void`	`markRemoved()` Deprecated.
`void`	`markRemoved(FilesCollection files)`
`void`	`markUploaded()`
`void`	`merge(FileObject upstream)`
`boolean`	`overridesOtherUpdateSite()`
`void`	`removeDependency(String other)`
`void`	`removeFromUpdateSite(String updateSite, FilesCollection files)`
`void`	`replaceList(String tag, String... list)`
`void`	`setAction(FilesCollection files, FileObject.Action action)`
`boolean`	`setFirstValidAction(FilesCollection files, FileObject.Action... actions)`
`void`	`setLocalVersion(String filename, String checksum, long timestamp)`
`void`	`setNoAction()`
`void`	`setStatus(FileObject.Status status)`
`void`	`stageForUninstall(FilesCollection files)`
`boolean`	`stageForUpdate(FilesCollection files, boolean evenForcedOnes)`
`void`	`stageForUpload(FilesCollection files, String updateSite)`
`String`	`toDebug()`
`boolean`	`toInstall()`
`String`	`toString()`
`static void`	`touch(File file)`
`boolean`	`toUninstall()`
`boolean`	`toUpdate()`
`boolean`	`toUpload()`
`boolean`	`willBeUpToDate()`
`boolean`	`willNotBeInstalled()`

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

Field Detail

overriddenUpdateSites

protected Map<String,FileObject> overriddenUpdateSites

updateSite
```
public String updateSite
```

originalUpdateSite
```
public String originalUpdateSite
```

filename
```
public String filename
```

description
```
public String description
```

executable
```
public boolean executable
```

current
```
public FileObject.Version current
```

public Set<FileObject.Version> previous

filesize
```
public long filesize
```

metadataChanged
```
public boolean metadataChanged
```

descriptionFromPOM
```
public boolean descriptionFromPOM
```

localFilename
```
public String localFilename
```

localChecksum
```
public String localChecksum
```

localTimestamp
```
public long localTimestamp
```

dependencies

protected Map<String,Dependency> dependencies

authors
```
protected Set<String> authors
```

Constructor Detail

FileObject

public FileObject(String updateSite,
                  String filename,
                  long filesize,
                  String checksum,
                  long timestamp,
                  FileObject.Status status)

Method Detail

merge

public void merge(FileObject upstream)

completeMetadataFrom
```
public void completeMetadataFrom(FileObject other)
```
Fill unset metadata with metadata from another object

Parameters:

other - the metadata source

hasPreviousVersion

public boolean hasPreviousVersion(String checksum)

overridesOtherUpdateSite

public boolean overridesOtherUpdateSite()

removeFromUpdateSite

public void removeFromUpdateSite(String updateSite,
                                 FilesCollection files)

isNewerThan

public boolean isNewerThan(long timestamp)

setLocalVersion

public void setLocalVersion(String filename,
                            String checksum,
                            long timestamp)

getDescription
```
public String getDescription()
```

addDependency

public void addDependency(FilesCollection files,
                          FileObject dependency)

addDependency

public void addDependency(String filename,
                          File file)

addDependency

public void addDependency(String filename,
                          long timestamp,
                          boolean overrides)

addDependency

public void addDependency(Dependency dependency)

removeDependency

public void removeDependency(String other)

hasDependency

public boolean hasDependency(String filename)

addLink
```
public void addLink(String link)
```

getLinks
```
public Iterable<String> getLinks()
```

addAuthor
```
public void addAuthor(String author)
```

getAuthors
```
public Iterable<String> getAuthors()
```

addPlatform

public void addPlatform(String platform)

getPlatforms

public Iterable<String> getPlatforms()

addCategory

public void addCategory(String category)

replaceList

public void replaceList(String tag,
                        String... list)

getCategories

public Iterable<String> getCategories()

getPrevious

public Iterable<FileObject.Version> getPrevious()

addPreviousVersion

@Deprecated
public void addPreviousVersion(String checksum,
                                           long timestamp,
                                           String filename)

Deprecated.

addPreviousVersion

public void addPreviousVersion(FileObject.Version version)

addPreviousVersion

public void addPreviousVersion(String checksum,
                               long timestamp,
                               String filename,
                               long timestampObsolete)

setNoAction
```
public void setNoAction()
```

setAction

public void setAction(FilesCollection files,
                      FileObject.Action action)

setFirstValidAction

public boolean setFirstValidAction(FilesCollection files,
                                   FileObject.Action... actions)

setStatus

public void setStatus(FileObject.Status status)

markUploaded
```
public void markUploaded()
```

markRemoved
```
@Deprecated
public void markRemoved()
```
Deprecated.

markRemoved

public void markRemoved(FilesCollection files)

getLocalFilename

public String getLocalFilename(boolean forDisplay)

getFilename
```
public String getFilename()
```

getFilename

public String getFilename(boolean stripVersion)

getFilename

public static String getFilename(String filename,
                                 boolean stripVersion)

getFilename
```
public String getFilename(long timestamp)
```
Returns the file name for the given date, as per the update site.

Parameters:

timestamp - the date

Returns:

the file name for the date

getBaseName
```
public String getBaseName()
```

getChecksum
```
public String getChecksum()
```

getTimestamp
```
public long getTimestamp()
```

getDependencies

public Iterable<Dependency> getDependencies()

getFileDependencies

public Iterable<FileObject> getFileDependencies(FilesCollection files,
                                                boolean recursive)

getStatus
```
public FileObject.Status getStatus()
```

getAction
```
public FileObject.Action getAction()
```

isInstallable
```
public boolean isInstallable()
```

isUpdateable
```
public boolean isUpdateable()
```

isUninstallable
```
public boolean isUninstallable()
```

isLocallyModified
```
public boolean isLocallyModified()
```

isUploadable

@Deprecated
public boolean isUploadable(FilesCollection files)

Deprecated.

isUploadable
```
public boolean isUploadable(FilesCollection files,
                            boolean assumeModified)
```
Tells whether this file can be uploaded to its update site Note: this does not check whether the file is locally modified.

Parameters:

files - the FilesCollection to look up the update site

assumeModified - whether to assume that the file is about to be changed

actionSpecified
```
public boolean actionSpecified()
```

toUpdate
```
public boolean toUpdate()
```

toUninstall
```
public boolean toUninstall()
```

toInstall
```
public boolean toInstall()
```

toUpload
```
public boolean toUpload()
```

isObsolete
```
public boolean isObsolete()
```

isForPlatform

public boolean isForPlatform(String platform)

isForThisPlatform

public boolean isForThisPlatform(FilesCollection files)

isUpdateablePlatform

public boolean isUpdateablePlatform(FilesCollection files)

isLocalOnly
```
public boolean isLocalOnly()
```

willNotBeInstalled
```
public boolean willNotBeInstalled()
```

willBeUpToDate
```
public boolean willBeUpToDate()
```

isUpdateable

public boolean isUpdateable(boolean evenForcedUpdates)

stageForUpdate

public boolean stageForUpdate(FilesCollection files,
                              boolean evenForcedOnes)

stageForUpload

public void stageForUpload(FilesCollection files,
                           String updateSite)

stageForUninstall

public void stageForUninstall(FilesCollection files)
                       throws IOException

Throws:: IOException

touch

public static void touch(File file)
                  throws IOException

Throws:: IOException

toDebug
```
public String toDebug()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class FileObject

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

overriddenUpdateSites

updateSite

originalUpdateSite

filename

description

executable

current

previous

filesize

metadataChanged

descriptionFromPOM

localFilename

localChecksum

localTimestamp

dependencies

authors

Constructor Detail

FileObject

Method Detail

merge

completeMetadataFrom

hasPreviousVersion

overridesOtherUpdateSite

removeFromUpdateSite

isNewerThan

setLocalVersion

getDescription

addDependency

addDependency

addDependency

addDependency

removeDependency

hasDependency

addLink

getLinks

addAuthor

getAuthors

addPlatform

getPlatforms

addCategory

replaceList

getCategories

getPrevious

addPreviousVersion

addPreviousVersion

addPreviousVersion

setNoAction

setAction

setFirstValidAction

setStatus

markUploaded

markRemoved

markRemoved

getLocalFilename

getFilename

getFilename

getFilename

getFilename

getBaseName

getChecksum

getTimestamp

getDependencies

getFileDependencies

getStatus

getAction

isInstallable

isUpdateable

isUninstallable

isLocallyModified

isUploadable

isUploadable

actionSpecified

toUpdate