This class represents image data which is stored in a pixel interleaved fashion and for which each sample of a pixel occupies one data element of the DataBuffer. It subclasses ComponentSampleModel but provides a more efficent implementation for accessing pixel interleaved image data than is provided by ComponentSampleModel. This class stores sample data for all bands in a single bank of the DataBuffer. Accessor methods are provided so that image data can be manipulated directly. Pixel stride is the number of data array elements between two samples for the same band on the same scanline. Scanline stride is the number of data array elements between a given sample and the corresponding sample in the same column of the next scanline. Band offsets denote the number of data array elements from the first data array element of the bank of the DataBuffer holding each band to the first sample of the band. The bands are numbered from 0 to N-1. Bank indices denote the correspondence between a bank of the data buffer and a band of image data. This class supports TYPE_BYTE , TYPE_USHORT , TYPE_SHORT , TYPE_INT , TYPE_FLOAT and TYPE_DOUBLE datatypes.
Constructs a PixelInterleavedSampleModel with the specified parameters. The number of bands will be given by the length of the bandOffsets array.
Parameters
dataTypeThe data type for storing samples.
wThe width (in pixels) of the region of image data described.
hThe height (in pixels) of the region of image data described.
pixelStrideThe pixel stride of the image data.
scanlineStrideThe line stride of the image data.
bandOffsetsThe offsets of all bands.
Throws
IllegalArgumentExceptionif w or h is not greater than 0
IllegalArgumentExceptionif any offset between bands is greater than the scanline stride
IllegalArgumentExceptionif the product of pixelStride and w is greater than scanlineStride
IllegalArgumentExceptionif pixelStride is less than any offset between bands
IllegalArgumentExceptionif dataType is not one of the supported data types
Creates a new PixelInterleavedSampleModel with the specified width and height. The new PixelInterleavedSampleModel will have the same number of bands, storage data type, and pixel stride as this PixelInterleavedSampleModel. The band offsets may be compressed such that the minimum of all of the band offsets is zero.
Parameters
wthe width of the resulting SampleModel
hthe height of the resulting SampleModel
Return
a new SampleModel with the specified width and height.
Throws
IllegalArgumentExceptionif w or h is not greater than 0
Creates a DataBuffer that corresponds to this ComponentSampleModel. The DataBuffer object's data type, number of banks, and size are be consistent with this ComponentSampleModel.
Return
a DataBuffer whose data type, number of banks and size are consistent with this ComponentSampleModel.
Creates a new PixelInterleavedSampleModel with a subset of the bands of this PixelInterleavedSampleModel. The new PixelInterleavedSampleModel can be used with any DataBuffer that the existing PixelInterleavedSampleModel can be used with. The new PixelInterleavedSampleModel/DataBuffer combination will represent an image with a subset of the bands of the original PixelInterleavedSampleModel/DataBuffer combination.
Returns the band offset for all bands.
Return
the band offsets for all bands.
Returns the bank indices for all bands.
Return
the bank indices for all bands.
Returns the runtime class of an object. That Class object is the object that is locked by static synchronized methods of the represented class.
Return
The java.lang.Class object that represents the runtime class of the object. The result is of type {@code Class} where X is the erasure of the static type of the expression on which getClass is called.
Returns the pixel data for the specified rectangle of pixels in a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data may be returned in a packed format, thus increasing efficiency for data transfers. Generally, obj should be passed in as null, so that the Object will be created automatically and will be of the right primitive data type.

The following code illustrates transferring data for a rectangular region of pixels from DataBuffer db1, whose storage layout is described by SampleModel sm1, to DataBuffer db2, whose storage layout is described by SampleModel sm2. The transfer will generally be more efficient than using getPixels/setPixels.

 	     SampleModel sm1, sm2;
	     DataBuffer db1, db2;
 	     sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w,
                           h, null, db1), db2);
 
Using getDataElements/setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModels have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

If obj is non-null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is non-null and is not large enough to hold the pixel data.

Parameters
xThe minimum X coordinate of the pixel rectangle.
yThe minimum Y coordinate of the pixel rectangle.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
objIf non-null, a primitive array in which to return the pixel data.
dataThe DataBuffer containing the image data.
Return
the data elements for the specified region of pixels.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if obj is too small to hold the output.
Returns data for a single pixel in a primitive array of type TransferType. For a ComponentSampleModel, this is the same as the data type, and samples are returned one per array element. Generally, obj should be passed in as null, so that the Object is created automatically and is the right primitive data type.

The following code illustrates transferring data for one pixel from DataBuffer db1, whose storage layout is described by ComponentSampleModel csm1, to DataBuffer db2, whose storage layout is described by ComponentSampleModel csm2. The transfer is usually more efficient than using getPixel and setPixel.

 	     ComponentSampleModel csm1, csm2;
	     DataBufferInt db1, db2;
 	     csm2.setDataElements(x, y,
                            csm1.getDataElements(x, y, null, db1), db2);
 
Using getDataElements and setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModel objects have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

If obj is not null, it should be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds, or if obj is not null and is not large enough to hold the pixel data.

Parameters
x, ythe coordinates of the pixel location
objif non-null, a primitive array in which to return the pixel data
datathe DataBuffer containing the image data
Return
the data of the specified pixel
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if obj is too small to hold the ouput.
Returns the data type of the DataBuffer storing the pixel data.
Return
the data type.
Returns the height in pixels.
Return
the height in pixels of the region of image data that this SampleModel describes.
Returns the total number of bands of image data.
Return
the number of bands of image data that this SampleModel describes.
Returns the number of data elements needed to transfer a pixel with the and methods. For a ComponentSampleModel, this is identical to the number of bands.
Return
the number of data elements needed to transfer a pixel with the getDataElements and setDataElements methods.
Gets the offset for the first band of pixel (x,y). A sample of the first band can be retrieved from a DataBuffer data with a ComponentSampleModel csm as
        data.getElem(csm.getOffset(x, y));
 
Parameters
x, ythe location of the pixel
Return
the offset for the first band of the specified pixel.
Gets the offset for band b of pixel (x,y). A sample of band b can be retrieved from a DataBuffer data with a ComponentSampleModel csm as
       data.getElem(csm.getOffset(x, y, b));
 
Parameters
x, ythe location of the specified pixel
bthe specified band
Return
the offset for the specified band of the specified pixel.
Returns the samples for the specified pixel in an array of double. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the pixel location.
yThe Y coordinate of the pixel location.
dArrayIf non-null, returns the samples in this array.
dataThe DataBuffer containing the image data.
Return
the samples for the specified pixel.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if dArray is too small to hold the output.
Returns the samples for the specified pixel in an array of float. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the pixel location.
yThe Y coordinate of the pixel location.
fArrayIf non-null, returns the samples in this array.
dataThe DataBuffer containing the image data.
Return
the samples for the specified pixel.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if fArray is too small to hold the output.
Returns all samples for the specified pixel in an int array, one sample per array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the pixel location
iArrayIf non-null, returns the samples in this array
dataThe DataBuffer containing the image data
Return
the samples of the specified pixel.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if iArray is too small to hold the output.
Returns all samples for a rectangle of pixels in a double array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
dArrayIf non-null, returns the samples in this array.
dataThe DataBuffer containing the image data.
Return
the samples for the specified region of pixels.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if dArray is too small to hold the output.
Returns all samples for a rectangle of pixels in a float array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
fArrayIf non-null, returns the samples in this array.
dataThe DataBuffer containing the image data.
Return
the samples for the specified region of pixels.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if fArray is too small to hold the output.
Returns all samples for the specified rectangle of pixels in an int array, one sample per array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, ythe coordinates of the upper left pixel location
wThe width of the pixel rectangle
hThe height of the pixel rectangle
iArrayIf non-null, returns the samples in this array
dataThe DataBuffer containing the image data
Return
the samples of the pixels within the specified region.
Returns the pixel stride of this ComponentSampleModel.
Return
the pixel stride of this ComponentSampleModel.
Returns as int the sample in a specified band for the pixel located at (x,y). An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, ythe coordinates of the pixel location
bthe band to return
datathe DataBuffer containing the image data
Return
the sample in a specified band for the specified pixel
Returns the sample in a specified band for a pixel located at (x,y) as a double. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the pixel location
bThe band to return
dataThe DataBuffer containing the image data
Return
a double value representing the sample in the specified band for the specified pixel.
Returns the sample in a specified band for the pixel located at (x,y) as a float. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the pixel location
bThe band to return
dataThe DataBuffer containing the image data
Return
a float value representing the sample in the specified band for the specified pixel.
Returns the samples for a specified band for a specified rectangle of pixels in a double array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
bThe band to return.
dArrayIf non-null, returns the samples in this array.
dataThe DataBuffer containing the image data.
Return
the samples for the specified band for the specified region of pixels.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates or the band index are not in bounds, or if dArray is too small to hold the output.
Returns the samples for a specified band for the specified rectangle of pixels in a float array, one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
bThe band to return.
fArrayIf non-null, returns the samples in this array.
dataThe DataBuffer containing the image data.
Return
the samples for the specified band for the specified region of pixels.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates or the band index are not in bounds, or if fArray is too small to hold the output.
Returns the samples in a specified band for the specified rectangle of pixels in an int array, one sample per data array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, ythe coordinates of the upper left pixel location
wthe width of the pixel rectangle
hthe height of the pixel rectangle
bthe band to return
iArrayif non-null, returns the samples in this array
datathe DataBuffer containing the image data
Return
the samples in the specified band of the specified pixel
Returns the number of bits per sample for all bands.
Return
an array containing the number of bits per sample for all bands, where each element in the array represents a band.
Returns the number of bits per sample for the specified band.
Parameters
bandthe specified band
Return
the number of bits per sample for the specified band.
Returns the scanline stride of this ComponentSampleModel.
Return
the scanline stride of this ComponentSampleModel.
Returns the TransferType used to transfer pixels via the getDataElements and setDataElements methods. When pixels are transferred via these methods, they may be transferred in a packed or unpacked format, depending on the implementation of the SampleModel. Using these methods, pixels are transferred as an array of getNumDataElements() elements of a primitive type given by getTransferType(). The TransferType may or may not be the same as the storage DataType. The TransferType will be one of the types defined in DataBuffer.
Returns the width in pixels.
Return
the width in pixels of the region of image data that this SampleModel describes.
Wakes up a single thread that is waiting on this object's monitor. If any threads are waiting on this object, one of them is chosen to be awakened. The choice is arbitrary and occurs at the discretion of the implementation. A thread waits on an object's monitor by calling one of the wait methods.

The awakened thread will not be able to proceed until the current thread relinquishes the lock on this object. The awakened thread will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened thread enjoys no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. A thread becomes the owner of the object's monitor in one of three ways:

  • By executing a synchronized instance method of that object.
  • By executing the body of a synchronized statement that synchronizes on the object.
  • For objects of type Class, by executing a synchronized static method of that class.

Only one thread at a time can own an object's monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
Wakes up all threads that are waiting on this object's monitor. A thread waits on an object's monitor by calling one of the wait methods.

The awakened threads will not be able to proceed until the current thread relinquishes the lock on this object. The awakened threads will compete in the usual manner with any other threads that might be actively competing to synchronize on this object; for example, the awakened threads enjoy no reliable privilege or disadvantage in being the next thread to lock this object.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Throws
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
Sets the data for a rectangle of pixels in the specified DataBuffer from a primitive array of type TransferType. For image data supported by the Java 2D API, this will be one of DataBuffer.TYPE_BYTE, DataBuffer.TYPE_USHORT, DataBuffer.TYPE_INT, DataBuffer.TYPE_SHORT, DataBuffer.TYPE_FLOAT, or DataBuffer.TYPE_DOUBLE. Data in the array may be in a packed format, thus increasing efficiency for data transfers.

The following code illustrates transferring data for a rectangular region of pixels from DataBuffer db1, whose storage layout is described by SampleModel sm1, to DataBuffer db2, whose storage layout is described by SampleModel sm2. The transfer will generally be more efficient than using getPixels/setPixels.

 	     SampleModel sm1, sm2;
	     DataBuffer db1, db2;
 	     sm2.setDataElements(x, y, w, h, sm1.getDataElements(x, y, w, h,
                           null, db1), db2);
 
Using getDataElements/setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModels have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

obj must be a primitive array of type TransferType. Otherwise, a ClassCastException is thrown. An ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds, or if obj is not large enough to hold the pixel data.

Parameters
xThe minimum X coordinate of the pixel rectangle.
yThe minimum Y coordinate of the pixel rectangle.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
objA primitive array containing pixel data.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if obj is too small to hold the input.
Sets the data for a single pixel in the specified DataBuffer from a primitive array of type TransferType. For a ComponentSampleModel, this is the same as the data type, and samples are transferred one per array element.

The following code illustrates transferring data for one pixel from DataBuffer db1, whose storage layout is described by ComponentSampleModel csm1, to DataBuffer db2, whose storage layout is described by ComponentSampleModel csm2. The transfer is usually more efficient than using getPixel and setPixel.

 	     ComponentSampleModel csm1, csm2;
	     DataBufferInt db1, db2;
 	     csm2.setDataElements(x, y, csm1.getDataElements(x, y, null, db1),
                            db2);
 
Using getDataElements and setDataElements to transfer between two DataBuffer/SampleModel pairs is legitimate if the SampleModel objects have the same number of bands, corresponding bands have the same number of bits per sample, and the TransferTypes are the same.

A ClassCastException is thrown if obj is not a primitive array of type TransferType. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds, or if obj is not large enough to hold the pixel data.

Parameters
x, ythe coordinates of the pixel location
obja primitive array containing pixel data
datathe DataBuffer containing the image data
Sets a pixel in the DataBuffer using a double array of samples for input.
Parameters
xThe X coordinate of the pixel location.
yThe Y coordinate of the pixel location.
dArrayThe input samples in a double array.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif dArray or data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if fArray is too small to hold the input.
Sets a pixel in the DataBuffer using a float array of samples for input. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the pixel location.
yThe Y coordinate of the pixel location.
fArrayThe input samples in a float array.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif fArray or data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if fArray is too small to hold the input.
Sets a pixel in the DataBuffer using an int array of samples for input. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the pixel location
iArrayThe input samples in an int array
dataThe DataBuffer containing the image data
Sets all samples for a rectangle of pixels from a double array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
dArrayThe input samples in a double array.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif dArray or data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if dArray is too small to hold the input.
Sets all samples for a rectangle of pixels from a float array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
fArrayThe input samples in a float array.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif fArray or data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates are not in bounds, or if fArray is too small to hold the input.
Sets all samples for a rectangle of pixels from an int array containing one sample per array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the upper left pixel location
wThe width of the pixel rectangle
hThe height of the pixel rectangle
iArrayThe input samples in an int array
dataThe DataBuffer containing the image data
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a double for input. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the pixel location
bThe band to set
sThe input sample as a double
dataThe DataBuffer containing the image data
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using a float for input. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the pixel location
bThe band to set
sThe input sample as a float
dataThe DataBuffer containing the image data
Sets a sample in the specified band for the pixel located at (x,y) in the DataBuffer using an int for input. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, ythe coordinates of the pixel location
bthe band to set
sthe input sample as an int
datathe DataBuffer containing the image data
Sets the samples in the specified band for the specified rectangle of pixels from a double array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
bThe band to set.
dArrayThe input samples in a double array.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif dArray or data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates or the band index are not in bounds, or if dArray is too small to hold the input.
Sets the samples in the specified band for the specified rectangle of pixels from a float array containing one sample per array element. ArrayIndexOutOfBoundsException may be thrown if the coordinates are not in bounds.
Parameters
xThe X coordinate of the upper left pixel location.
yThe Y coordinate of the upper left pixel location.
wThe width of the pixel rectangle.
hThe height of the pixel rectangle.
bThe band to set.
fArrayThe input samples in a float array.
dataThe DataBuffer containing the image data.
Throws
NullPointerExceptionif fArray or data is null.
ArrayIndexOutOfBoundsExceptionif the coordinates or the band index are not in bounds, or if fArray is too small to hold the input.
Sets the samples in the specified band for the specified rectangle of pixels from an int array containing one sample per data array element. An ArrayIndexOutOfBoundsException might be thrown if the coordinates are not in bounds.
Parameters
x, yThe coordinates of the upper left pixel location
wThe width of the pixel rectangle
hThe height of the pixel rectangle
bThe band to set
iArrayThe input samples in an int array
dataThe DataBuffer containing the image data
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 
Return
a string representation of the object.
Causes current thread to wait until another thread invokes the method or the method for this object. In other words, this method behaves exactly as if it simply performs the call wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method. The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait();
         ... // Perform action appropriate to condition
     }
 
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Throws
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Causes current thread to wait until either another thread invokes the method or the method for this object, or a specified amount of time has elapsed.

The current thread must own this object's monitor.

This method causes the current thread (call it T) to place itself in the wait set for this object and then to relinquish any and all synchronization claims on this object. Thread T becomes disabled for thread scheduling purposes and lies dormant until one of four things happens:

  • Some other thread invokes the notify method for this object and thread T happens to be arbitrarily chosen as the thread to be awakened.
  • Some other thread invokes the notifyAll method for this object.
  • Some other thread interrupts thread T.
  • The specified amount of real time has elapsed, more or less. If timeout is zero, however, then real time is not taken into consideration and the thread simply waits until notified.
The thread T is then removed from the wait set for this object and re-enabled for thread scheduling. It then competes in the usual manner with other threads for the right to synchronize on the object; once it has gained control of the object, all its synchronization claims on the object are restored to the status quo ante - that is, to the situation as of the time that the wait method was invoked. Thread T then returns from the invocation of the wait method. Thus, on return from the wait method, the synchronization state of the object and of thread T is exactly as it was when the wait method was invoked.

A thread can also wake up without being notified, interrupted, or timing out, a so-called spurious wakeup. While this will rarely occur in practice, applications must guard against it by testing for the condition that should have caused the thread to be awakened, and continuing to wait if the condition is not satisfied. In other words, waits should always occur in loops, like this one:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout);
         ... // Perform action appropriate to condition
     }
 
(For more information on this topic, see Section 3.2.3 in Doug Lea's "Concurrent Programming in Java (Second Edition)" (Addison-Wesley, 2000), or Item 50 in Joshua Bloch's "Effective Java Programming Language Guide" (Addison-Wesley, 2001).

If the current thread is interrupted by another thread while it is waiting, then an InterruptedException is thrown. This exception is not thrown until the lock status of this object has been restored as described above.

Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits.

This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.

Parameters
timeoutthe maximum time to wait in milliseconds.
Throws
IllegalArgumentExceptionif the value of timeout is negative.
IllegalMonitorStateExceptionif the current thread is not the owner of the object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.
Causes current thread to wait until another thread invokes the method or the method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.

This method is similar to the wait method of one argument, but it allows finer control over the amount of time to wait for a notification before giving up. The amount of real time, measured in nanoseconds, is given by:

 1000000*timeout+nanos

In all other respects, this method does the same thing as the method of one argument. In particular, wait(0, 0) means the same thing as wait(0).

The current thread must own this object's monitor. The thread releases ownership of this monitor and waits until either of the following two conditions has occurred:

  • Another thread notifies threads waiting on this object's monitor to wake up either through a call to the notify method or the notifyAll method.
  • The timeout period, specified by timeout milliseconds plus nanos nanoseconds arguments, has elapsed.

The thread then waits until it can re-obtain ownership of the monitor and resumes execution.

As in the one argument version, interrupts and spurious wakeups are possible, and this method should always be used in a loop:

     synchronized (obj) {
         while (<condition does not hold>)
             obj.wait(timeout, nanos);
         ... // Perform action appropriate to condition
     }
 
This method should only be called by a thread that is the owner of this object's monitor. See the notify method for a description of the ways in which a thread can become the owner of a monitor.
Parameters
timeoutthe maximum time to wait in milliseconds.
nanosadditional time, in nanoseconds range 0-999999.
Throws
IllegalArgumentExceptionif the value of timeout is negative or the value of nanos is not in the range 0-999999.
IllegalMonitorStateExceptionif the current thread is not the owner of this object's monitor.
InterruptedExceptionif another thread interrupted the current thread before or while the current thread was waiting for a notification. The interrupted status of the current thread is cleared when this exception is thrown.