NamedFile (anchor-io-input 0.2.1 API)

org.anchoranalysis.io.input.file.NamedFile

public final class NamedFile
extends Object

A file with an associated unique name.

This is an immutable class.

The name is intended to be a compact unique identifier for a file (in a particular context).

Author:: Owen Feehan

Constructor Summary

Constructors

Constructor Description

NamedFile(String identifier, File file)
Create with an identifier and a file.

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`File`	`getFile()`	The file.
`String`	`getIdentifier()`	Unique identifier associated with the file.
`Path`	`getPath()`	The path of `getFile()`.
`int`	`hashCode()`
`NamedFile`	`mapIdentifier(BiFunction<String,File,String> function)`	Immutably renames the file, by assigning it a new identifier.
`Path`	`toPath()`	Like `File.toPath()`.
`String`	`toString()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- NamedFile
  
  public NamedFile(String identifier, File file)
  
  Create with an identifier and a file.
  
  Parameters:
  
  identifier - unique identifier associated with the file.
  
  file - the file.
Method Details
- getPath
  
  public Path getPath()
  
  The path of getFile().
  
  Returns:
  
  the path
- mapIdentifier
  
  public NamedFile mapIdentifier(BiFunction<String,File,String> function)
  
  Immutably renames the file, by assigning it a new identifier.
  
  Parameters:
  
  function - generates a new identifier from the existing identifier and file
  
  Returns:
  
  a newly created file with the assigned identifier, but existing file.
- toPath
  
  public Path toPath()
  
  Like File.toPath().
  
  Returns:
  
  the path associated with the file.
- getIdentifier
  
  public String getIdentifier()
  
  Unique identifier associated with the file.
- getFile
  
  public File getFile()
  
  The file.
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object