Folder (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - FolderBase
    - - FolderMini
      - Folder

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FolderFull
```
public class Folder
extends FolderMini
```
A standard representation of a folder, as returned from any folder API endpoints by default.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Folder.Builder

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected OffsetDateTime`	`contentCreatedAt` The date and time at which this folder was originally created.
`protected OffsetDateTime`	`contentModifiedAt` The date and time at which this folder was last updated.
`protected OffsetDateTime`	`createdAt` The date and time when the folder was created.
`protected UserMini`	`createdBy`
`protected String`	`description`
`protected FolderFolderUploadEmailField`	`folderUploadEmail` The `folder_upload_email` parameter is not `null` if one of the following options is true:
`protected Items`	`itemCollection`
`protected EnumWrapper<FolderItemStatusField>`	`itemStatus` Defines if this item has been deleted or not.
`protected OffsetDateTime`	`modifiedAt` The date and time when the folder was last updated.
`protected UserMini`	`modifiedBy`
`protected UserMini`	`ownedBy`
`protected FolderMini`	`parent`
`protected FolderPathCollectionField`	`pathCollection`
`protected OffsetDateTime`	`purgedAt` The time at which this folder is expected to be purged from the trash.
`protected FolderSharedLinkField`	`sharedLink`
`protected Long`	`size` The folder size in bytes.
`protected OffsetDateTime`	`trashedAt` The time at which this folder was put in the trash.

Fields inherited from class FolderMini
name, sequenceId

Fields inherited from class FolderBase
etag, id, type

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected Folder(Folder.Builder builder)

Folder(String id)

Constructors
Modifier	Constructor and Description
`protected`	`Folder(Folder.Builder builder)`
	`Folder(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()`
`FolderFolderUploadEmailField`	`getFolderUploadEmail()`
`Items`	`getItemCollection()`
`EnumWrapper<FolderItemStatusField>`	`getItemStatus()`
`OffsetDateTime`	`getModifiedAt()`
`UserMini`	`getModifiedBy()`
`UserMini`	`getOwnedBy()`
`FolderMini`	`getParent()`
`FolderPathCollectionField`	`getPathCollection()`
`OffsetDateTime`	`getPurgedAt()`
`FolderSharedLinkField`	`getSharedLink()`
`Long`	`getSize()`
`OffsetDateTime`	`getTrashedAt()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class FolderMini
getName, getSequenceId

Methods inherited from class FolderBase
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
  - createdAt
```
protected OffsetDateTime createdAt
```
    The date and time when the folder was created. This value may be `null` for some folders such as the root folder or the trash folder.
  - modifiedAt
```
protected OffsetDateTime modifiedAt
```
    The date and time when the folder was last updated. This value may be `null` for some folders such as the root folder or the trash folder.
  - description
```
protected String description
```
  - size
```
protected Long size
```
    The folder size in bytes.
    Be careful parsing this integer as its value can get very large.
  - pathCollection
```
protected FolderPathCollectionField pathCollection
```
  - createdBy
```
protected UserMini createdBy
```
  - modifiedBy
```
protected UserMini modifiedBy
```
  - trashedAt
```
protected OffsetDateTime trashedAt
```
    The time at which this folder was put in the trash.
  - purgedAt
```
protected OffsetDateTime purgedAt
```
    The time at which this folder is expected to be purged from the trash.
  - contentCreatedAt
```
protected OffsetDateTime contentCreatedAt
```
    The date and time at which this folder was originally created.
  - contentModifiedAt
```
protected OffsetDateTime contentModifiedAt
```
    The date and time at which this folder was last updated.
  - ownedBy
```
protected UserMini ownedBy
```
  - sharedLink
```
protected FolderSharedLinkField sharedLink
```
  - folderUploadEmail
```
protected FolderFolderUploadEmailField folderUploadEmail
```
    The `folder_upload_email` parameter is not `null` if one of the following options is **true**:
    * The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.
    * The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).
    If the conditions are not met, the parameter will have the following value: `folder_upload_email: null`.
  - parent
```
protected FolderMini parent
```
  - itemStatus
```
protected EnumWrapper<FolderItemStatusField> 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.
  - itemCollection
```
protected Items itemCollection
```
- Constructor Detail
  - Folder
```
public Folder(String id)
```
  - Folder
```
protected Folder(Folder.Builder builder)
```
- Method Detail
  - getCreatedAt
```
public OffsetDateTime getCreatedAt()
```
  - getModifiedAt
```
public OffsetDateTime getModifiedAt()
```
  - getDescription
```
public String getDescription()
```
  - getSize
```
public Long getSize()
```
  - getPathCollection
```
public FolderPathCollectionField getPathCollection()
```
  - getCreatedBy
```
public UserMini getCreatedBy()
```
  - getModifiedBy
```
public UserMini getModifiedBy()
```
  - getTrashedAt
```
public OffsetDateTime getTrashedAt()
```
  - getPurgedAt
```
public OffsetDateTime getPurgedAt()
```
  - getContentCreatedAt
```
public OffsetDateTime getContentCreatedAt()
```
  - getContentModifiedAt
```
public OffsetDateTime getContentModifiedAt()
```
  - getOwnedBy
```
public UserMini getOwnedBy()
```
  - getSharedLink
```
public FolderSharedLinkField getSharedLink()
```
  - getFolderUploadEmail
```
public FolderFolderUploadEmailField getFolderUploadEmail()
```
  - getParent
```
public FolderMini getParent()
```
  - getItemStatus
```
public EnumWrapper<FolderItemStatusField> getItemStatus()
```
  - getItemCollection
```
public Items getItemCollection()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class FolderMini
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class FolderMini
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class FolderMini

Class Folder

Nested Class Summary

Field Summary

Fields inherited from class FolderMini

Fields inherited from class FolderBase

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class FolderMini

Methods inherited from class FolderBase

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

createdAt

modifiedAt

description

size

pathCollection

createdBy

modifiedBy

trashedAt

purgedAt

contentCreatedAt

contentModifiedAt

ownedBy

sharedLink

folderUploadEmail

parent

itemStatus

itemCollection

Constructor Detail

Folder

Folder

Method Detail

getCreatedAt

getModifiedAt

getDescription

getSize

getPathCollection

getCreatedBy

getModifiedBy

getTrashedAt

getPurgedAt

getContentCreatedAt

getContentModifiedAt

getOwnedBy

getSharedLink

getFolderUploadEmail

getParent

getItemStatus

getItemCollection

equals

hashCode

toString