Package org.alfresco.service.cmr.repository

Class TransformationOptionLimits

  • All Implemented Interfaces:
    java.io.Serializable
    @AlfrescoPublicApi
public class TransformationOptionLimits
extends java.lang.Object
implements java.io.Serializable
    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

    • Constructor Detail

      • TransformationOptionLimits

        public TransformationOptionLimits()

    • Method Detail

      • defaultTo

        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.

        Parameters:
        limits - to be set

      • getTimeoutMs

        public long getTimeoutMs()

      • setTimeoutMs

        public void setTimeoutMs​(long timeoutMs)

      • getReadLimitTimeMs

        public long getReadLimitTimeMs()

      • setReadLimitTimeMs

        public void setReadLimitTimeMs​(long readLimitTimeMs)

      • getMaxSourceSizeKBytes

        public long getMaxSourceSizeKBytes()

      • setMaxSourceSizeKBytes

        public void setMaxSourceSizeKBytes​(long maxSourceSizeKBytes)

      • getReadLimitKBytes

        public long getReadLimitKBytes()

      • setReadLimitKBytes

        public void setReadLimitKBytes​(long readLimitKBytes)

      • getMaxPages

        public int getMaxPages()

      • setMaxPages

        public void setMaxPages​(int maxPages)

      • getPageLimit

        public int getPageLimit()

      • setPageLimit

        public void setPageLimit​(int pageLimit)

      • supported

        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.
        Returns:
        true if a transformation is possible.

      • toMap

        public java.util.Map<java.lang.String,​java.lang.Object> toMap​(java.util.Map<java.lang.String,​java.lang.Object> optionsMap)

      • removeFromMap

        public static java.util.Map<java.lang.String,​java.lang.Object> removeFromMap​(java.util.Map<java.lang.String,​java.lang.Object> optionsMap)

      • set

        public void set​(java.util.Map<java.lang.String,​java.lang.Object> optionsMap)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • combineUpper

        public 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 .

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object