com.ptc.windchill.util
Class InstalledModuleArtifact

java.lang.Object
  java.io.File
      com.ptc.windchill.util.ModuleArtifact
          com.ptc.windchill.util.InstalledModuleArtifact

All Implemented Interfaces:

Comparable, Serializable

public class InstalledModuleArtifact

extends ModuleArtifact

InstalledModuleArtifact is a specialization of the ModuleArtifact class that locates files in a module specific directory under a central artifact specific directory, rather than under a module specific root.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	INSTALL_ROOT
private static String	RESOURCE

Fields inherited from class com.ptc.windchill.util.ModuleArtifact

artifactFile, moduleFile, unitFile, WINDCHILL_BIN, WINDCHILL_LOG, WINDCHILL_RB

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

InstalledModuleArtifact(String module, String artifact)
Constructs a InstalledModuleArtifact that represents the directory for a particular type of artifact.

InstalledModuleArtifact(String module, String artifact, String unit)
Constructs a InstalledModuleArtifact that represents the directory for a specific unit (module, subsystem, or package), for a particular type of artifact.

InstalledModuleArtifact(String artifact, String qualified_unit, String name, String extension)
Constructs a InstalledModuleArtifact that represents a specific file, for a particular type of artifact.

InstalledModuleArtifact(String module, String artifact, String unit, String name, String extension)
Constructs a InstalledModuleArtifact that represents a specific file, for a particular type of artifact.

Method Summary

protected static String	buildFilePath(String module, String artifact) Builds the file path for the module artifact combination.
protected static String	buildFilePath(String module, String artifact, String unit, String name, String extension)
protected static String	getUnitDir(String module, String artifactDir, String unqualifiedUnit)
protected ModuleArtifact	newInstance(String module, String artifact) Construct new instance of this object.
protected ModuleArtifact	newInstance(String module, String artifact, String unit) Construct new instance of this object.
protected ModuleArtifact	newInstance(String module, String artifact, String unit, String file_name, String extension) Construct new instance of this object.
protected static String	unitDir(String module, String unit)

Methods inherited from class com.ptc.windchill.util.ModuleArtifact

getArtifactDir, getArtifactFile, getArtifactName, getFileExtension, getFileName, getModuleDir, getModuleFile, getModuleName, getParentFile, getQualifiedUnit, getRelativePath, getRelativePath, getStandardPath, getUnitDir, getUnitFile, getUnitName, initialize, initialize, isAncestor, isModuleNameSpaced, setArtifactDir, setFileExtension, setFileName, setModuleDir, setUnitDir, unitDir

Methods inherited from class java.io.File

canRead, canWrite, compareTo, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getName, getParent, getPath, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setLastModified, setReadOnly, toString, toURI, toURL

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

INSTALL_ROOT

public static final String INSTALL_ROOT

Constructor Detail

InstalledModuleArtifact

public InstalledModuleArtifact(String module,
                               String artifact)

Constructs a InstalledModuleArtifact that represents the directory for a particular type of artifact.

Supported API: false

Parameters:

module -

artifact -

InstalledModuleArtifact

public InstalledModuleArtifact(String module,
                               String artifact,
                               String unit)

Constructs a InstalledModuleArtifact that represents the directory for a specific unit (module, subsystem, or package), for a particular type of artifact. The unit argument is either a package ('.' separated) or a subsystem ('/' separated). Passing a package using File.separator syntax will not work! If the unit argument is an empty string, it is interpretted as a top-level package. If the unit argument is null, it is interpretted as a module file, and the qualified module name will be used as a name space. A module name space is also applied to subsystems.

Supported API: false

Parameters:

module -

artifact -

unit -

InstalledModuleArtifact

public InstalledModuleArtifact(String module,
                               String artifact,
                               String unit,
                               String name,
                               String extension)

Constructs a InstalledModuleArtifact that represents a specific file, for a particular type of artifact. The unit argument is either a package ('.' separated) or a subsystem ('/' separated). Passing a package using File.separator syntax will not work! If the unit argument is an empty string, it is interpretted as a top-level package. If the unit argument is null, it is interpretted as a module file, and the qualified module name will be used as a name space for the file. A module name space is also applied to subsystem files.

Supported API: false

Parameters:

module -

artifact -

unit -

name -

extension -

InstalledModuleArtifact

public InstalledModuleArtifact(String artifact,
                               String qualified_unit,
                               String name,
                               String extension)

Constructs a InstalledModuleArtifact that represents a specific file, for a particular type of artifact. The unit argument is either a package ('.' separated) or a subsystem ('/' separated). Passing a package using File.separator syntax will not work! If the unit argument is an empty string, it is interpretted as a top-level package. If the unit argument is null, it is interpretted as a module file, and the qualified module name will be used as a name space for the file. A module name space is also applied to subsystem files.

Supported API: false

Parameters:

artifact -

qualified_unit -

name -

extension -

Method Detail

newInstance

protected ModuleArtifact newInstance(String module,
                                     String artifact)

Construct new instance of this object.

Overrides:

newInstance in class ModuleArtifact

newInstance

protected ModuleArtifact newInstance(String module,
                                     String artifact,
                                     String unit)

Construct new instance of this object.

Overrides:

newInstance in class ModuleArtifact

newInstance

protected ModuleArtifact newInstance(String module,
                                     String artifact,
                                     String unit,
                                     String file_name,
                                     String extension)

Construct new instance of this object.

Overrides:

newInstance in class ModuleArtifact

buildFilePath

protected static String buildFilePath(String module,
                                      String artifact)

Builds the file path for the module artifact combination.

buildFilePath

protected static String buildFilePath(String module,
                                      String artifact,
                                      String unit,
                                      String name,
                                      String extension)

getUnitDir

protected static String getUnitDir(String module,
                                   String artifactDir,
                                   String unqualifiedUnit)

unitDir

protected static String unitDir(String module,
                                String unit)