TargetFile (FAR - Find And Replace)

java.lang.Object
- net.pandoragames.far.ui.model.TargetFile

All Implemented Interfaces:

java.lang.Cloneable, MessageBox
```
public class TargetFile
extends java.lang.Object
implements MessageBox, java.lang.Cloneable
```
Data container for the files in a result list. Files in that list may have errors, be subject to name changes and selection or be excluded from a subset.

Author:

Olivier Wehner at 26.02.2008

Constructor Summary

Constructors
Constructor and Description

TargetFile(java.io.File file)
Constructor requires a non null file object.

Constructors
Constructor and Description
`TargetFile(java.io.File file)` Constructor requires a non null file object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears all messages.
`TargetFile`	`clone()` Returns a copy of this object.
`boolean`	`equals(java.lang.Object o)` Two target files are equal if the wraped files are equal.
`void`	`error(java.lang.String errorMessage)` Sets an error message for this file.
`java.nio.charset.Charset`	`getCharacterset()` Returns the character set that should be used to read this file.
`java.nio.charset.Charset`	`getDeclaredCharacterset()` Returns the character set of this file, if any was specified.
`java.lang.String`	`getErrorMessage()` Returns the error message if any.
`java.io.File`	`getFile()` Returns the underlying `java.io.File` object.
`java.lang.String`	`getFileExtension()` Returns the fileExtension as a non null String, separating dot included.
`java.lang.String`	`getInfoMessage()` Returns the info message if any.
`MimeType`	`getMimeType()` Returns the mime type of this file if defined.
`java.lang.String`	`getName()` Returns the file name.
`java.lang.String`	`getNewName()` Returns a planned new name if any was set.
`java.lang.String`	`getPath()` Returns the files directory path.
`boolean`	`hasExtension()` Returns true if the the underlying file object has an extension.
`int`	`hashCode()`
`void`	`info(java.lang.String message)` Sets an info message for this file.
`boolean`	`isBinaryFile()` Returns true if this TargetFile has an assigned mime type that represents a binary file type, or if the it has no assigned mime type at all and the flag `FileType.TREAT_UNKNOWN_AS_BINARY` is true.
`boolean`	`isCharsetDefined()` Returns true if the character set associate with this file is specifically defined for this file.
`boolean`	`isIncluded()` Returns true if this file should be considdered part of a subset in the same collection.
`boolean`	`isSelected()` Returns true (the default) if this file object has bee selected.
`TargetFile`	`merge(java.io.File file)` Returns a copy of this object but with the underlying file object replaced with the specified file object.
`void`	`setCharacterset(java.nio.charset.Charset charaset)` Specifies a character set for this file.
`void`	`setIncluded(boolean included)` Includes or excludes this object in a subset of the same collection this instance was taken from.
`void`	`setMimeType(MimeType mimeType)` Explicitely sets a mime type for this file.
`void`	`setNewName(java.lang.String newName)` Sets the new name property of this object.
`void`	`setSelected(boolean select)` Selects or deselects this object.

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

- Constructor Detail
  - TargetFile
```
public TargetFile(java.io.File file)
```
    Constructor requires a non null file object.
    
    Parameters:
    file - not null
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the file name. This is a read only property.
    
    Returns:
    file name
  - getPath
```
public java.lang.String getPath()
```
    Returns the files directory path. This is a read only property.
    
    Returns:
    directory path
  - getErrorMessage
```
public java.lang.String getErrorMessage()
```
    Returns the error message if any.
    
    Returns:
    error message or null
  - getInfoMessage
```
public java.lang.String getInfoMessage()
```
    Returns the info message if any.
    
    Returns:
    informative message or null
  - error
```
public void error(java.lang.String errorMessage)
```
    Sets an error message for this file.
    
    Specified by:
    
    error in interface MessageBox
    
    Parameters:
    errorMessage - error message
  - info
```
public void info(java.lang.String message)
```
    Sets an info message for this file.
    
    Specified by:
    
    info in interface MessageBox
    
    Parameters:
    message - informative message
  - clear
```
public void clear()
```
    Clears all messages.
    
    Specified by:
    
    clear in interface MessageBox
  - getFile
```
public java.io.File getFile()
```
    Returns the underlying java.io.File object.
    
    Returns:
    underlying File object
  - isSelected
```
public boolean isSelected()
```
    Returns true (the default) if this file object has bee selected.
    
    Returns:
    true if selected
  - setSelected
```
public void setSelected(boolean select)
```
    Selects or deselects this object. By dafault a TargetFile is selected.
    
    Parameters:
    select - true if this file object should be selected.
  - getNewName
```
public java.lang.String getNewName()
```
    Returns a planned new name if any was set.
    
    Returns:
    new name property
  - setNewName
```
public void setNewName(java.lang.String newName)
```
    Sets the new name property of this object. This has no direct programatic consequences.
    
    Parameters:
    newName - property value
  - isIncluded
```
public boolean isIncluded()
```
    Returns true if this file should be considdered part of a subset in the same collection. Returns true by default.
    
    Returns:
    true if part of subset
  - setIncluded
```
public void setIncluded(boolean included)
```
    Includes or excludes this object in a subset of the same collection this instance was taken from.
    
    Parameters:
    included - set to false to excluide
  - getDeclaredCharacterset
```
public java.nio.charset.Charset getDeclaredCharacterset()
```
    Returns the character set of this file, if any was specified. Returns null if the default character set should be used.
    
    Returns:
    character set or null
  - getCharacterset
```
public java.nio.charset.Charset getCharacterset()
```
    Returns the character set that should be used to read this file. If this file has been associated with a particular character set, that one is returned. Otherwise, if this file is of a specific mime type, the character set for that mime type is returned. Otherwise the default character set for TEXT or BINARY files is returned, depending on the value of the flag FileType.TREAT_UNKNOWN_AS_BINARY.
    
    Returns:
    character set that should be used to read this file, never null
  - setCharacterset
```
public void setCharacterset(java.nio.charset.Charset charaset)
```
    Specifies a character set for this file.
  - isCharsetDefined
```
public boolean isCharsetDefined()
```
    Returns true if the character set associate with this file is specifically defined for this file. Returns false if this file uses the default character set or the characterset of its mime type.
    
    Returns:
    true if associated character set is defined on this file
  - getMimeType
```
public MimeType getMimeType()
```
    Returns the mime type of this file if defined. Mime type are usually assigned via lookup of the file name extension in the mime registry.
    
    Returns:
    MimeType or null if unefined
  - isBinaryFile
```
public boolean isBinaryFile()
```
    Returns true if this TargetFile has an assigned mime type that represents a binary file type, or if the it has no assigned mime type at all and the flag FileType.TREAT_UNKNOWN_AS_BINARY is true.
    
    Returns:
    true if this TargetFile is a binary file (or should be treated as one)
  - getFileExtension
```
public java.lang.String getFileExtension()
```
    Returns the fileExtension as a non null String, separating dot included.
    
    Returns:
    file extension with leading dot or empty string
  - hasExtension
```
public boolean hasExtension()
```
    Returns true if the the underlying file object has an extension.
    
    Returns:
    true if file name with extension.
  - setMimeType
```
public void setMimeType(MimeType mimeType)
```
    Explicitely sets a mime type for this file. This overrides the definitions in the mime registry.
    
    Parameters:
    mimeType - mime type
  - clone
```
public TargetFile clone()
```
    Returns a copy of this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    See Also:
    Object.clone()
  - merge
```
public TargetFile merge(java.io.File file)
```
    Returns a copy of this object but with the underlying file object replaced with the specified file object. All other fields are copied as is or merged if necessary.
    
    Returns:
    copy of this object with file object replaced
  - equals
```
public boolean equals(java.lang.Object o)
```
    Two target files are equal if the wraped files are equal.
    
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class TargetFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TargetFile

Method Detail

getName

getPath

getErrorMessage

getInfoMessage

error

info

clear

getFile

isSelected

setSelected

getNewName

setNewName

isIncluded

setIncluded

getDeclaredCharacterset

getCharacterset

setCharacterset

isCharsetDefined

getMimeType

isBinaryFile

getFileExtension

hasExtension

setMimeType

clone

merge

equals

hashCode