org.alfresco.service.cmr.repository
Class TransformationOptionLimits

java.lang.Object
  extended by org.alfresco.service.cmr.repository.TransformationOptionLimits

public class TransformationOptionLimits
extends java.lang.Object

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.


Field Summary
static java.lang.String KBYTES_MESSAGE
           
static java.lang.String OPT_MAX_PAGES
           
static java.lang.String OPT_MAX_SOURCE_SIZE_K_BYTES
           
static java.lang.String OPT_PAGE_LIMIT
           
static java.lang.String OPT_READ_LIMIT_K_BYTES
           
static java.lang.String OPT_READ_LIMIT_TIME_MS
           
static java.lang.String OPT_TIMEOUT_MS
           
static java.lang.String PAGES_MESSAGE
           
static java.lang.String TIME_MESSAGE
           
 
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.
 boolean equals(java.lang.Object obj)
           
 TransformationOptionPair getKBytesPair()
           
 int getMaxPages()
           
 long getMaxSourceSizeKBytes()
           
 int getPageLimit()
           
 TransformationOptionPair getPagesPair()
           
 long getReadLimitKBytes()
           
 long getReadLimitTimeMs()
           
 long getTimeoutMs()
           
 TransformationOptionPair getTimePair()
           
 int hashCode()
           
static java.util.Map removeFromMap(java.util.Map optionsMap)
           
 void set(java.util.Map 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)
           
 java.util.Map toMap(java.util.Map optionsMap)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

OPT_TIMEOUT_MS

public static final java.lang.String OPT_TIMEOUT_MS
See Also:
Constant Field Values

OPT_READ_LIMIT_TIME_MS

public static final java.lang.String OPT_READ_LIMIT_TIME_MS
See Also:
Constant Field Values

OPT_MAX_SOURCE_SIZE_K_BYTES

public static final java.lang.String OPT_MAX_SOURCE_SIZE_K_BYTES
See Also:
Constant Field Values

OPT_READ_LIMIT_K_BYTES

public static final java.lang.String OPT_READ_LIMIT_K_BYTES
See Also:
Constant Field Values

OPT_MAX_PAGES

public static final java.lang.String OPT_MAX_PAGES
See Also:
Constant Field Values

OPT_PAGE_LIMIT

public static final java.lang.String OPT_PAGE_LIMIT
See Also:
Constant Field Values

TIME_MESSAGE

public static final java.lang.String TIME_MESSAGE
See Also:
Constant Field Values

KBYTES_MESSAGE

public static final java.lang.String KBYTES_MESSAGE
See Also:
Constant Field Values

PAGES_MESSAGE

public static final java.lang.String PAGES_MESSAGE
See Also:
Constant Field Values
Constructor Detail

TransformationOptionLimits

public TransformationOptionLimits()
Method Detail

getTimePair

public TransformationOptionPair getTimePair()

getTimeoutMs

public long getTimeoutMs()

setTimeoutMs

public void setTimeoutMs(long timeoutMs)

getReadLimitTimeMs

public long getReadLimitTimeMs()

setReadLimitTimeMs

public void setReadLimitTimeMs(long readLimitTimeMs)

getKBytesPair

public TransformationOptionPair getKBytesPair()

getMaxSourceSizeKBytes

public long getMaxSourceSizeKBytes()

setMaxSourceSizeKBytes

public void setMaxSourceSizeKBytes(long maxSourceSizeKBytes)

getReadLimitKBytes

public long getReadLimitKBytes()

setReadLimitKBytes

public void setReadLimitKBytes(long readLimitKBytes)

getPagesPair

public TransformationOptionPair getPagesPair()

getMaxPages

public int getMaxPages()

setMaxPages

public void setMaxPages(int maxPages)

getPageLimit

public int getPageLimit()

setPageLimit

public void setPageLimit(int pageLimit)

toMap

public java.util.Map toMap(java.util.Map optionsMap)

removeFromMap

public static java.util.Map removeFromMap(java.util.Map optionsMap)

set

public void set(java.util.Map optionsMap)

toString

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

combine

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


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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.