diff options
Diffstat (limited to 'libjava/java')
-rw-r--r-- | libjava/java/awt/font/TransformAttribute.java | 37 |
1 files changed, 32 insertions, 5 deletions
diff --git a/libjava/java/awt/font/TransformAttribute.java b/libjava/java/awt/font/TransformAttribute.java index b241704..3bb3c3c 100644 --- a/libjava/java/awt/font/TransformAttribute.java +++ b/libjava/java/awt/font/TransformAttribute.java @@ -1,5 +1,5 @@ -/* TransformAttribute.java - Copyright (C) 2003 Free Software Foundation, Inc. +/* TransformAttribute.java -- + Copyright (C) 2003, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. @@ -42,6 +42,13 @@ import java.awt.geom.AffineTransform; import java.io.Serializable; /** + * This class provides a mechanism for using an {@link AffineTransform} as + * an <i>immutable</i> attribute (for example, in the + * {@link java.text.AttributedString} class). Any transform passed to + * this class is copied before being stored, and any transform handed out + * by this class is a copy of the stored transform. In this way, it is + * not possible to modify the stored transform. + * * @author Michael Koch */ public final class TransformAttribute implements Serializable @@ -50,20 +57,40 @@ public final class TransformAttribute implements Serializable private AffineTransform affineTransform; + /** + * Creates a new attribute that contains a copy of the given transform. + * + * @param transform the transform (<code>null</code> not permitted). + * + * @throws IllegalArgumentException if <code>transform</code> is + * <code>null</code>. + */ public TransformAttribute (AffineTransform transform) { - if (transform != null) + if (transform == null) { - this.affineTransform = new AffineTransform (transform); + throw new IllegalArgumentException("Null 'transform' not permitted."); } + this.affineTransform = new AffineTransform (transform); } + /** + * Returns a copy of the transform contained by this attribute. + * + * @return A copy of the transform. + */ public AffineTransform getTransform () { - return affineTransform; + return (AffineTransform) affineTransform.clone(); } /** + * Returns <code>true</code> if the transform contained by this attribute is + * an identity transform, and <code>false</code> otherwise. + * + * @return <code>true</code> if the transform contained by this attribute is + * an identity transform, and <code>false</code> otherwise. + * * @since 1.4 */ public boolean isIdentity () |