AbstractFileSystemItem (Nuxeo ECM Projects 9.2-SNAPSHOT API)

java.lang.Object
- org.nuxeo.drive.adapter.impl.AbstractFileSystemItem

All Implemented Interfaces:

Serializable, Comparable<FileSystemItem>, FileSystemItem

Direct Known Subclasses:

AbstractDocumentBackedFileSystemItem, AbstractVirtualFolderItem
```
public abstract class AbstractFileSystemItem
extends Object
implements FileSystemItem
```
Base class for FileSystemItem implementations.

Author:

Antoine Taillefer

See Also:

AbstractDocumentBackedFileSystemItem, DefaultTopLevelFolderItem, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`canDelete`
`protected boolean`	`canRename`
`protected Calendar`	`creationDate`
`protected String`	`creator`
`protected String`	`factoryName` Internal attributes
`static String`	`FILE_SYSTEM_ITEM_ID_SEPARATOR`
`protected boolean`	`folder`
`protected String`	`id` `FileSystemItem` attributes
`protected String`	`lastContributor`
`protected Calendar`	`lastModificationDate`
`protected Lock`	`lockInfo`
`protected String`	`name`
`protected String`	`parentId`
`protected String`	`path`
`protected Principal`	`principal`
`protected String`	`userName` Needed for JSON serialization/deserialization since we don't serialize the principal

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractFileSystemItem()`
`protected`	`AbstractFileSystemItem(String factoryName, Principal principal, boolean relaxSyncRootConstraint)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`canMove(FolderItem dest)`
`int`	`compareTo(FileSystemItem other)`
`abstract void`	`delete()`
`boolean`	`equals(Object obj)`
`boolean`	`getCanDelete()`
`boolean`	`getCanRename()`
`Calendar`	`getCreationDate()`
`String`	`getCreator()`
`protected FileSystemItemAdapterService`	`getFileSystemItemAdapterService()`
`String`	`getId()` Gets a unique id generated server-side.
`String`	`getLastContributor()`
`Calendar`	`getLastModificationDate()`
`Lock`	`getLockInfo()`
`String`	`getName()` Gets the name displayed in the file system.
`String`	`getParentId()` Gets the parent `FileSystemItem` id.
`String`	`getPath()` A concatenation of ancestor ids with '/' as prefix and separator.
`String`	`getUserName()`
`int`	`hashCode()`
`boolean`	`isFolder()`
`abstract FileSystemItem`	`move(FolderItem dest)`
`abstract void`	`rename(String name)`
`protected void`	`setCanDelete(boolean canDelete)`
`protected void`	`setCanRename(boolean canRename)`
`protected void`	`setCreationDate(Calendar creationDate)`
`protected void`	`setCreator(String creator)`
`protected void`	`setFolder(boolean isFolder)`
`protected void`	`setId(String id)`
`protected void`	`setLastContributor(String lastContributor)`
`protected void`	`setLastModificationDate(Calendar lastModificationDate)`
`protected void`	`setLockInfo(Lock lockInfo)`
`protected void`	`setName(String name)`
`protected void`	`setParentId(String parentId)`
`protected void`	`setPath(String path)`
`protected void`	`setUserName(String userName)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FILE_SYSTEM_ITEM_ID_SEPARATOR

public static final String FILE_SYSTEM_ITEM_ID_SEPARATOR

See Also:: Constant Field Values

id
```
protected String id
```
FileSystemItem attributes

parentId
```
protected String parentId
```

name
```
protected String name
```

folder
```
protected boolean folder
```

creator
```
protected String creator
```

lastContributor
```
protected String lastContributor
```

creationDate
```
protected Calendar creationDate
```

lastModificationDate

protected Calendar lastModificationDate

canRename
```
protected boolean canRename
```

canDelete
```
protected boolean canDelete
```

lockInfo
```
protected Lock lockInfo
```

factoryName
```
protected String factoryName
```
Internal attributes

path
```
protected String path
```

principal

protected transient Principal principal

userName
```
protected String userName
```
Needed for JSON serialization/deserialization since we don't serialize the principal

Constructor Detail

AbstractFileSystemItem

protected AbstractFileSystemItem(String factoryName,
                                 Principal principal,
                                 boolean relaxSyncRootConstraint)

AbstractFileSystemItem
```
protected AbstractFileSystemItem()
```

Method Detail
- rename
```
public abstract void rename(String name)
```
  Specified by:
  
  rename in interface FileSystemItem
- delete
```
public abstract void delete()
```
  Specified by:
  
  delete in interface FileSystemItem
- canMove
```
public abstract boolean canMove(FolderItem dest)
```
  Specified by:
  
  canMove in interface FileSystemItem
- move
```
public abstract FileSystemItem move(FolderItem dest)
```
  Specified by:
  
  move in interface FileSystemItem
- getId
```
public String getId()
```
  Description copied from interface: FileSystemItem
  
  Gets a unique id generated server-side.
  
  Specified by:
  
  getId in interface FileSystemItem
- getPath
```
public String getPath()
```
  Description copied from interface: FileSystemItem
  
  A concatenation of ancestor ids with '/' as prefix and separator.
  
  Specified by:
  
  getPath in interface FileSystemItem
- getParentId
```
public String getParentId()
```
  Description copied from interface: FileSystemItem
  
  Gets the parent FileSystemItem id.
  
  Specified by:
  
  getParentId in interface FileSystemItem
- getName
```
public String getName()
```
  Description copied from interface: FileSystemItem
  
  Gets the name displayed in the file system.
  
  Specified by:
  
  getName in interface FileSystemItem
- isFolder
```
public boolean isFolder()
```
  Specified by:
  
  isFolder in interface FileSystemItem
- getCreator
```
public String getCreator()
```
  Specified by:
  
  getCreator in interface FileSystemItem
- getLastContributor
```
public String getLastContributor()
```
  Specified by:
  
  getLastContributor in interface FileSystemItem
- getCreationDate
```
public Calendar getCreationDate()
```
  Specified by:
  
  getCreationDate in interface FileSystemItem
- getLastModificationDate
```
public Calendar getLastModificationDate()
```
  Specified by:
  
  getLastModificationDate in interface FileSystemItem
- getCanRename
```
public boolean getCanRename()
```
  Specified by:
  
  getCanRename in interface FileSystemItem
- getCanDelete
```
public boolean getCanDelete()
```
  Specified by:
  
  getCanDelete in interface FileSystemItem
- getLockInfo
```
public Lock getLockInfo()
```
  Specified by:
  
  getLockInfo in interface FileSystemItem
- getUserName
```
public String getUserName()
```
- compareTo
```
public int compareTo(FileSystemItem other)
```
  Specified by:
  
  compareTo in interface Comparable<FileSystemItem>
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- getFileSystemItemAdapterService
```
protected FileSystemItemAdapterService getFileSystemItemAdapterService()
```
- setId
```
protected void setId(String id)
```
- setPath
```
protected void setPath(String path)
```
- setParentId
```
protected void setParentId(String parentId)
```
- setName
```
protected void setName(String name)
```
- setFolder
```
protected void setFolder(boolean isFolder)
```
- setCreator
```
protected void setCreator(String creator)
```
- setLastContributor
```
protected void setLastContributor(String lastContributor)
```
- setCreationDate
```
protected void setCreationDate(Calendar creationDate)
```
- setLastModificationDate
```
protected void setLastModificationDate(Calendar lastModificationDate)
```
- setCanRename
```
protected void setCanRename(boolean canRename)
```
- setCanDelete
```
protected void setCanDelete(boolean canDelete)
```
- setLockInfo
```
protected void setLockInfo(Lock lockInfo)
```
- setUserName
```
protected void setUserName(String userName)
```

Class AbstractFileSystemItem

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILE_SYSTEM_ITEM_ID_SEPARATOR

id

parentId

name

folder

creator

lastContributor

creationDate

lastModificationDate

canRename

canDelete

lockInfo

factoryName

path

principal

userName

Constructor Detail

AbstractFileSystemItem

AbstractFileSystemItem

Method Detail

rename

delete

canMove

move

getId

getPath

getParentId

getName

isFolder

getCreator

getLastContributor

getCreationDate

getLastModificationDate

getCanRename

getCanDelete

getLockInfo

getUserName

compareTo

equals

hashCode

toString

getFileSystemItemAdapterService

setId

setPath

setParentId

setName

setFolder

setCreator

setLastContributor

setCreationDate

setLastModificationDate

setCanRename

setCanDelete

setLockInfo

setUserName