cz.ues.platform.udds

Class UESObjectListingCriteria

java.lang.Object

cz.ues.platform.udds.UESObjectListingCriteria

public class UESObjectListingCriteria
extends java.lang.Object

Contains options to return a list of summary information about the objects in the specified bucket. Depending on the criteria parameters, additional information is returned, such as common prefixes if a delimiter was specified. List results are always returned in lexicographic (alphabetical) order.

Since:

UES6-06

See Also:

UESStorageService.getObjectList(String, UESObjectListingCriteria)

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	delimiter The delimiter for condensing common prefixes in the returned listing results.
private java.lang.String	marker The object ID marker indicating where listing results should begin.
static int	MAX_PAGE_SIZE Maximal count of objects returned at once (i.e. as one page).
private int	pageSize The maximum number of results to return.
private java.lang.String	prefix The prefix restricting what object IDs will be listed.

Constructor Summary

Constructors

Constructor and Description
UESObjectListingCriteria() Creates a new instance of UESObjectListingCriteria.
UESObjectListingCriteria(java.lang.String prefix, java.lang.String marker, java.lang.String delimiter, int pageSize) Creates a new instance of UESObjectListingCriteria and initializes all required and optional object fields.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDelimiter() Getter for property delimiter.
java.lang.String	getMarker() Getter for property marker.
int	getPageSize() Getter for property pageSize.
java.lang.String	getPrefix() Getter for property prefix.
void	setDelimiter(java.lang.String delimiter) Setter for property delimiter.
void	setMarker(java.lang.String marker) Setter for property marker.
void	setPageSize(int pageSize) Setter for property pageSize.
void	setPrefix(java.lang.String prefix) Setter for property prefix.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_PAGE_SIZE

public static final MAX_PAGE_SIZE

Maximal count of objects returned at once (i.e. as one page).

Since:

UES6-06

See Also:

Constant Field Values

prefix

private prefix

The prefix restricting what object IDs will be listed.

Since:

UES6-06

marker

private marker

The object ID marker indicating where listing results should begin.

Since:

UES6-06

delimiter

private delimiter

The delimiter for condensing common prefixes in the returned listing results.

Since:

UES6-06

pageSize

private pageSize

The maximum number of results to return. Value -1 represents undefined listing length.

Since:

UES6-06

Constructor Detail

UESObjectListingCriteria

public UESObjectListingCriteria()

Creates a new instance of UESObjectListingCriteria. The caller must populate the object fields before the criteria is ready to be applied.

Since:

UES6-06

UESObjectListingCriteria

public UESObjectListingCriteria(java.lang.String prefix,
java.lang.String marker,
java.lang.String delimiter,
int pageSize)

Creates a new instance of UESObjectListingCriteria and initializes all required and optional object fields.

Parameters:

prefix - The prefix restricting what object IDs will be listed.

marker - The object ID marker indicating where listing results should begin.

delimiter - The delimiter for condensing common prefixes in the returned listing results.

pageSize - The maximum number of results to return at once.

Since:

UES6-06

Method Detail

getPrefix

public java.lang.String getPrefix()

Getter for property prefix.

Returns:

the prefix

Since:

UES6-06

setPrefix

public void setPrefix(java.lang.String prefix)

Setter for property prefix.

Parameters:

prefix - the prefix to set

Since:

UES6-06

getMarker

public java.lang.String getMarker()

Getter for property marker.

Returns:

the marker

Since:

UES6-06

setMarker

public void setMarker(java.lang.String marker)

Setter for property marker.

Parameters:

marker - the marker to set

Since:

UES6-06

getDelimiter

public java.lang.String getDelimiter()

Getter for property delimiter.

Returns:

the delimiter

Since:

UES6-06

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Setter for property delimiter.

Parameters:

delimiter - the delimiter to set

Since:

UES6-06

getPageSize

public int getPageSize()

Getter for property pageSize.

Returns:

the pageSize

Since:

UES6-06

setPageSize

public void setPageSize(int pageSize)

Setter for property pageSize.

Parameters:

pageSize - the pageSize to set

Since:

UES6-06

See Also:

UESObjectListingCriteria.MAX_PAGE_SIZE