ImageCapabilities.java: Document.

2005-05-04  Thomas Fitzsimmons  <fitzsim@redhat.com>

	* java/awt/ImageCapabilities.java: Document.

	* java/awt/image/VolatileImage.java: Unindent copyright header.

From-SVN: r99224
This commit is contained in:
Thomas Fitzsimmons 2005-05-04 18:25:37 +00:00 committed by Thomas Fitzsimmons
parent 1351ec8243
commit d1ca2cfe44
3 changed files with 78 additions and 35 deletions

View file

@ -1,3 +1,9 @@
2005-05-04 Thomas Fitzsimmons <fitzsim@redhat.com>
* java/awt/ImageCapabilities.java: Document.
* java/awt/image/VolatileImage.java: Unindent copyright header.
2005-05-03 Thomas Fitzsimmons <fitzsim@redhat.com> 2005-05-03 Thomas Fitzsimmons <fitzsim@redhat.com>
* java/awt/image/VolatileImage.java: Document. * java/awt/image/VolatileImage.java: Document.

View file

@ -1,5 +1,5 @@
/* ImageCapabilities.java -- /* ImageCapabilities.java -- the capabilities of an image buffer
Copyright (C) 2002 Free Software Foundation, Inc. Copyright (C) 2002, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath. This file is part of GNU Classpath.
@ -39,23 +39,60 @@ exception statement from your version. */
package java.awt; package java.awt;
/** /**
* STUBS ONLY * This class represents the capabilities of an image buffer. An
* image buffer may be backed by accelerated graphics resources.
* Those resources may or may not be volatile. This class is used to
* describe these image buffer characteristics.
*/ */
public class ImageCapabilities implements Cloneable public class ImageCapabilities implements Cloneable
{ {
/**
* Whether or not this the image buffer uses accelerated graphics
* resources.
*/
private final boolean accelerated; private final boolean accelerated;
/**
* Create a new image capability descriptor.
*
* @param accelerated true if the image buffer uses accelerated
* graphics resources
*/
public ImageCapabilities(boolean accelerated) public ImageCapabilities(boolean accelerated)
{ {
this.accelerated = accelerated; this.accelerated = accelerated;
} }
/**
* Returns whether or not the image buffer uses accelerated graphics
* resources.
*
* @return true if the image buffer uses accelerated graphics
* resources; false otherwise
*/
public boolean isAccelerated() public boolean isAccelerated()
{ {
return accelerated; return accelerated;
} }
/**
* Returns whether or not the image buffer's resources are volatile,
* meaning that they can be reclaimed by the graphics system at any
* time.
*
* @return true if the image buffer's resources are volatile; false
* otherwise
*/
public boolean isTrueVolatile() public boolean isTrueVolatile()
{ {
return true; return true;
} }
/**
* Clone this image capability descriptor.
*
* @return a clone of this image capability descriptor
*/
public Object clone() public Object clone()
{ {
try try
@ -64,7 +101,7 @@ public class ImageCapabilities implements Cloneable
} }
catch (CloneNotSupportedException e) catch (CloneNotSupportedException e)
{ {
throw (Error) new InternalError().initCause(e); // Impossible throw (Error) new InternalError().initCause(e);
}
} }
} }
} // class ImageCapabilities

View file

@ -152,7 +152,7 @@ public abstract class VolatileImage extends Image
* VolatileImages are typically optimized for writing. * VolatileImages are typically optimized for writing.
* *
* @return an ImageProducer for a static BufferedImage snapshot of * @return an ImageProducer for a static BufferedImage snapshot of
* this image buffer. * this image buffer
*/ */
public ImageProducer getSource() public ImageProducer getSource()
{ {
@ -245,7 +245,7 @@ public abstract class VolatileImage extends Image
* Returns the transparency type of this image. * Returns the transparency type of this image.
* *
* @return Transparency.OPAQUE, Transparency.BITMASK or * @return Transparency.OPAQUE, Transparency.BITMASK or
* Transparency.TRANSLUCENT. * Transparency.TRANSLUCENT
*/ */
public int getTransparency() public int getTransparency()
{ {