com.starbase.starteam.viewcomparemerge
Class VCMFolder

java.lang.Object
  |
  +--com.starbase.starteam.CacheRef
        |
        +--com.starbase.starteam.NamedCacheRef
              |
              +--com.starbase.starteam.TypedResource
                    |
                    +--com.starbase.starteam.SimpleTypedResource
                          |
                          +--com.starbase.starteam.Item
                                |
                                +--com.starbase.starteam.Folder
                                      |
                                      +--com.starbase.starteam.viewcomparemerge.VCMFolder

All Implemented Interfaces:

java.lang.Cloneable, ISecurable, ISecurableContainer, ISecurableObject

public final class VCMFolder

extends Folder

A folder belonging to the Merge Preview It has all the characteristics of a regular StarTeam Folder, and describes the Preview State of its constituent Items &/or Sub-Folders

See Also:

PreviewState

Nested Class Summary

Nested classes inherited from class com.starbase.starteam.Item

Item.LockType

Field Summary

Fields inherited from class com.starbase.starteam.Folder

EOL_CR, EOL_CRLF, EOL_LF, EXCLUDE_INHERIT, EXCLUDE_LOCAL, EXCLUDE_NONE

Method Summary

PreviewState

getPreviewState(Type type) Returns the preview state of this folder, which is an aggregate of the states of the constituent elements (items & sub-folders) of this folder

Methods inherited from class com.starbase.starteam.Folder

add, addFolderListener, addFolderUpdateListener, addItemListener, addItemListener, addItemUpdateListener, copy, copyFolderTree, countItems, discardItems, enumerateItems, equals, getACL, getAlternatePathFragment, getCaseSensitiveFileNames, getContainerLevelACL, getDefaultPathFragment, getDescription, getDotNotation, getExcludeFlags, getExcludeList, getFileEOL, getFilePath, getFolderHierarchy, getFolderTree, getHistory, getItems, getList, getName, getNotInViewFiles, getParentContainer, getParentFolder, getPath, getPathFragment, getQualifiedName, getSubFolderCount, getSubFolders, getUserVisible, hashCode, hasParentFolder, hasPermission, isEqualTo, isExcluded, isPopulated, isRefreshItemsRequired, move, moveTo, populateAsNeeded, populateInBackground, populateNow, put, putByPropertyID, refreshForeignFiles, refreshItems, remove, removeFolderListener, removeFolderUpdateListener, removeItemListener, removeItemUpdateListener, resolveExcludeList, resolveUserVisible, reverseShareTo, setACL, setAlternatePathFragment, setContainerLevelACL, setDefaultPathFragment, setDescription, setExcludeFlags, setExcludeList, setName, setUserVisible, shareTo, shareTo, toString, update, updateFolderTree

Methods inherited from class com.starbase.starteam.Item

acquireOwnership, addAttachment, createAttachment, createAttachmentFromFile, createItem, deleteMergePoint, discard, get, getAllLabels, getAttachedLabels, getAttachment, getAttachmentIDs, getAttachmentNames, getAttachmentToFile, getBehavior, getBranchRevisionFromDotNotation, getByProperty, getByPropertyID, getByteArray, getCachedProperties, getComment, getCommonAncestor, getCreatedBy, getCreatedTime, getDeletedTime, getDeletedUserID, getDisplayValue, getDouble, getEnumDisplayName, getFlag, getFlagDisplayName, getFromHistoryByDate, getFromHistoryByLabelID, getFromHistoryByVersion, getID, getInt, getIntArray, getItemID, getItemRevisions, getLocker, getMergeHistory, getModifiedBy, getModifiedTime, getMyLock, getNewRevisionComment, getObjectID, getOLEDate, getOwner, getParentFolderHierarchy, getParentFolderName, getParentFolderPath, getParentFolderQualifiedName, getParentRevision, getPossibleFlag, getPossibleReadStatus, getPossibleValues, getPropertyNames, getReadStatus, getReadStatusDisplayName, getReference, getReferences, getRevisionNumber, getRootObjectID, getServer, getString, getType, getTypeNames, getView, getViewVersion, getViewVersionFromDotNotation, hasPermission, hasValues, isBranchable, isDeleted, isDirty, isDisembodied, isFromHistory, isNew, isRefreshRequired, isRefreshRequired, isReverseShareRecommended, isRootShare, lock, modifyFlagForUser, modifyReadStatusForUser, populate, populate, putLock, recordMergePoint, refresh, refresh, removeAttachment, resolveMergePoint, reverseShareTo, setBehavior, setBranchOnChange, setComment, setFixedConfig, setFloatingConfig, smartShareTo, toDebugString, unlock, updateRevisionComment

Methods inherited from class com.starbase.starteam.TypedResource

addToIntArray, removeFromIntArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getPreviewState

public PreviewState getPreviewState(Type type)

Returns the preview state of this folder, which is an aggregate of the states of the constituent elements (items & sub-folders) of this folder

Parameters:

type - Type the type for which to request the state (use null for all types).

Returns:

PreviewState the preview State of this folder