org.springframework.roo.process.manager.internal

Class DefaultFileManager

java.lang.Object

org.springframework.roo.process.manager.internal.DefaultFileManager

All Implemented Interfaces:

org.springframework.roo.file.undo.UndoListener, FileManager

@Service
public class DefaultFileManager
extends Object
implements FileManager, org.springframework.roo.file.undo.UndoListener

Default implementation of FileManager.

Since:

1.0

Author:

Ben Alex

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
DefaultFileManager()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	clear() Discards proposed changes to the disk that an implementation may have elected to defer.
void	commit() Commits actual changes to the disk that an implementation may have elected to defer.
org.springframework.roo.file.monitor.event.FileDetails	createDirectory(String fileIdentifier) Attempts to create a new directory on the disk.
MutableFile	createFile(String fileIdentifier) Attempts to create a zero-byte file on the disk.
void	createOrUpdateTextFileIfRequired(String fileIdentifier, String newContents, boolean writeImmediately) Provides a simple way to create or update a file, skipping any modification if the file's contents match the proposed contents.
void	createOrUpdateTextFileIfRequired(String fileIdentifier, String newContents, String descriptionOfChange, boolean writeImmediately) Provides a simple way to create or update a file, skipping any modification if the file's contents match the proposed contents.
protected void	deactivate(org.osgi.service.component.ComponentContext context)
void	delete(String fileIdentifier) Attempts to delete a file or directory on the disk.
void	delete(String fileIdentifier, String reasonForDeletion) Attempts to delete a file or directory on the disk.
boolean	exists(String fileIdentifier) Indicates whether the file identified by the passed canonical path exists.
SortedSet<org.springframework.roo.file.monitor.event.FileDetails>	findMatchingAntPath(String antPath) Delegates to FileMonitorService.findMatchingAntPath(String).
org.springframework.roo.file.monitor.NotifiableFileMonitorService	getFileMonitorService()
org.springframework.roo.file.undo.FilenameResolver	getFileNameResolver()
InputStream	getInputStream(String fileIdentifier) Obtains an input stream for the indicated file identifier, which must be a file (not a directory) and must exist at the time the method is called.
ProcessManager	getProcessManager()
org.springframework.roo.file.undo.UndoManager	getUndoManager()
void	onUndoEvent(org.springframework.roo.file.undo.UndoEvent event)
org.springframework.roo.file.monitor.event.FileDetails	readFile(String fileIdentifier) Obtains an already-existing file for reading.
int	scan() Delegates to FileMonitorService.scanAll() or NotifiableFileMonitorService.scanNotified() if available.
MutableFile	updateFile(String fileIdentifier) Provides an updatable representation of a file on the disk.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

Constructor Detail

DefaultFileManager

public DefaultFileManager()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

clear

public void clear()

Description copied from interface: FileManager

Discards proposed changes to the disk that an implementation may have elected to defer.

Specified by:

clear in interface FileManager

commit

public void commit()

Description copied from interface: FileManager

Commits actual changes to the disk that an implementation may have elected to defer.

Specified by:

commit in interface FileManager

createDirectory

public org.springframework.roo.file.monitor.event.FileDetails createDirectory(String fileIdentifier)

Description copied from interface: FileManager

Attempts to create a new directory on the disk.

The requested file identifier path must not already exist. It should be in canonical file name format.

Parent directories must also be created automatically by this method. Any created parent directories should be removed as part of the undo behaviour.

An exception will be thrown if the path already exists.

Specified by:

createDirectory in interface FileManager

Parameters:

fileIdentifier - a path to be created that does not already exist (required)

Returns:

a representation of the directory (or null if the creation failed)

createFile

public MutableFile createFile(String fileIdentifier)

Description copied from interface: FileManager

Attempts to create a zero-byte file on the disk.

The requested fileIdentifier path must not already exist. It should be in canonical file name format.

Implementations guarantee to FileManager.createDirectory(String) as required to create any required parent directories.

An exception will be thrown if the path already exists.

Specified by:

createFile in interface FileManager

Parameters:

fileIdentifier - a path to be created that does not already exist (required)

Returns:

a representation of the file (or null if the creation failed)

createOrUpdateTextFileIfRequired

public void createOrUpdateTextFileIfRequired(String fileIdentifier,
                                    String newContents,
                                    boolean writeImmediately)

Description copied from interface: FileManager

Provides a simple way to create or update a file, skipping any modification if the file's contents match the proposed contents. This should only be called for text files.

This mechanism also automatically deletes an unwanted file if the new contents are zero bytes. If deleting, the existence of the file need not be considered in advance (it will only delete if the file is present, but it will not fail if the file does not exist or has been separately deleted).

Implementations guarantee to FileManager.createDirectory(String) as required to create any required parent directories.

Implementations are required to observe the FileManager.commit() and FileManager.clear() semantics defined in the type-level JavaDocs.

Specified by:

createOrUpdateTextFileIfRequired in interface FileManager

Parameters:

fileIdentifier - the file to create or update as appropriate (required)

newContents - the replacement contents (required, but can be zero bytes if the file should be deleted)

writeImmediately - forces immediate write of the file to disk (false means it can be deferred, as recommended)

createOrUpdateTextFileIfRequired

public void createOrUpdateTextFileIfRequired(String fileIdentifier,
                                    String newContents,
                                    String descriptionOfChange,
                                    boolean writeImmediately)

Description copied from interface: FileManager

Provides a simple way to create or update a file, skipping any modification if the file's contents match the proposed contents. This should only be called for text files.

This mechanism also automatically deletes an unwanted file if the new contents are zero bytes. If deleting, the existence of the file need not be considered in advance (it will only delete if the file is present, but it will not fail if the file does not exist or has been separately deleted).

Implementations guarantee to FileManager.createDirectory(String) as required to create any required parent directories.

Implementations are required to observe the FileManager.commit() and FileManager.clear() semantics defined in the type-level JavaDocs.

Specified by:

createOrUpdateTextFileIfRequired in interface FileManager

Parameters:

fileIdentifier - the file to create or update as appropriate (required)

newContents - the replacement contents (required, but can be zero bytes if the file should be deleted)

descriptionOfChange - the additional information about a change (can be null)

writeImmediately - forces immediate write of the file to disk (false means it can be deferred, as recommended)

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext context)

delete

public void delete(String fileIdentifier)

Description copied from interface: FileManager

Attempts to delete a file or directory on the disk. The path should be in canonical file name format.

If the path refers to a directory, contents of the directory will be recursively deleted.

If a delete fails, an exception will be thrown.

Specified by:

delete in interface FileManager

Parameters:

fileIdentifier - the file to delete; can be blank to do nothing, otherwise should be a valid pathname as per File.File(String)

delete

public void delete(String fileIdentifier,
          String reasonForDeletion)

Description copied from interface: FileManager

Attempts to delete a file or directory on the disk. The path should be in canonical file name format.

If the path refers to a directory, contents of the directory will be recursively deleted.

If a delete fails, an exception will be thrown.

Specified by:

delete in interface FileManager

Parameters:

fileIdentifier - the file to delete; can be blank to do nothing, otherwise should be a valid pathname as per File.File(String)

reasonForDeletion - the reason why the file is being deleted (can be blank)

exists

public boolean exists(String fileIdentifier)

Description copied from interface: FileManager

Indicates whether the file identified by the passed canonical path exists.

Specified by:

exists in interface FileManager

Parameters:

fileIdentifier - the file or directory to locate (required, in canonical path format)

Returns:

true if the file or directory exists

findMatchingAntPath

public SortedSet<org.springframework.roo.file.monitor.event.FileDetails> findMatchingAntPath(String antPath)

Description copied from interface: FileManager

Delegates to FileMonitorService.findMatchingAntPath(String).

Specified by:

findMatchingAntPath in interface FileManager

Parameters:

antPath - the Ant path to evaluate, as per the canonical file path format (required)

Returns:

all matching identifiers (may be empty, but never null)

getInputStream

public InputStream getInputStream(String fileIdentifier)

Description copied from interface: FileManager

Obtains an input stream for the indicated file identifier, which must be a file (not a directory) and must exist at the time the method is called. This method is useful if read-only access to a file is required. For read-write access, use one of the other methods on FileManager.

Specified by:

getInputStream in interface FileManager

Parameters:

fileIdentifier - the file to read (required, in canonical path format)

Returns:

the input stream (never null)

onUndoEvent

public void onUndoEvent(org.springframework.roo.file.undo.UndoEvent event)

Specified by:

onUndoEvent in interface org.springframework.roo.file.undo.UndoListener

readFile

public org.springframework.roo.file.monitor.event.FileDetails readFile(String fileIdentifier)

Description copied from interface: FileManager

Obtains an already-existing file for reading. The path should be in canonical file name format.

Specified by:

readFile in interface FileManager

Parameters:

fileIdentifier - the file to read that already exists (required)

Returns:

a representation of the file (or null if the file does not exist)

scan

public int scan()

Description copied from interface: FileManager

Delegates to FileMonitorService.scanAll() or NotifiableFileMonitorService.scanNotified() if available.

Specified by:

scan in interface FileManager

Returns:

the number of changes detected (can be 0 or above)

updateFile

public MutableFile updateFile(String fileIdentifier)

Description copied from interface: FileManager

Provides an updatable representation of a file on the disk.

The file identifier must refer to a file (not directory) that already exists. A violation of this requirement will result in an exception. The identifier should be in canonical file name format.

Refer to the documentation for MutableFile for important restrictions on usage.

Specified by:

updateFile in interface FileManager

Parameters:

fileIdentifier - the file to update (must be a file that already exists, required)

Returns:

a mutable presentation (never null)

getFileMonitorService

public org.springframework.roo.file.monitor.NotifiableFileMonitorService getFileMonitorService()

getProcessManager

public ProcessManager getProcessManager()

getFileNameResolver

public org.springframework.roo.file.undo.FilenameResolver getFileNameResolver()

getUndoManager

public org.springframework.roo.file.undo.UndoManager getUndoManager()