com.dropbox.core.v2.files

Class ThumbnailArg.Builder

java.lang.Object

com.dropbox.core.v2.files.ThumbnailArg.Builder

Enclosing class:

ThumbnailArg

public static class ThumbnailArg.Builder
extends java.lang.Object

Builder for ThumbnailArg.

Field Summary

Fields

Modifier and Type	Field and Description
protected ThumbnailFormat	format
protected ThumbnailMode	mode
protected java.lang.String	path
protected ThumbnailSize	size

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
ThumbnailArg	build() Builds an instance of ThumbnailArg configured with this builder's values
ThumbnailArg.Builder	withFormat(ThumbnailFormat format) Set value for optional field.
ThumbnailArg.Builder	withMode(ThumbnailMode mode) Set value for optional field.
ThumbnailArg.Builder	withSize(ThumbnailSize size) Set value for optional field.

Methods inherited from class java.lang.Object

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

Field Detail

path

protected final java.lang.String path

format

protected ThumbnailFormat format

size

protected ThumbnailSize size

mode

protected ThumbnailMode mode

Constructor Detail

Builder

protected Builder(java.lang.String path)

Method Detail

withFormat

public ThumbnailArg.Builder withFormat(ThumbnailFormat format)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailFormat.JPEG.

Parameters:

format - The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts. Must not be null. Defaults to ThumbnailFormat.JPEG when set to null.

Returns:

this builder

Throws:

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

withSize

public ThumbnailArg.Builder withSize(ThumbnailSize size)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailSize.W64H64.

Parameters:

size - The size for the thumbnail image. Must not be null. Defaults to ThumbnailSize.W64H64 when set to null.

Returns:

this builder

Throws:

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

withMode

public ThumbnailArg.Builder withMode(ThumbnailMode mode)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailMode.STRICT.

Parameters:

mode - How to resize and crop the image to achieve the desired size. Must not be null. Defaults to ThumbnailMode.STRICT when set to null.

Returns:

this builder

Throws:

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

build

public ThumbnailArg build()

Builds an instance of ThumbnailArg configured with this builder's values

Returns:

new instance of ThumbnailArg