Class ThresholdingOutputStream
java.lang.Object
java.io.OutputStream
org.apache.tomcat.util.http.fileupload.ThresholdingOutputStream
- All Implemented Interfaces:
- Closeable,- Flushable,- AutoCloseable
- Direct Known Subclasses:
- DeferredFileOutputStream
An output stream which triggers an event when a specified number of bytes of
 data have been written to it. The event can be used, for example, to throw
 an exception if a maximum has been reached, or to switch the underlying
 stream type when the threshold is exceeded.
 
 This class overrides all OutputStream methods. However, these
 overrides ultimately call the corresponding methods in the underlying output
 stream implementation.
 
NOTE: This implementation may trigger the event before the threshold is actually reached, since it triggers when a pending write operation would cause the threshold to be exceeded.
- 
Constructor SummaryConstructorsConstructorDescriptionThresholdingOutputStream(int threshold) Constructs an instance of this class which will trigger an event at the specified threshold.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidcheckThreshold(int count) Checks to see if writing the specified number of bytes would cause the configured threshold to be exceeded.voidclose()Closes this output stream and releases any system resources associated with this stream.voidflush()Flushes this output stream and forces any buffered output bytes to be written out.protected abstract OutputStreamReturns the underlying output stream, to which the correspondingOutputStreammethods in this class will ultimately delegate.booleanDetermines whether or not the configured threshold has been exceeded for this output stream.protected abstract voidIndicates that the configured threshold has been reached, and that a subclass should take whatever action necessary on this event.voidwrite(byte[] b) Writesb.lengthbytes from the specified byte array to this output stream.voidwrite(byte[] b, int off, int len) Writeslenbytes from the specified byte array starting at offsetoffto this output stream.voidwrite(int b) Writes the specified byte to this output stream.Methods inherited from class java.io.OutputStreamnullOutputStream
- 
Constructor Details- 
ThresholdingOutputStreampublic ThresholdingOutputStream(int threshold) Constructs an instance of this class which will trigger an event at the specified threshold.- Parameters:
- threshold- The number of bytes at which to trigger an event.
 
 
- 
- 
Method Details- 
writeWrites the specified byte to this output stream.- Specified by:
- writein class- OutputStream
- Parameters:
- b- The byte to be written.
- Throws:
- IOException- if an error occurs.
 
- 
writeWritesb.lengthbytes from the specified byte array to this output stream.- Overrides:
- writein class- OutputStream
- Parameters:
- b- The array of bytes to be written.
- Throws:
- IOException- if an error occurs.
 
- 
writeWriteslenbytes from the specified byte array starting at offsetoffto this output stream.- Overrides:
- writein class- OutputStream
- Parameters:
- b- The byte array from which the data will be written.
- off- The start offset in the byte array.
- len- The number of bytes to write.
- Throws:
- IOException- if an error occurs.
 
- 
flushFlushes this output stream and forces any buffered output bytes to be written out.- Specified by:
- flushin interface- Flushable
- Overrides:
- flushin class- OutputStream
- Throws:
- IOException- if an error occurs.
 
- 
closeCloses this output stream and releases any system resources associated with this stream.- Specified by:
- closein interface- AutoCloseable
- Specified by:
- closein interface- Closeable
- Overrides:
- closein class- OutputStream
- Throws:
- IOException- if an error occurs.
 
- 
isThresholdExceededpublic boolean isThresholdExceeded()Determines whether or not the configured threshold has been exceeded for this output stream.- Returns:
- trueif the threshold has been reached;- falseotherwise.
 
- 
checkThresholdChecks to see if writing the specified number of bytes would cause the configured threshold to be exceeded. If so, triggers an event to allow a concrete implementation to take action on this.- Parameters:
- count- The number of bytes about to be written to the underlying output stream.
- Throws:
- IOException- if an error occurs.
 
- 
getStreamReturns the underlying output stream, to which the correspondingOutputStreammethods in this class will ultimately delegate.- Returns:
- The underlying output stream.
- Throws:
- IOException- if an error occurs.
 
- 
thresholdReachedIndicates that the configured threshold has been reached, and that a subclass should take whatever action necessary on this event. This may include changing the underlying output stream.- Throws:
- IOException- if an error occurs.
 
 
-