com.uploadcare.api

Class FilesQueryBuilder

java.lang.Object

com.uploadcare.api.FilesQueryBuilder

All Implemented Interfaces:

PaginatedQueryBuilder<File>

public class FilesQueryBuilder
extends java.lang.Object
implements PaginatedQueryBuilder<File>

File resource request builder. Allows to specify some file filters and get results.

See Also:

File

Constructor Summary

Constructors

Constructor and Description
FilesQueryBuilder(Client client) Initializes a new builder for the given client.

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<File>	asIterable() Returns a resource iterable for lazy loading.
java.util.List<File>	asList() Iterates through all resources and returns a complete list.
FilesQueryBuilder	from(java.util.Date from) Adds a filter for datetime from objects will be returned.
FilesQueryBuilder	removed(boolean removed) Adds a filter for removed files.
FilesQueryBuilder	stored(boolean stored) Adds a filter for stored files.
FilesQueryBuilder	to(java.util.Date to) Adds a filter for datetime to which objects will be returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilesQueryBuilder

public FilesQueryBuilder(Client client)

Initializes a new builder for the given client.

Method Detail

removed

public FilesQueryBuilder removed(boolean removed)

Adds a filter for removed files.

Parameters:

removed - If true, accepts removed files, otherwise declines them.

stored

public FilesQueryBuilder stored(boolean stored)

Adds a filter for stored files.

Parameters:

stored - If true, accepts stored files, otherwise declines them.

from

public FilesQueryBuilder from(java.util.Date from)

Adds a filter for datetime from objects will be returned.

Parameters:

from - A uploading datetime from which objects will be returned.

to

public FilesQueryBuilder to(java.util.Date to)

Adds a filter for datetime to which objects will be returned.

Parameters:

to - A uploading datetime to which objects will be returned.

asIterable

public java.lang.Iterable<File> asIterable()

Description copied from interface: PaginatedQueryBuilder

Returns a resource iterable for lazy loading.

Specified by:

asIterable in interface PaginatedQueryBuilder<File>

asList

public java.util.List<File> asList()

Description copied from interface: PaginatedQueryBuilder

Iterates through all resources and returns a complete list.

Specified by:

asList in interface PaginatedQueryBuilder<File>