com.github.fge.filesystem.options

Class FileSystemOptionsFactory

java.lang.Object

com.github.fge.filesystem.options.FileSystemOptionsFactory

@ParametersAreNonnullByDefault
public class FileSystemOptionsFactory
extends Object

Repository of options supported by a filesystem

The default implementation supposes support for the following options:

• StandardOpenOption.CREATE;
• StandardOpenOption.CREATE_NEW;
• StandardOpenOption.READ;
• StandardOpenOption.SPARSE;
• StandardOpenOption.TRUNCATE_EXISTING;
• StandardOpenOption.WRITE;
• StandardCopyOption.REPLACE_EXISTING.

Extend this class if you want to add support for further options. For instance, if atomic move is supported:

     public final class MyFileSystemOptionsRepository
         extends FileSystemOptionsRepository
     {
         public MyFileSystemOptionsRepository()
         {
             addCopyOption(StandardCopyOption.ATOMIC_MOVE);
         }
     }
 

Unless otherwise noted, all methods in this class will throw a NullPointerException if a null argument is passed.

Constructor Summary

Constructors

Constructor and Description
FileSystemOptionsFactory()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addCopyOption(CopyOption option) Add a supported copy option
protected void	addLinkOption(LinkOption option) Add a supported link option
protected void	addOpenOption(OpenOption option) Add an option option supported for both read and write
protected void	addReadOpenOption(OpenOption option) Add an open option supported for read
protected void	addReadTranslation(CopyOption option, OpenOption translated)
protected void	addWriteOpenOption(OpenOption option) Add an option option supported for write
protected void	addWriteTranslation(CopyOption option, OpenOption translated)
void	checkLinkOptions(LinkOption... opts)
Set<CopyOption>	compileCopyOptions(CopyOption... opts) Compile a set of copy options from a CopyOption array
Set<OpenOption>	compileReadOptions(OpenOption... opts) Compile a set of read options from a given OpenOption array
Set<OpenOption>	compileWriteOptions(OpenOption... opts) Compile a set of read options from a given OpenOption array
Set<OpenOption>	toReadOptions(Set<CopyOption> options)
Set<OpenOption>	toWriteOptions(Set<CopyOption> options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileSystemOptionsFactory

public FileSystemOptionsFactory()

Method Detail

compileReadOptions

@Nonnull
public final Set<OpenOption> compileReadOptions(OpenOption... opts)

Compile a set of read options from a given OpenOption array

The result set will have at least StandardOpenOption.READ if it is not already present.

Parameters:

opts - the options array

Returns:

an unmodifiable set of read options

Throws:

UnsupportedOptionException - one or more options are not supported

IllegalOptionSetException - some options are unsuited for read

compileWriteOptions

@Nonnull
public final Set<OpenOption> compileWriteOptions(OpenOption... opts)

Compile a set of read options from a given OpenOption array

The result set will have at least StandardOpenOption.WRITE if it is not already present.

Parameters:

opts - the options array

Returns:

an unmodifiable set of write options

Throws:

UnsupportedOptionException - one or more options are not supported

IllegalOptionSetException - some options are unsuited for write

compileCopyOptions

@Nonnull
public final Set<CopyOption> compileCopyOptions(CopyOption... opts)

Compile a set of copy options from a CopyOption array

Parameters:

opts - the options array

Returns:

an unmodifiable set of options

checkLinkOptions

public final void checkLinkOptions(LinkOption... opts)

toReadOptions

@Nonnull
public final Set<OpenOption> toReadOptions(Set<CopyOption> options)

toWriteOptions

@Nonnull
public final Set<OpenOption> toWriteOptions(Set<CopyOption> options)

addReadOpenOption

protected final void addReadOpenOption(OpenOption option)

Add an open option supported for read

Parameters:

option - the option

addWriteOpenOption

protected final void addWriteOpenOption(OpenOption option)

Add an option option supported for write

Parameters:

option - the option

addOpenOption

protected final void addOpenOption(OpenOption option)

Add an option option supported for both read and write

Parameters:

option - the option

addCopyOption

protected final void addCopyOption(CopyOption option)

Add a supported copy option

Parameters:

option - the option

addLinkOption

protected final void addLinkOption(LinkOption option)

Add a supported link option

Parameters:

option - the option

addReadTranslation

protected final void addReadTranslation(CopyOption option,
                      OpenOption translated)

addWriteTranslation

protected final void addWriteTranslation(CopyOption option,
                       OpenOption translated)