A pair of transformation options that specify A) a max value over which the source is not read (throws an Exception) or B) a limit over which no more of the source is read (returns EOF) Each pair represents a values such as an elapse time, KBytes read or number of pages read. It is only meaningful for a either the max or limit value to be set. There is one pair of values for each transformer and another pair passed in via the options parameter for each individual transformation. The later is for specific types of transformation, such as thumbnail generation. When this occurs values are combined, by using the lowest of the four values.

Nested Class Summary
static enum	TransformationOptionPair.Action           Action to take place for a given pair of values.

Constructor Summary

TransformationOptionPair()

Method Summary
void	append(StringBuilder sb, String optMaxKey, String optLimitKey)
TransformationOptionPair	combine(TransformationOptionPair that)           Returns a TransformationOptionPair that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionPair.
TransformationOptionPair	combineUpper(TransformationOptionPair that)           Returns a TransformationOptionPair that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionPair so that they return the lowest common denominator of the two limits .
void	defaultTo(TransformationOptionPair pair)            This method overrides rather than defaults values into the supplied pair (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.Action	getAction()
long	getLimit()
long	getMax()
long	getValue()
int	hashCode()
void	set(Map<String,Object> optionsMap, String optMaxKey, String optLimitKey, String exceptionMessage)
void	setLimit(long limit, String exceptionMessage)
void	setMax(long max, String exceptionMessage)
boolean	supported()           Indicates if the limit allows a transformation to take place at all.
Map<String,Object>	toMap(Map<String,Object> optionsMap, String optMaxKey, String optLimitKey)
String	toString(String max, String limit)

Methods inherited from class java.lang.Object

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

Constructor Detail

Method Detail