oracle.javatools.patch
Class PatchContributor

java.lang.Object
  oracle.javatools.patch.PatchContributor

public class PatchContributor
extends java.lang.Object

This class contributes index files to a patch-related operation performed by a PatchEngine instance.

Since:

10.1.3.0.3

Constructor Summary

PatchContributor(java.io.File directoryFile)
Constructs a new PatchContributor for the given directory.

PatchContributor(java.io.File directoryFile, java.lang.String argumentFilePath)
Constructs a new PatchContributor for the given directory and argument file path.

Method Summary

protected PatchIndexFile	constructIndexFile(java.lang.String path) Constructs an index file object representing the given file path.
protected PatchIndexFile	constructIndexFileImpl(java.io.File directoryFile, java.lang.String path) Constructs an index file object representing the given directory and path.
java.lang.String	getArgumentFilePath() Gets the argument file path for file contribution.
protected java.lang.String	getBaseDirectoryPath() Gets the base directory path for file contribution.
java.io.File	getDirectoryFile() Gets the working directory file for file contribution.
protected java.lang.String	getFilePath() Gets the single file path for file contribution.
protected boolean	isArgumentDirectory() Gets whether the argument file exists on the filesystem as a directory.
protected boolean	isArgumentFileExists() Gets whether the argument file exists on the filesystem.
protected java.lang.String[]	listFilePaths(boolean recursive) Lists contributed file paths for comparison.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatchContributor

public PatchContributor(java.io.File directoryFile)

Constructs a new PatchContributor for the given directory.

Parameters:

directoryFile - the working directory file.

PatchContributor

public PatchContributor(java.io.File directoryFile,
                        java.lang.String argumentFilePath)

Constructs a new PatchContributor for the given directory and argument file path.

Parameters:

directoryFile - the working directory file.

argumentFilePath - the path of file(s) to contribute.

Method Detail

getDirectoryFile

public java.io.File getDirectoryFile()

Gets the working directory file for file contribution.

Returns:

the working directory file.

getArgumentFilePath

public java.lang.String getArgumentFilePath()

Gets the argument file path for file contribution.

Returns:

the path of file(s) to contribute.

getBaseDirectoryPath

protected java.lang.String getBaseDirectoryPath()

Gets the base directory path for file contribution. This method is required to be implemented for patch creation via PatchEngine.createModel(oracle.javatools.patch.PatchContributor, oracle.javatools.patch.PatchCreateOptions).

Returns:

the directory path, or null if the argument is not a directory.

getFilePath

protected java.lang.String getFilePath()

Gets the single file path for file contribution. This method is required to be implemented for patch creation via PatchEngine.createModel(oracle.javatools.patch.PatchContributor, oracle.javatools.patch.PatchCreateOptions).

Returns:

the file path, or null if the argument is not a regular file.

listFilePaths

protected java.lang.String[] listFilePaths(boolean recursive)

Lists contributed file paths for comparison. This method is required to be implemented for patch creation via PatchEngine.createModel(oracle.javatools.patch.PatchContributor, oracle.javatools.patch.PatchCreateOptions).

Parameters:

recursive - true if directories should be listed recursively.

Returns:

the array of relative file paths from the working directory.

constructIndexFile

protected PatchIndexFile constructIndexFile(java.lang.String path)

Constructs an index file object representing the given file path. This method is required to be implemented for all operations.

Parameters:

path - the file path.

Returns:

the new index file object instance.

constructIndexFileImpl

protected PatchIndexFile constructIndexFileImpl(java.io.File directoryFile,
                                                java.lang.String path)

Constructs an index file object representing the given directory and path. This method is required to be implemented for all operations.

Parameters:

directoryFile - the working directory file.

path - the path.

Returns:

the new index file object instance.

isArgumentFileExists

protected boolean isArgumentFileExists()

Gets whether the argument file exists on the filesystem.

Returns:

true if the file exists.

isArgumentDirectory

protected boolean isArgumentDirectory()

Gets whether the argument file exists on the filesystem as a directory.

Returns:

true if the file exists as a directory.