com.box.sdk

Class BoxResource

Object

BoxResource

Direct Known Subclasses:

BoxCollaboration, BoxCollaborationAllowlist, BoxCollaborationAllowlistExemptTarget, BoxCollaborator, BoxCollection, BoxComment, BoxDevicePin, BoxEvent, BoxFileRequest, BoxFileUploadSession, BoxFileVersion, BoxFileVersionLegalHold, BoxFileVersionRetention, BoxFolderLock, BoxGroupMembership, BoxInvite, BoxItem, BoxLegalHoldAssignment, BoxLegalHoldPolicy, BoxMetadataCascadePolicy, BoxRetentionPolicy, BoxRetentionPolicyAssignment, BoxSignRequest, BoxSignTemplate, BoxStoragePolicy, BoxStoragePolicyAssignment, BoxTask, BoxTaskAssignment, BoxTermsOfService, BoxTermsOfServiceUserStatus, BoxWebHook

public abstract class BoxResource
extends Object

The abstract base class for all resource types (files, folders, comments, collaborations, etc.) used by the API.

Every API resource has an ID and a BoxAPIConnection that it uses to communicate with the API. Some resources also have an associated BoxResource.Info class that contains information about the resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxResource.Info Contains information about a BoxResource.

Constructor Summary

Constructors

Constructor and Description
BoxResource(BoxAPIConnection api, String id) Constructs a BoxResource for a resource with a given ID.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Indicates whether this BoxResource is equal to another BoxResource.
BoxAPIConnection	getAPI() Gets the API connection used by this resource.
String	getID() Gets the ID of this resource.
static String	getResourceType(Class<? extends BoxResource> clazz) Resolves BoxResourceType for a provided BoxResource Class.
int	hashCode() Returns a hash code value for this BoxResource.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BoxResource

public BoxResource(BoxAPIConnection api,
                   String id)

Constructs a BoxResource for a resource with a given ID.

Parameters:

api - the API connection to be used by the resource.

id - the ID of the resource.

Method Detail

getResourceType

public static String getResourceType(Class<? extends BoxResource> clazz)

Resolves BoxResourceType for a provided BoxResource Class.

Parameters:

clazz - BoxResource type

Returns:

resolved BoxResourceType.value()

getAPI

public BoxAPIConnection getAPI()

Gets the API connection used by this resource.

Returns:

the API connection used by this resource.

getID

public String getID()

Gets the ID of this resource.

Returns:

the ID of this resource.

equals

public boolean equals(Object other)

Indicates whether this BoxResource is equal to another BoxResource. Two BoxResources are equal if they have the same type and ID.

Overrides:

equals in class Object

Parameters:

other - the other BoxResource to compare.

Returns:

true if the type and IDs of the two resources are equal; otherwise false.

hashCode

public int hashCode()

Returns a hash code value for this BoxResource.

Overrides:

hashCode in class Object

Returns:

a hash code value for this BoxResource.