File (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - FileBase
    - - FileMini
      - File

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FileFull
```
public class File
extends FileMini
```
A standard representation of a file, as returned from any file API endpoints by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class File.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`File.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected OffsetDateTime`	`contentCreatedAt` The date and time at which this file was originally created, which might be before it was uploaded to Box.
`protected OffsetDateTime`	`contentModifiedAt` The date and time at which this file was last updated, which might be before it was uploaded to Box.
`protected OffsetDateTime`	`createdAt` The date and time when the file was created on Box.
`protected UserMini`	`createdBy`
`protected String`	`description` The optional description of this file.
`protected EnumWrapper<FileItemStatusField>`	`itemStatus` Defines if this item has been deleted or not.
`protected OffsetDateTime`	`modifiedAt` The date and time when the file was last updated on Box.
`protected UserMini`	`modifiedBy`
`protected UserMini`	`ownedBy`
`protected FolderMini`	`parent`
`protected FilePathCollectionField`	`pathCollection`
`protected OffsetDateTime`	`purgedAt` The time at which this file is expected to be purged from the trash.
`protected FileSharedLinkField`	`sharedLink`
`protected Long`	`size` The file size in bytes.
`protected OffsetDateTime`	`trashedAt` The time at which this file was put in the trash.

Fields inherited from class FileMini
fileVersion, name, sequenceId, sha1

Fields inherited from class FileBase
etag, id, type

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected File(File.Builder builder)

File(String id)

Constructors
Modifier	Constructor and Description
`protected`	`File(File.Builder builder)`
	`File(String id)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`OffsetDateTime`	`getContentCreatedAt()`
`OffsetDateTime`	`getContentModifiedAt()`
`OffsetDateTime`	`getCreatedAt()`
`UserMini`	`getCreatedBy()`
`String`	`getDescription()`
`EnumWrapper<FileItemStatusField>`	`getItemStatus()`
`OffsetDateTime`	`getModifiedAt()`
`UserMini`	`getModifiedBy()`
`UserMini`	`getOwnedBy()`
`FolderMini`	`getParent()`
`FilePathCollectionField`	`getPathCollection()`
`OffsetDateTime`	`getPurgedAt()`
`FileSharedLinkField`	`getSharedLink()`
`Long`	`getSize()`
`OffsetDateTime`	`getTrashedAt()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class FileMini
getFileVersion, getName, getSequenceId, getSha1

Methods inherited from class FileBase
getEtag, getId, getType

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

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

- Field Detail
  - description
```
protected String description
```
    The optional description of this file. If the description exceeds 255 characters, the first 255 characters are set as a file description and the rest of it is ignored.
  - size
```
protected Long size
```
    The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.
  - pathCollection
```
protected FilePathCollectionField pathCollection
```
  - createdAt
```
protected OffsetDateTime createdAt
```
    The date and time when the file was created on Box.
  - modifiedAt
```
protected OffsetDateTime modifiedAt
```
    The date and time when the file was last updated on Box.
  - trashedAt
```
protected OffsetDateTime trashedAt
```
    The time at which this file was put in the trash.
  - purgedAt
```
protected OffsetDateTime purgedAt
```
    The time at which this file is expected to be purged from the trash.
  - contentCreatedAt
```
protected OffsetDateTime contentCreatedAt
```
    The date and time at which this file was originally created, which might be before it was uploaded to Box.
  - contentModifiedAt
```
protected OffsetDateTime contentModifiedAt
```
    The date and time at which this file was last updated, which might be before it was uploaded to Box.
  - createdBy
```
protected UserMini createdBy
```
  - modifiedBy
```
protected UserMini modifiedBy
```
  - ownedBy
```
protected UserMini ownedBy
```
  - sharedLink
```
protected FileSharedLinkField sharedLink
```
  - parent
```
protected FolderMini parent
```
  - itemStatus
```
protected EnumWrapper<FileItemStatusField> itemStatus
```
    Defines if this item has been deleted or not.
    * `active` when the item has is not in the trash * `trashed` when the item has been moved to the trash but not deleted * `deleted` when the item has been permanently deleted.
- Constructor Detail
  - File
```
public File(String id)
```
  - File
```
protected File(File.Builder builder)
```
- Method Detail
  - getDescription
```
public String getDescription()
```
  - getSize
```
public Long getSize()
```
  - getPathCollection
```
public FilePathCollectionField getPathCollection()
```
  - getCreatedAt
```
public OffsetDateTime getCreatedAt()
```
  - getModifiedAt
```
public OffsetDateTime getModifiedAt()
```
  - getTrashedAt
```
public OffsetDateTime getTrashedAt()
```
  - getPurgedAt
```
public OffsetDateTime getPurgedAt()
```
  - getContentCreatedAt
```
public OffsetDateTime getContentCreatedAt()
```
  - getContentModifiedAt
```
public OffsetDateTime getContentModifiedAt()
```
  - getCreatedBy
```
public UserMini getCreatedBy()
```
  - getModifiedBy
```
public UserMini getModifiedBy()
```
  - getOwnedBy
```
public UserMini getOwnedBy()
```
  - getSharedLink
```
public FileSharedLinkField getSharedLink()
```
  - getParent
```
public FolderMini getParent()
```
  - getItemStatus
```
public EnumWrapper<FileItemStatusField> getItemStatus()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class FileMini
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class FileMini
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class FileMini

Class File

Nested Class Summary

Field Summary

Fields inherited from class FileMini

Fields inherited from class FileBase

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class FileMini

Methods inherited from class FileBase

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

description

size

pathCollection

createdAt

modifiedAt

trashedAt

purgedAt

contentCreatedAt

contentModifiedAt

createdBy

modifiedBy

ownedBy

sharedLink

parent

itemStatus

Constructor Detail

File

File

Method Detail

getDescription

getSize

getPathCollection

getCreatedAt

getModifiedAt

getTrashedAt

getPurgedAt

getContentCreatedAt

getContentModifiedAt

getCreatedBy

getModifiedBy

getOwnedBy

getSharedLink

getParent

getItemStatus

equals

hashCode

toString