Index (box-client 2.3.2 API)

A B C D E F G H I J M N O P Q R S T U V W
All Classes All Packages

A

AbstractHttpBoxClient - Class in edu.byu.hbll.box.client: A client for communicating with Box through it's web api.
AbstractHttpBoxClient(URI) - Constructor for class edu.byu.hbll.box.client.AbstractHttpBoxClient: Creates a new client.
AbstractHttpBoxClient.QueryResponse - Class in edu.byu.hbll.box.client
accessTokenUri(String) - Method in class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder: Sets the access token URI for OAuth2.
accessTokenUri(URI) - Method in class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder
addDependencies(DocumentId...) - Method in class edu.byu.hbll.box.BoxDocument: Adds dependencies for this document.
addDependencies(Collection<? extends DocumentId>) - Method in class edu.byu.hbll.box.BoxDocument: Adds dependencies for this document.
addDependency(String, String) - Method in class edu.byu.hbll.box.BoxDocument: Adds a dependency for this document.
addFacet(Facet) - Method in class edu.byu.hbll.box.BoxQuery: Adds filter facets.
addFacet(String, String) - Method in class edu.byu.hbll.box.BoxDocument: Adds a facet to this document.
addFacet(String, String) - Method in class edu.byu.hbll.box.BoxQuery: Adds a filter facet.
addFacets(Facet...) - Method in class edu.byu.hbll.box.BoxDocument: Adds multiple facets to the document.
addFacets(Facet...) - Method in class edu.byu.hbll.box.BoxQuery: Adds filter facets.
addFacets(String, String...) - Method in class edu.byu.hbll.box.BoxDocument: Adds multiple facets to the document.
addFacets(String, Collection<String>) - Method in class edu.byu.hbll.box.BoxDocument: Adds multiple facets to the document.
addFacets(Collection<? extends Facet>) - Method in class edu.byu.hbll.box.BoxDocument: Adds multiple facets to the document.
addFacets(Collection<? extends Facet>) - Method in class edu.byu.hbll.box.BoxQuery: Adds filter facets.
addFacetsByQuery(String, String) - Method in class edu.byu.hbll.box.BoxDocument: Adds a facet by querying the internal document using the given path.
addFacetsByQuery(Map<String, Set<String>>) - Method in class edu.byu.hbll.box.BoxDocument: Adds facets by querying the internal document using the given paths.
addField(String) - Method in class edu.byu.hbll.box.BoxQuery: Limit the document to only these fields.
addFields(String...) - Method in class edu.byu.hbll.box.BoxQuery: Limit the document to only these fields.
addFields(Collection<String>) - Method in class edu.byu.hbll.box.BoxQuery: Limit the document to only these fields.
addId(String) - Method in class edu.byu.hbll.box.BoxQuery: Adds an id to this query.
addIds(String...) - Method in class edu.byu.hbll.box.BoxQuery: Adds ids to this query.
addIds(Collection<String>) - Method in class edu.byu.hbll.box.BoxQuery: Adds ids to this query.
addStatus(BoxDocument.Status) - Method in class edu.byu.hbll.box.BoxQuery: Queries by these document statuses.
addStatuses(BoxDocument.Status...) - Method in class edu.byu.hbll.box.BoxQuery: Queries by these document statuses.
addStatuses(Collection<BoxDocument.Status>) - Method in class edu.byu.hbll.box.BoxQuery: Queries by these document statuses.
ASC - edu.byu.hbll.box.BoxQuery.Order: Ascending.

B

basicAuth(String, String) - Method in class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder: Initialize to use basic authentication.
bind(JsonNode, Object) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Binds the given JsonNode to the provided object.
bind(JsonNode, Map<String, JsonNode>) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Binds values in the map to the given JsonNode.
BoxClient - Interface in edu.byu.hbll.box.client: A client for interacting with a Box server.
BoxDocument - Class in edu.byu.hbll.box: Represents a document in box including metadata and dependencies.
BoxDocument() - Constructor for class edu.byu.hbll.box.BoxDocument: Creates a new empty document.
BoxDocument(BoxDocument) - Constructor for class edu.byu.hbll.box.BoxDocument: Copy Constructor.
BoxDocument(String) - Constructor for class edu.byu.hbll.box.BoxDocument: Creates a new document initially in an UNPROCESSED state.
BoxDocument(String, ObjectNode) - Constructor for class edu.byu.hbll.box.BoxDocument: Creates a new document initially in a READY state with the given internal document.
BoxDocument(String, BoxDocument.Status) - Constructor for class edu.byu.hbll.box.BoxDocument: Creates a new document with the given state.
BoxDocument.Deserializer - Class in edu.byu.hbll.box: Deserializer of BoxDocument for Jackson.
BoxDocument.Serializer - Class in edu.byu.hbll.box: Serializer of BoxDocument for Jackson.
BoxDocument.Status - Enum in edu.byu.hbll.box: Status of the document.
BoxQuery - Class in edu.byu.hbll.box: Query for requesting documents from Box.
BoxQuery() - Constructor for class edu.byu.hbll.box.BoxQuery: Creates a new empty query.
BoxQuery(BoxQuery) - Constructor for class edu.byu.hbll.box.BoxQuery: Copy constructor.
BoxQuery(String...) - Constructor for class edu.byu.hbll.box.BoxQuery: Creates a new query with the given ids.
BoxQuery(Collection<String>) - Constructor for class edu.byu.hbll.box.BoxQuery: Creates a new query with the given ids.
BoxQuery.Order - Enum in edu.byu.hbll.box: Order ascending or descending.
BoxUpdatesClient - Class in edu.byu.hbll.box.client: Listens for updates inside a Box and runs the given runnable when there is one.
BoxUpdatesClient(URI, Runnable) - Constructor for class edu.byu.hbll.box.client.BoxUpdatesClient: Creates a new BoxUpdatesClient that will communicate with an upstream box found at the given base uri and run the given runnable whenever there are updates detected.
BoxUpdatesClient(URI, Runnable, ThreadFactory) - Constructor for class edu.byu.hbll.box.client.BoxUpdatesClient: Creates a new BoxUpdatesClient that will communicate with an upstream box found at the given base uri and run the given runnable whenever there are updates detected.
BoxUriBuilder - Class in edu.byu.hbll.box.internal.util
BoxUriBuilder() - Constructor for class edu.byu.hbll.box.internal.util.BoxUriBuilder
BoxUtils - Class in edu.byu.hbll.box.internal.util: Random utilities used by Box.
BoxUtils() - Constructor for class edu.byu.hbll.box.internal.util.BoxUtils
build() - Method in class edu.byu.hbll.box.internal.util.UriBuilder: Builds the URI.
buildQuery(URI, BoxQuery) - Static method in class edu.byu.hbll.box.internal.util.BoxUriBuilder: Builds a final URI given the base uri and query.

C

canonicalizeFields(Collection<String>) - Static method in class edu.byu.hbll.box.internal.util.BoxUtils: Converts non _at_doc fields into _at_doc fields.
clearDependencies() - Method in class edu.byu.hbll.box.BoxDocument: Clears the set of dependencies.
clearFacets() - Method in class edu.byu.hbll.box.BoxDocument: Clears the set of facets.
clearFacets() - Method in class edu.byu.hbll.box.BoxQuery: Clears all the facets.
clearFields() - Method in class edu.byu.hbll.box.BoxQuery: Clears all the fields.
clearIds() - Method in class edu.byu.hbll.box.BoxQuery: Clears all the ids.
clearStatuses() - Method in class edu.byu.hbll.box.BoxQuery: Clears all the statuses.
collect(BoxQuery) - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient
collect(BoxQuery) - Method in interface edu.byu.hbll.box.client.BoxClient: Collects and returns all documents found according to the given query.
CursorUtils - Class in edu.byu.hbll.box.internal.util: Utility class for dealing with cursors (the nanoseconds since the epoch).
CursorUtils() - Constructor for class edu.byu.hbll.box.internal.util.CursorUtils

D

DEFAULT_CURSOR - Static variable in class edu.byu.hbll.box.BoxQuery
DEFAULT_CURSOR_DESC - Static variable in class edu.byu.hbll.box.BoxQuery
DEFAULT_LIMIT - Static variable in class edu.byu.hbll.box.BoxQuery
DEFAULT_ORDER - Static variable in class edu.byu.hbll.box.BoxQuery
DEFAULT_PROCESS - Static variable in class edu.byu.hbll.box.BoxQuery
DEFAULT_STATUSES - Static variable in class edu.byu.hbll.box.BoxQuery
DEFAULT_WAIT - Static variable in class edu.byu.hbll.box.BoxQuery
DELETED - edu.byu.hbll.box.BoxDocument.Status: The document has been deleted.
DESC - edu.byu.hbll.box.BoxQuery.Order: Descending.
deserialize(JsonParser, DeserializationContext) - Method in class edu.byu.hbll.box.BoxDocument.Deserializer
deserialize(String) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Deserializes the string to a JsonNode.
Deserializer() - Constructor for class edu.byu.hbll.box.BoxDocument.Deserializer
Deserializer(Class<?>) - Constructor for class edu.byu.hbll.box.BoxDocument.Deserializer
DOCUMENT_FIELD - Static variable in class edu.byu.hbll.box.BoxQuery
DocumentId - Class in edu.byu.hbll.box: An immutable representation of a box document id which includes the source name of the document and its id.
DocumentId(String, String) - Constructor for class edu.byu.hbll.box.DocumentId: Creates a new DocumentId with the given source name and id.
DocumentIterable - Class in edu.byu.hbll.box.internal.core: An iterable for retrieving Box documents.
DocumentIterable(BoxQuery, int, Function<BoxQuery, QueryResult>) - Constructor for class edu.byu.hbll.box.internal.core.DocumentIterable: Creates a new DocumentIterable.
DocumentIterable(BoxQuery, Function<BoxQuery, QueryResult>) - Constructor for class edu.byu.hbll.box.internal.core.DocumentIterable: Creates a new DocumentIterable with default batch size.
dotPath(JsonNode, String) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Return the found JsonNode after following the dot notation path.

E

edu.byu.hbll.box - package edu.byu.hbll.box
edu.byu.hbll.box.client - package edu.byu.hbll.box.client
edu.byu.hbll.box.internal.core - package edu.byu.hbll.box.internal.core
edu.byu.hbll.box.internal.util - package edu.byu.hbll.box.internal.util
equals(Object) - Method in class edu.byu.hbll.box.BoxDocument
equals(Object) - Method in class edu.byu.hbll.box.DocumentId: Checks equality of the source name and ID.
equals(Object) - Method in class edu.byu.hbll.box.Facet
ERROR - edu.byu.hbll.box.BoxDocument.Status: There was an error in the processing.

F

Facet - Class in edu.byu.hbll.box: Represents a facet.
Facet(String, String) - Constructor for class edu.byu.hbll.box.Facet: Creates a new Facet with the given name and value.
find(BoxQuery) - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient
find(BoxQuery) - Method in interface edu.byu.hbll.box.client.BoxClient: Returns documents found according to the given query in the form of an Iterable.

G

getCursor() - Method in class edu.byu.hbll.box.BoxDocument: Returns the cursor.
getCursor() - Method in class edu.byu.hbll.box.BoxQuery: Returns the cursor.
getCursor(Instant) - Static method in class edu.byu.hbll.box.internal.util.CursorUtils: Returns the cursor for the given time.
getCursorOrDefault() - Method in class edu.byu.hbll.box.BoxQuery: Returns the cursor or the default cursor if cursor not set.
getDependencies() - Method in class edu.byu.hbll.box.BoxDocument: Returns the dependencies.
getDocument() - Method in class edu.byu.hbll.box.BoxDocument: Returns the internal document.
getDocuments() - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient.QueryResponse
getFacets() - Method in class edu.byu.hbll.box.BoxDocument: Returns the facets.
getFacets() - Method in class edu.byu.hbll.box.BoxQuery: Returns the specified facets.
getFacetValue(String) - Method in class edu.byu.hbll.box.BoxDocument: Returns the first value for the given facet.
getFacetValues(String) - Method in class edu.byu.hbll.box.BoxDocument: Returns all values for the given facet.
getFields() - Method in class edu.byu.hbll.box.BoxQuery: Returns the specified fields.
getGroupId() - Method in class edu.byu.hbll.box.BoxDocument: Returns the groupId.
getId() - Method in class edu.byu.hbll.box.BoxDocument: Returns the unique id of the document.
getId() - Method in class edu.byu.hbll.box.DocumentId: Returns the id.
getIds() - Method in class edu.byu.hbll.box.BoxQuery: Returns the specified ids.
getLimit() - Method in class edu.byu.hbll.box.BoxQuery: Returns the limit.
getLimitOrDefault() - Method in class edu.byu.hbll.box.BoxQuery: Returns the limit or the default limit if limit not set.
getMessage() - Method in class edu.byu.hbll.box.BoxDocument: Return the error message.
getModified() - Method in class edu.byu.hbll.box.BoxDocument: Returns the modified date.
getName() - Method in class edu.byu.hbll.box.Facet: Returns the name of the facet.
getNextCursor() - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient.QueryResponse
getNextCursor() - Method in class edu.byu.hbll.box.QueryResult: Returns the nextCursor.
getOffset() - Method in class edu.byu.hbll.box.BoxQuery: Returns the offset.
getOrder() - Method in class edu.byu.hbll.box.BoxQuery: Returns the sort order.
getOrderOrDefault() - Method in class edu.byu.hbll.box.BoxQuery: Returns the sort order.
getProcessed() - Method in class edu.byu.hbll.box.BoxDocument: Returns the processed date.
getSourceName() - Method in class edu.byu.hbll.box.DocumentId: Returns the source name.
getStatus() - Method in class edu.byu.hbll.box.BoxDocument: Returns the status.
getStatuses() - Method in class edu.byu.hbll.box.BoxQuery: Returns the specified statuses.
getStatusesOrDefault() - Method in class edu.byu.hbll.box.BoxQuery: Returns the statuses or the default statuses if none set.
getUri() - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient: Returns the base uri for the box.
getValue() - Method in class edu.byu.hbll.box.Facet: Returns the value of the facet.
group(Collection<Facet>) - Static method in class edu.byu.hbll.box.Facet: Utility method for grouping facets by name.

H

hasDifferentDependencies(BoxDocument) - Method in class edu.byu.hbll.box.BoxDocument: Whether or not this document's dependencies differ from the give document's.
hash() - Method in class edu.byu.hbll.box.BoxDocument: Hashes the document using SHA-256 including metadata, but excluding all volatile metadata fields (ie, cursor, modified, and processed).
hashCode() - Method in class edu.byu.hbll.box.BoxDocument
hashCode() - Method in class edu.byu.hbll.box.DocumentId
hashCode() - Method in class edu.byu.hbll.box.Facet
host(String) - Method in class edu.byu.hbll.box.internal.util.UriBuilder: Sets the host.
HttpBoxClient - Class in edu.byu.hbll.box.client: A client for communicating with Box through it's web api.
HttpBoxClient(URI) - Constructor for class edu.byu.hbll.box.client.HttpBoxClient: Creates a new HttpBoxClient with the given base uri.
HttpBoxClient(URI, HttpClient) - Constructor for class edu.byu.hbll.box.client.HttpBoxClient: Creates a new HttpBoxClient with the given base uri and client.
HttpBoxClient.HttpBoxClientBuilder - Class in edu.byu.hbll.box.client
HttpBoxClientBuilder() - Constructor for class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder

I

isAscendingOrder() - Method in class edu.byu.hbll.box.BoxQuery: Returns whether or not the order is ascending.
isDeleted() - Method in class edu.byu.hbll.box.BoxDocument: Whether or not this document is in the DELETED state.
isDescendingOrder() - Method in class edu.byu.hbll.box.BoxQuery: Returns whether or not the order is descending.
isError() - Method in class edu.byu.hbll.box.BoxDocument: Whether or not this document is in the ERROR state.
isHarvestQuery() - Method in class edu.byu.hbll.box.BoxQuery: Whether or not this is a harvest query rather than an ID query.
isIdQuery() - Method in class edu.byu.hbll.box.BoxQuery: Whether or not this is an ID query rather than harvest query.
isProcess() - Method in class edu.byu.hbll.box.BoxQuery: Whether or not to ask Box to (re)process the document now and return the result.
isProcessed() - Method in class edu.byu.hbll.box.BoxDocument: Whether or not this document's processing has completed.
isReady() - Method in class edu.byu.hbll.box.BoxDocument: Whether or not this document is in the READY state.
isUnprocessed() - Method in class edu.byu.hbll.box.BoxDocument: Whether or not this document is in the UNPROCESSED state.
isUnProcessed() - Method in class edu.byu.hbll.box.BoxDocument: Deprecated.
use BoxDocument.isUnprocessed() instead
isWait() - Method in class edu.byu.hbll.box.BoxQuery: Whether or not to wait for documents to be processed.
iterator() - Method in class edu.byu.hbll.box.internal.core.DocumentIterable

J

JsonUtils - Class in edu.byu.hbll.box.internal.util: Json utilities.
JsonUtils() - Constructor for class edu.byu.hbll.box.internal.util.JsonUtils

M

matches(Collection<Facet>) - Method in class edu.byu.hbll.box.BoxDocument: Determines if this document matches (or should be included in a result set) given the supplied facets.
matchesProjection(String, Collection<String>) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Tests whether or not the given field is part of the field projection denoted by the given fields.
METADATA_FIELD - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_CURSOR - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_DEPENDENCIES - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_FACETS - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_GROUP_ID - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_ID - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_MODIFIED - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_PROCESSED - Static variable in class edu.byu.hbll.box.BoxQuery
METADATA_FIELD_STATUS - Static variable in class edu.byu.hbll.box.BoxQuery

N

nextCursor() - Static method in class edu.byu.hbll.box.internal.util.CursorUtils: Generates a timestamp based long that can be used as cursor in a database.

O

oauth2(String, String, String) - Method in class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder: Initialize to use OAuth2.

P

parse(ObjectNode) - Static method in class edu.byu.hbll.box.BoxDocument: Creates a new box document from the given json.
parse(InputStream) - Static method in class edu.byu.hbll.box.BoxDocument: Creates a new box document from the given json.
parse(String) - Static method in class edu.byu.hbll.box.BoxDocument: Creates a new box document from the given json.
parse(String) - Static method in class edu.byu.hbll.box.Facet: Parses a facet value in the form of "NAME:VALUE".
parse(Collection<String>) - Static method in class edu.byu.hbll.box.Facet: Parses facet values in the form of "NAME:VALUE".
path(String) - Method in class edu.byu.hbll.box.internal.util.UriBuilder: Adds to the path.
port(int) - Method in class edu.byu.hbll.box.internal.util.UriBuilder: Sets the port.
project(JsonNode, Collection<String>) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Projects the given fields of the given node onto a new node.

Q

queryParam(String, Object...) - Method in class edu.byu.hbll.box.internal.util.UriBuilder: Adds query parameters to the uri.
QueryResponse() - Constructor for class edu.byu.hbll.box.client.AbstractHttpBoxClient.QueryResponse
QueryResult - Class in edu.byu.hbll.box: A response from a querying box.
QueryResult() - Constructor for class edu.byu.hbll.box.QueryResult: Constructs a new blank QueryResult.
QueryResult(Collection<? extends BoxDocument>) - Constructor for class edu.byu.hbll.box.QueryResult: Constructs a new QueryResult initialized with the given documents.

R

READY - edu.byu.hbll.box.BoxDocument.Status: The document has been processed and is ready to use.
retryDateTime(Instant, Duration, double) - Static method in class edu.byu.hbll.box.internal.util.BoxUtils: Calculates a retry date/time based on a base date/time (eg.

S

scheme(String) - Method in class edu.byu.hbll.box.internal.util.UriBuilder: Sets the scheme.
send(URI) - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient: Sends the request to the Box server and returns the response as an input stream.
send(URI) - Method in class edu.byu.hbll.box.client.HttpBoxClient
serialize(BoxDocument, JsonGenerator, SerializerProvider) - Method in class edu.byu.hbll.box.BoxDocument.Serializer
serialize(Object) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Serializes the document to a string.
Serializer() - Constructor for class edu.byu.hbll.box.BoxDocument.Serializer
Serializer(Class<BoxDocument>) - Constructor for class edu.byu.hbll.box.BoxDocument.Serializer
setAscendingOrder() - Method in class edu.byu.hbll.box.BoxQuery: Sets the order to be ascending (default).
setAsDeleted() - Method in class edu.byu.hbll.box.BoxDocument: Explicitly sets the status to deleted.
setAsError() - Method in class edu.byu.hbll.box.BoxDocument: Explicitly sets the status to error.
setAsError(String) - Method in class edu.byu.hbll.box.BoxDocument: Explicitly sets the status to error and includes an error message.
setAsReady() - Method in class edu.byu.hbll.box.BoxDocument: Explicitly sets the status to ready.
setAsUnprocessed() - Method in class edu.byu.hbll.box.BoxDocument: Explicitly sets the status to unprocessed.
setCursor(long) - Method in class edu.byu.hbll.box.BoxQuery: Sets the cursor.
setCursor(Long) - Method in class edu.byu.hbll.box.BoxDocument: Sets the cursor.
setCursor(Long) - Method in class edu.byu.hbll.box.BoxQuery: Sets the cursor.
setDependencies(Collection<? extends DocumentId>) - Method in class edu.byu.hbll.box.BoxDocument: Clears dependencies and then adds these dependencies for this document.
setDescendingOrder() - Method in class edu.byu.hbll.box.BoxQuery: Sets the order to be descending.
setDocument(ObjectNode) - Method in class edu.byu.hbll.box.BoxDocument: Sets the internal document and modifies the status to READY if state not explicitly set elsewhere.
setDocumentOnly() - Method in class edu.byu.hbll.box.BoxQuery: Clears any set fields and adds the document field.
setDocuments(List<BoxDocument>) - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient.QueryResponse
setFacets(Collection<? extends Facet>) - Method in class edu.byu.hbll.box.BoxDocument: Clears existing facets and then adds these facets to the document.
setFacets(Collection<? extends Facet>) - Method in class edu.byu.hbll.box.BoxQuery: Adds filter facets.
setFields(Collection<String>) - Method in class edu.byu.hbll.box.BoxQuery: Limit the document to only these fields.
setGroupId(String) - Method in class edu.byu.hbll.box.BoxDocument: Sets this document's group (used for orphan cleanup).
setId(String) - Method in class edu.byu.hbll.box.BoxDocument: Set the unique id of the document.
setLimit(long) - Method in class edu.byu.hbll.box.BoxQuery: Limits the number of documents returned to no more than this number.
setLimit(Long) - Method in class edu.byu.hbll.box.BoxQuery: Limits the number of documents returned to no more than this number.
setMessage(String) - Method in class edu.byu.hbll.box.BoxDocument: Sets the message if an error occurred.
setMetadataOnly() - Method in class edu.byu.hbll.box.BoxQuery: Clears any set fields and adds the box metadata field.
setModified(Instant) - Method in class edu.byu.hbll.box.BoxDocument: Sets the modified date.
setNextCursor(long) - Method in class edu.byu.hbll.box.client.AbstractHttpBoxClient.QueryResponse
setNextCursor(long) - Method in class edu.byu.hbll.box.QueryResult: Sets the next cursor.
setOffset(long) - Method in class edu.byu.hbll.box.BoxQuery: The number of documents to skip in the results set.
setOffset(Long) - Method in class edu.byu.hbll.box.BoxQuery: The number of documents to skip in the results set.
setOrder(BoxQuery.Order) - Method in class edu.byu.hbll.box.BoxQuery: Sets the sort order.
setProcess(Boolean) - Method in class edu.byu.hbll.box.BoxQuery: Whether or not to ask Box to (re)process the document now and return the result.
setProcessed(Instant) - Method in class edu.byu.hbll.box.BoxDocument: Sets the processed date.
setStatus(BoxDocument.Status) - Method in class edu.byu.hbll.box.BoxDocument: Explicitly sets the status.
setStatuses(Collection<BoxDocument.Status>) - Method in class edu.byu.hbll.box.BoxQuery: Sets statuses to be queried.
setUnlimited() - Method in class edu.byu.hbll.box.BoxQuery: Sets the limit to UNLIMITED.
setWait(Boolean) - Method in class edu.byu.hbll.box.BoxQuery: Whether or not to wait for Box to process the document before returning.
stream(BoxQuery) - Method in interface edu.byu.hbll.box.client.BoxClient: Returns documents found according to the given query in the form of a Stream.

T

toJson() - Method in class edu.byu.hbll.box.BoxDocument: Serializes to an ObjectNode.
toJson(Collection<String>) - Method in class edu.byu.hbll.box.BoxDocument: Returns the ObjectNode representation of this document with the given field projection applied.
toJsonNode(Object) - Static method in class edu.byu.hbll.box.internal.util.JsonUtils: Converts an object to a JsonNode.
toString() - Method in class edu.byu.hbll.box.BoxDocument
toString() - Method in class edu.byu.hbll.box.DocumentId: Returns a string representation of this.
toString() - Method in class edu.byu.hbll.box.Facet
toString(Collection<String>) - Method in class edu.byu.hbll.box.BoxDocument: Returns the string representation of this document with the given field projection applied.

U

UNLIMITED - Static variable in class edu.byu.hbll.box.BoxQuery
UNPROCESSED - edu.byu.hbll.box.BoxDocument.Status: The document is new and has not yet been processed.
updateNextCursor(BoxQuery) - Method in class edu.byu.hbll.box.QueryResult: Updates nextCursor according to the last document in the query result.
uri(String) - Method in class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder
uri(URI) - Method in class edu.byu.hbll.box.client.HttpBoxClient.HttpBoxClientBuilder
UriBuilder - Class in edu.byu.hbll.box.internal.util: A uri builder.
UriBuilder(String) - Constructor for class edu.byu.hbll.box.internal.util.UriBuilder: Creates a new UriBuilder based on the given uri.
UriBuilder(URI) - Constructor for class edu.byu.hbll.box.internal.util.UriBuilder: Creates a new UriBuilder based on the given uri.

V

validateName(String) - Static method in class edu.byu.hbll.box.Facet: Validates a facet group name.
valueOf(String) - Static method in enum edu.byu.hbll.box.BoxDocument.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum edu.byu.hbll.box.BoxQuery.Order: Returns the enum constant of this type with the specified name.
values() - Static method in enum edu.byu.hbll.box.BoxDocument.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum edu.byu.hbll.box.BoxQuery.Order: Returns an array containing the constants of this enum type, in the order they are declared.

W

withDocument() - Method in class edu.byu.hbll.box.BoxDocument: Sets the status to READY if state not explicitly set elsewhere and returns the internal document.

A B C D E F G H I J M N O P Q R S T U V W
All Classes All Packages