Class TransformationOptionLimits
- java.lang.Object
-
- org.alfresco.service.cmr.repository.TransformationOptionLimits
-
- All Implemented Interfaces:
Serializable
@AlfrescoPublicApi @Deprecated public class TransformationOptionLimits extends Object implements Serializable
Deprecated.with the introduction of RenditionService2 the OPT_... public static final values have been deprecated as they will no longer form part of the rendition definition and will be removed when local transformations are removed.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.- Author:
- Alan Davis
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static StringKBYTES_MESSAGEDeprecated.static StringOPT_MAX_PAGESDeprecated.static StringOPT_MAX_SOURCE_SIZE_K_BYTESDeprecated.static StringOPT_PAGE_LIMITDeprecated.static StringOPT_READ_LIMIT_K_BYTESDeprecated.static StringOPT_READ_LIMIT_TIME_MSDeprecated.static StringOPT_TIMEOUT_MSDeprecated.static StringPAGES_MESSAGEDeprecated.static StringTIME_MESSAGEDeprecated.
-
Constructor Summary
Constructors Constructor Description TransformationOptionLimits()Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TransformationOptionLimitscombine(TransformationOptionLimits that)Deprecated.Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits.TransformationOptionLimitscombineUpper(TransformationOptionLimits that)Deprecated.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 .voiddefaultTo(TransformationOptionLimits limits)Deprecated.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.booleanequals(Object obj)Deprecated.TransformationOptionPairgetKBytesPair()Deprecated.intgetMaxPages()Deprecated.longgetMaxSourceSizeKBytes()Deprecated.intgetPageLimit()Deprecated.TransformationOptionPairgetPagesPair()Deprecated.longgetReadLimitKBytes()Deprecated.longgetReadLimitTimeMs()Deprecated.longgetTimeoutMs()Deprecated.TransformationOptionPairgetTimePair()Deprecated.inthashCode()Deprecated.static Map<String,Object>removeFromMap(Map<String,Object> optionsMap)Deprecated.voidset(Map<String,Object> optionsMap)Deprecated.voidsetMaxPages(int maxPages)Deprecated.voidsetMaxSourceSizeKBytes(long maxSourceSizeKBytes)Deprecated.voidsetPageLimit(int pageLimit)Deprecated.voidsetReadLimitKBytes(long readLimitKBytes)Deprecated.voidsetReadLimitTimeMs(long readLimitTimeMs)Deprecated.voidsetTimeoutMs(long timeoutMs)Deprecated.booleansupported()Deprecated.Indicates if the limits allow a transformation to take place at all.Map<String,Object>toMap(Map<String,Object> optionsMap)Deprecated.StringtoString()Deprecated.
-
-
-
Field Detail
-
OPT_TIMEOUT_MS
@Deprecated public static final String OPT_TIMEOUT_MS
Deprecated.- See Also:
- Constant Field Values
-
OPT_READ_LIMIT_TIME_MS
@Deprecated public static final String OPT_READ_LIMIT_TIME_MS
Deprecated.- See Also:
- Constant Field Values
-
OPT_MAX_SOURCE_SIZE_K_BYTES
@Deprecated public static final String OPT_MAX_SOURCE_SIZE_K_BYTES
Deprecated.- See Also:
- Constant Field Values
-
OPT_READ_LIMIT_K_BYTES
@Deprecated public static final String OPT_READ_LIMIT_K_BYTES
Deprecated.- See Also:
- Constant Field Values
-
OPT_MAX_PAGES
@Deprecated public static final String OPT_MAX_PAGES
Deprecated.- See Also:
- Constant Field Values
-
OPT_PAGE_LIMIT
@Deprecated public static final String OPT_PAGE_LIMIT
Deprecated.- See Also:
- Constant Field Values
-
TIME_MESSAGE
public static final String TIME_MESSAGE
Deprecated.- See Also:
- Constant Field Values
-
KBYTES_MESSAGE
public static final String KBYTES_MESSAGE
Deprecated.- See Also:
- Constant Field Values
-
PAGES_MESSAGE
public static final String PAGES_MESSAGE
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
defaultTo
public void defaultTo(TransformationOptionLimits limits)
Deprecated.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.
- Parameters:
limits- to be set
-
getTimePair
public TransformationOptionPair getTimePair()
Deprecated.
-
getTimeoutMs
public long getTimeoutMs()
Deprecated.
-
setTimeoutMs
public void setTimeoutMs(long timeoutMs)
Deprecated.
-
getReadLimitTimeMs
public long getReadLimitTimeMs()
Deprecated.
-
setReadLimitTimeMs
public void setReadLimitTimeMs(long readLimitTimeMs)
Deprecated.
-
getKBytesPair
public TransformationOptionPair getKBytesPair()
Deprecated.
-
getMaxSourceSizeKBytes
public long getMaxSourceSizeKBytes()
Deprecated.
-
setMaxSourceSizeKBytes
public void setMaxSourceSizeKBytes(long maxSourceSizeKBytes)
Deprecated.
-
getReadLimitKBytes
public long getReadLimitKBytes()
Deprecated.
-
setReadLimitKBytes
public void setReadLimitKBytes(long readLimitKBytes)
Deprecated.
-
getPagesPair
public TransformationOptionPair getPagesPair()
Deprecated.
-
getMaxPages
public int getMaxPages()
Deprecated.
-
setMaxPages
public void setMaxPages(int maxPages)
Deprecated.
-
getPageLimit
public int getPageLimit()
Deprecated.
-
setPageLimit
public void setPageLimit(int pageLimit)
Deprecated.
-
supported
public boolean supported()
Deprecated.Indicates if the limits allow a transformation to take place at all. If any of the limits are 0, it would not be possible.- Returns:
- true if a transformation is possible.
-
removeFromMap
public static Map<String,Object> removeFromMap(Map<String,Object> optionsMap)
Deprecated.
-
combine
public TransformationOptionLimits combine(TransformationOptionLimits that)
Deprecated.Returns a TransformationOptionLimits that has getter methods that combine the the values from the getter methods of this and the supplied TransformationOptionLimits.
-
combineUpper
public TransformationOptionLimits combineUpper(TransformationOptionLimits that)
Deprecated.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 .
-
-