Package com.dropbox.core.v2.files

Class ExportMetadata

java.lang.Object

com.dropbox.core.v2.files.ExportMetadata

public class ExportMetadata
extends java.lang.Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	exportHash
protected java.lang.String	name
protected java.lang.Long	paperRevision
protected long	size

Constructor Summary

Constructors

Constructor	Description
ExportMetadata(java.lang.String name, long size)	None
ExportMetadata(java.lang.String name, long size, java.lang.String exportHash, java.lang.Long paperRevision)	Use newBuilder(java.lang.String,long) to create instances of this class without specifying values for all optional fields.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getExportHash()	A hash based on the exported file content.
java.lang.String	getName()	The last component of the path (including extension).
java.lang.Long	getPaperRevision()	If the file is a Paper doc, this gives the latest doc revision which can be used in DbxUserFilesRequests.paperUpdate(String,ImportFormat,PaperDocUpdatePolicy,Long).
long	getSize()	The file size in bytes.
int	hashCode()
static ExportMetadata.Builder	newBuilder(java.lang.String name, long size)	Returns a new builder for creating an instance of this class.
java.lang.String	toString()
java.lang.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

name

@Nonnull
protected final java.lang.String name

size

protected final long size

exportHash

@Nullable
protected final java.lang.String exportHash

paperRevision

@Nullable
protected final java.lang.Long paperRevision

Constructor Detail

ExportMetadata

public ExportMetadata(@Nonnull
                      java.lang.String name,
                      long size,
                      @Nullable
                      java.lang.String exportHash,
                      @Nullable
                      java.lang.Long paperRevision)

Use newBuilder(java.lang.String,long) to create instances of this class without specifying values for all optional fields.

Parameters:

name - The last component of the path (including extension). This never contains a slash. Must not be null.

size - The file size in bytes.

exportHash - A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our Content hash page. Must have length of at least 64 and have length of at most 64.

paperRevision - If the file is a Paper doc, this gives the latest doc revision which can be used in DbxUserFilesRequests.paperUpdate(String,ImportFormat,PaperDocUpdatePolicy,Long).

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

ExportMetadata

public ExportMetadata(@Nonnull
                      java.lang.String name,
                      long size)

None

The default values for unset fields will be used.

Parameters:

name - The last component of the path (including extension). This never contains a slash. Must not be null.

size - The file size in bytes.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

Method Detail

getName

@Nonnull
public java.lang.String getName()

The last component of the path (including extension). This never contains a slash.

Returns:

value for this field, never null.

getSize

public long getSize()

The file size in bytes.

Returns:

value for this field.

getExportHash

@Nullable
public java.lang.String getExportHash()

A hash based on the exported file content. This field can be used to verify data integrity. Similar to content hash. For more information see our Content hash page.

Returns:

value for this field, or null if not present.

getPaperRevision

@Nullable
public java.lang.Long getPaperRevision()

If the file is a Paper doc, this gives the latest doc revision which can be used in DbxUserFilesRequests.paperUpdate(String,ImportFormat,PaperDocUpdatePolicy,Long).

Returns:

value for this field, or null if not present.

newBuilder

public static ExportMetadata.Builder newBuilder(java.lang.String name,
                                                long size)

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

Parameters:

name - The last component of the path (including extension). This never contains a slash. Must not be null.

size - The file size in bytes.

Returns:

builder for this class.

Throws:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringMultiline

public java.lang.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