com.box.sdk

Enum BoxAPIConnection.ResourceLinkType

Object

Enum<BoxAPIConnection.ResourceLinkType>

BoxAPIConnection.ResourceLinkType

All Implemented Interfaces:

Serializable, Comparable<BoxAPIConnection.ResourceLinkType>

Enclosing class:

BoxAPIConnection

protected static enum BoxAPIConnection.ResourceLinkType
extends Enum<BoxAPIConnection.ResourceLinkType>

Used to categorize the types of resource links.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APIEndpoint Resource URLs that point to an API endipoint such as https://api.box.com/2.0/files/:file_id.
SharedLink Resource URLs that point to a resource that has been shared such as https://example.box.com/s/qwertyuiop1234567890asdfghjk or https://example.app.box.com/notes/0987654321?s=zxcvbnm1234567890asdfghjk.
Unknown Catch-all default for resource links that are unknown.

Method Summary

Modifier and Type	Method and Description
static BoxAPIConnection.ResourceLinkType	valueOf(String name) Returns the enum constant of this type with the specified name.
static BoxAPIConnection.ResourceLinkType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Unknown

public static final BoxAPIConnection.ResourceLinkType Unknown

Catch-all default for resource links that are unknown.

APIEndpoint

public static final BoxAPIConnection.ResourceLinkType APIEndpoint

Resource URLs that point to an API endipoint such as https://api.box.com/2.0/files/:file_id.

SharedLink

public static final BoxAPIConnection.ResourceLinkType SharedLink

Resource URLs that point to a resource that has been shared such as https://example.box.com/s/qwertyuiop1234567890asdfghjk or https://example.app.box.com/notes/0987654321?s=zxcvbnm1234567890asdfghjk.

Method Detail

values

public static BoxAPIConnection.ResourceLinkType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BoxAPIConnection.ResourceLinkType c : BoxAPIConnection.ResourceLinkType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BoxAPIConnection.ResourceLinkType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null