TransformationOptionLimits (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.repository

Class TransformationOptionLimits

org.alfresco.service.cmr.repository.TransformationOptionLimits

All Implemented Interfaces:

public class TransformationOptionLimits

Represents maximum source values (that result in exceptions if exceeded) or limits on source values (that result in EOF (End Of File) being returned early). Options exist for elapse time, KBytes read or number of pages read.

Constructor Summary
TransformationOptionLimits()

Method Summary
TransformationOptionLimits	combine(TransformationOptionLimits that) Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits.
TransformationOptionLimits	combineUpper(TransformationOptionLimits that) Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits so that they return the lowest common denominator of the limits .
void	defaultTo(TransformationOptionLimits limits) This method overrides rather than defaults values into the supplied limits (as the name might suggest), but because of the order in which it is called, this results in the correct defaults being set.
boolean	equals(Object obj)
TransformationOptionPair	getKBytesPair()
int	getMaxPages()
long	getMaxSourceSizeKBytes()
int	getPageLimit()
TransformationOptionPair	getPagesPair()
long	getReadLimitKBytes()
long	getReadLimitTimeMs()
long	getTimeoutMs()
TransformationOptionPair	getTimePair()
int	hashCode()
static Map<String,Object>	removeFromMap(Map<String,Object> optionsMap)
void	set(Map<String,Object> optionsMap)
void	setMaxPages(int maxPages)
void	setMaxSourceSizeKBytes(long maxSourceSizeKBytes)
void	setPageLimit(int pageLimit)
void	setReadLimitKBytes(long readLimitKBytes)
void	setReadLimitTimeMs(long readLimitTimeMs)
void	setTimeoutMs(long timeoutMs)
boolean	supported() Indicates if the limits allow a transformation to take place at all.
Map<String,Object>	toMap(Map<String,Object> optionsMap)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

public static final String KBYTES_MESSAGE

public static final String OPT_MAX_PAGES

OPT_MAX_SOURCE_SIZE_K_BYTES

public static final String OPT_MAX_SOURCE_SIZE_K_BYTES

public static final String OPT_PAGE_LIMIT

OPT_READ_LIMIT_K_BYTES

public static final String OPT_READ_LIMIT_K_BYTES

OPT_READ_LIMIT_TIME_MS

public static final String OPT_READ_LIMIT_TIME_MS

public static final String OPT_TIMEOUT_MS

public static final String PAGES_MESSAGE

public static final String TIME_MESSAGE

TransformationOptionLimits

public TransformationOptionLimits()

public void defaultTo(TransformationOptionLimits limits)

This method overrides rather than defaults values into the supplied limits (as the name might suggest), but because of the order in which it is called, this results in the correct defaults being set.

A call to this method overrides any values in the supplied limits parameter with those in this Object. The supplied limits parameter is being gradually built up by initially setting the most general limits and then more specific values for each level. As a result 'default' values from the more general levels will still exist at the end if more specific ones have not been supplied.

public TransformationOptionPair getTimePair()

public long getTimeoutMs()

public void setTimeoutMs(long timeoutMs)

public long getReadLimitTimeMs()

public void setReadLimitTimeMs(long readLimitTimeMs)

public TransformationOptionPair getKBytesPair()

getMaxSourceSizeKBytes

public long getMaxSourceSizeKBytes()

setMaxSourceSizeKBytes

public void setMaxSourceSizeKBytes(long maxSourceSizeKBytes)

public long getReadLimitKBytes()

public void setReadLimitKBytes(long readLimitKBytes)

public TransformationOptionPair getPagesPair()

public int getMaxPages()

public void setMaxPages(int maxPages)

public int getPageLimit()

public void setPageLimit(int pageLimit)

public boolean supported()

Indicates if the limits allow a transformation to take place at all. If any of the limits are 0, it would not be possible.

true if a transformation is possible.

public Map<String,Object> toMap(Map<String,Object> optionsMap)

public static Map<String,Object> removeFromMap(Map<String,Object> optionsMap)

public void set(Map<String,Object> optionsMap)

public String toString()

toString in class Object

Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits.

Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits so that they return the lowest common denominator of the limits .

public int hashCode()

hashCode in class Object

public boolean equals(Object obj)

equals in class Object

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.

Field Summary
static String	KBYTES_MESSAGE
static String	OPT_MAX_PAGES
static String	OPT_MAX_SOURCE_SIZE_K_BYTES
static String	OPT_PAGE_LIMIT
static String	OPT_READ_LIMIT_K_BYTES
static String	OPT_READ_LIMIT_TIME_MS
static String	OPT_TIMEOUT_MS
static String	PAGES_MESSAGE
static String	TIME_MESSAGE