com.dropbox.core.v2.sharing

Class GetSharedLinkMetadataArg

java.lang.Object

com.dropbox.core.v2.sharing.GetSharedLinkMetadataArg

public class GetSharedLinkMetadataArg
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetSharedLinkMetadataArg.Builder Builder for GetSharedLinkMetadataArg.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	linkPassword
protected String	path
protected String	url

Constructor Summary

Constructors

Constructor and Description
GetSharedLinkMetadataArg(String url) The default values for unset fields will be used.
GetSharedLinkMetadataArg(String url, String path, String linkPassword) Use newBuilder to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLinkPassword() If the shared link has a password, this parameter can be used.
String	getPath() If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder.
String	getUrl() URL of the shared link.
int	hashCode()
static GetSharedLinkMetadataArg.Builder	newBuilder(String url) Returns a new builder for creating an instance of this class.
String	toString()
String	toStringMultiline() Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

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

Field Detail

url

protected final String url

path

protected final String path

linkPassword

protected final String linkPassword

Constructor Detail

GetSharedLinkMetadataArg

public GetSharedLinkMetadataArg(String url,
                                String path,
                                String linkPassword)

Use newBuilder to create instances of this class without specifying values for all optional fields.

Parameters:

url - URL of the shared link. Must not be null.

path - If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used. Must match pattern "/(.|[\\r\\n])*".

linkPassword - If the shared link has a password, this parameter can be used.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GetSharedLinkMetadataArg

public GetSharedLinkMetadataArg(String url)

The default values for unset fields will be used.

Parameters:

url - URL of the shared link. Must not be null.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getUrl

public String getUrl()

URL of the shared link.

Returns:

value for this field, never null.

getPath

public String getPath()

If the shared link is to a folder, this parameter can be used to retrieve the metadata for a specific file or sub-folder in this folder. A relative path should be used.

Returns:

value for this field, or null if not present.

getLinkPassword

public String getLinkPassword()

If the shared link has a password, this parameter can be used.

Returns:

value for this field, or null if not present.

newBuilder

public static GetSharedLinkMetadataArg.Builder newBuilder(String url)

Returns a new builder for creating an instance of this class.

Parameters:

url - URL of the shared link. Must not be null.

Returns:

builder for this class.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object