Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.remotebuild
Class RBFile

java.lang.Object
  extended by com.ibm.etools.iseries.remotebuild.RBResource
      extended by com.ibm.etools.iseries.remotebuild.RBQSYSResource
          extended by com.ibm.etools.iseries.remotebuild.RBFile
Direct Known Subclasses:
RBBinaryObject, RBSaveFile, RBSourceFile

public abstract class RBFile
extends RBQSYSResource

This class implements the abstract behavior of iSeries file objects. The name is the name of the file -- identical to the base resource name. The base resource is an IFolder or an IFile depending on the concrete resource. The model resource is an AbstractISeriesNativeObject. The file is always contained in a library. The children of a file are dependent on the concrete resource.


Field Summary
static String Copyright
           
 
Fields inherited from class com.ibm.etools.iseries.remotebuild.RBResource
G_BINARYOBJECT, G_LIBRARY, G_MEMBER, G_PROJECT, G_SAVEFILE, G_SOURCEFILE, G_UNKNOWN, NS_LOCAL, NS_NETWORK, NS_QSYS, NS_UNKNOWN, RB_QUALIFIER
 
Constructor Summary
RBFile(AbstractISeriesNativeObject resource)
          Constructs an RBResource from a model resource.
RBFile(String name, long localStamp, long targetStamp)
          Constructs an RBSourceFile from its properties.
 
Method Summary
 RBStatus checkName()
          Checks the name of this path for validity.
 boolean existsOn(RBSystem system)
          Tests for existence of files on a target system.
 String getIFSName()
          Returns the IFS name of the object from the path.
 String getObjectName()
          Returns the object name for this path.
 IPath getProjectRelativePath()
          Returns the project relative path of this resource.
 String getQSYSName()
          Returns the name of this object in the QSYS name space.
 CLQualifiedName getQualifiedName()
          Returns the fully-qualified system-relative object name for a resource in the QSYS namespace.
 String getSimpleObjectType()
          Returns the simple object type for this resource.
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBQSYSResource
getLibraryName, getNameSpace, getObjectType, getShortKey
 
Methods inherited from class com.ibm.etools.iseries.remotebuild.RBResource
accept, addChild, attach, checkAuthorities, checkContentsOn, checkExistence, checkPropertiesOn, checkProperty, clearMark, clearMarks, copy, createOn, findResource, getAdapter, getAllProperties, getAncestors, getBaseResource, getCCSID, getChild, getChildren, getCompanion, getContext, getDBCS, getDescendents, getDescription, getGender, getHome, getHome, getKeyPath, getLocalStamp, getLocation, getLongKey, getModelChildren, getModelParent, getModelProject, getModelProperty, getModelResource, getModifiedProperties, getName, getNumberOfChildren, getParent, getPersistentProperty, getProject, getProjectProperty, getPropertiesModel, getRecordLength, getRemoteName, getResourcePath, getSessionProperty, getSnapshotType, getSourceType, getSystem, getSystemName, getTargetStamp, hasChildren, hasContents, hasContext, hashCode, hasMark, isEquivalentTo, isHome, isLocal, isMarked, isProject, isRemote, isSnapshot, makeFrom, makeFrom, makeFrom, pushContentsTo, pushPropertiesTo, pushPropertiesTo, pushSourceTypeTo, qualify, removeChild, saveModelProperties, setCompanion, setContext, setLocalStamp, setMark, setModelProperty, setName, setPersistentProperty, setProjectProperty, setSessionProperty, setSourceType, setTargetStamp, synchronize, toString, updateFrom, wasCreated, wasDeleted, wasModified
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Constructor Detail

RBFile

public RBFile(AbstractISeriesNativeObject resource)
Constructs an RBResource from a model resource.


RBFile

public RBFile(String name,
              long localStamp,
              long targetStamp)
Constructs an RBSourceFile from its properties.

Method Detail

getObjectName

public String getObjectName()
Returns the object name for this path.


getSimpleObjectType

public String getSimpleObjectType()
Returns the simple object type for this resource. This is "FILE" for file resources.

Specified by:
getSimpleObjectType in class RBQSYSResource

getQualifiedName

public CLQualifiedName getQualifiedName()
Returns the fully-qualified system-relative object name for a resource in the QSYS namespace.

Specified by:
getQualifiedName in class RBQSYSResource

getProjectRelativePath

public IPath getProjectRelativePath()
Returns the project relative path of this resource.

Specified by:
getProjectRelativePath in class RBResource

getIFSName

public String getIFSName()
Returns the IFS name of the object from the path. Returns the empty string if the path is not in an IFS name space or if the name is not well-formed.

Specified by:
getIFSName in class RBResource

getQSYSName

public String getQSYSName()
Returns the name of this object in the QSYS name space.

Specified by:
getQSYSName in class RBResource

checkName

public RBStatus checkName()
Checks the name of this path for validity.

Overrides:
checkName in class RBResource

existsOn

public boolean existsOn(RBSystem system)
Tests for existence of files on a target system.

Specified by:
existsOn in class RBResource

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.