< prev index next >
src/java.desktop/share/classes/java/awt/image/renderable/ParameterBlock.java
Print this page
@@ -27,33 +27,33 @@
import java.awt.image.RenderedImage;
import java.io.Serializable;
import java.util.Vector;
/**
- * A <code>ParameterBlock</code> encapsulates all the information about sources and
+ * A {@code ParameterBlock} encapsulates all the information about sources and
* parameters (Objects) required by a RenderableImageOp, or other
* classes that process images.
*
* <p> Although it is possible to place arbitrary objects in the
* source Vector, users of this class may impose semantic constraints
* such as requiring all sources to be RenderedImages or
- * RenderableImage. <code>ParameterBlock</code> itself is merely a container and
+ * RenderableImage. {@code ParameterBlock} itself is merely a container and
* performs no checking on source or parameter types.
*
- * <p> All parameters in a <code>ParameterBlock</code> are objects; convenience
+ * <p> All parameters in a {@code ParameterBlock} are objects; convenience
* add and set methods are available that take arguments of base type and
* construct the appropriate subclass of Number (such as
* Integer or Float). Corresponding get methods perform a
* downward cast and have return values of base type; an exception
* will be thrown if the stored values do not have the correct type.
* There is no way to distinguish between the results of
* "short s; add(s)" and "add(new Short(s))".
*
* <p> Note that the get and set methods operate on references.
* Therefore, one must be careful not to share references between
- * <code>ParameterBlock</code>s when this is inappropriate. For example, to create
- * a new <code>ParameterBlock</code> that is equal to an old one except for an
+ * {@code ParameterBlock}s when this is inappropriate. For example, to create
+ * a new {@code ParameterBlock} that is equal to an old one except for an
* added source, one might be tempted to write:
*
* <pre>
* ParameterBlock addSource(ParameterBlock pb, RenderableImage im) {
* ParameterBlock pb1 = new ParameterBlock(pb.getSources());
@@ -61,11 +61,11 @@
* return pb1;
* }
* </pre>
*
* <p> This code will have the side effect of altering the original
- * <code>ParameterBlock</code>, since the getSources operation returned a reference
+ * {@code ParameterBlock}, since the getSources operation returned a reference
* to its source Vector. Both pb and pb1 share their source Vector,
* and a change in either is visible to both.
*
* <p> A correct way to write the addSource function is to clone
* the source Vector:
@@ -76,11 +76,11 @@
* pb1.addSource(im);
* return pb1;
* }
* </pre>
*
- * <p> The clone method of <code>ParameterBlock</code> has been defined to
+ * <p> The clone method of {@code ParameterBlock} has been defined to
* perform a clone of both the source and parameter Vectors for
* this reason. A standard, shallow clone is available as
* shallowClone.
*
* <p> The addSource, setSource, add, and set methods are
@@ -103,38 +103,38 @@
/** A dummy constructor. */
public ParameterBlock() {}
/**
- * Constructs a <code>ParameterBlock</code> with a given Vector
+ * Constructs a {@code ParameterBlock} with a given Vector
* of sources.
- * @param sources a <code>Vector</code> of source images
+ * @param sources a {@code Vector} of source images
*/
public ParameterBlock(Vector<Object> sources) {
setSources(sources);
}
/**
- * Constructs a <code>ParameterBlock</code> with a given Vector of sources and
+ * Constructs a {@code ParameterBlock} with a given Vector of sources and
* Vector of parameters.
- * @param sources a <code>Vector</code> of source images
- * @param parameters a <code>Vector</code> of parameters to be used in the
+ * @param sources a {@code Vector} of source images
+ * @param parameters a {@code Vector} of parameters to be used in the
* rendering operation
*/
public ParameterBlock(Vector<Object> sources,
Vector<Object> parameters)
{
setSources(sources);
setParameters(parameters);
}
/**
- * Creates a shallow copy of a <code>ParameterBlock</code>. The source and
+ * Creates a shallow copy of a {@code ParameterBlock}. The source and
* parameter Vectors are copied by reference -- additions or
* changes will be visible to both versions.
*
- * @return an Object clone of the <code>ParameterBlock</code>.
+ * @return an Object clone of the {@code ParameterBlock}.
*/
public Object shallowClone() {
try {
return super.clone();
} catch (Exception e) {
@@ -142,18 +142,18 @@
return null;
}
}
/**
- * Creates a copy of a <code>ParameterBlock</code>. The source and parameter
+ * Creates a copy of a {@code ParameterBlock}. The source and parameter
* Vectors are cloned, but the actual sources and parameters are
* copied by reference. This allows modifications to the order
* and number of sources and parameters in the clone to be invisible
- * to the original <code>ParameterBlock</code>. Changes to the shared sources or
+ * to the original {@code ParameterBlock}. Changes to the shared sources or
* parameters themselves will still be visible.
*
- * @return an Object clone of the <code>ParameterBlock</code>.
+ * @return an Object clone of the {@code ParameterBlock}.
*/
@SuppressWarnings("unchecked") // casts from clone
public Object clone() {
ParameterBlock theClone;
@@ -177,12 +177,12 @@
* Adds an image to end of the list of sources. The image is
* stored as an object in order to allow new node types in the
* future.
*
* @param source an image object to be stored in the source list.
- * @return a new <code>ParameterBlock</code> containing the specified
- * <code>source</code>.
+ * @return a new {@code ParameterBlock} containing the specified
+ * {@code source}.
*/
public ParameterBlock addSource(Object source) {
sources.addElement(source);
return this;
}
@@ -190,13 +190,13 @@
/**
* Returns a source as a general Object. The caller must cast it into
* an appropriate type.
*
* @param index the index of the source to be returned.
- * @return an <code>Object</code> that represents the source located
- * at the specified index in the <code>sources</code>
- * <code>Vector</code>.
+ * @return an {@code Object} that represents the source located
+ * at the specified index in the {@code sources}
+ * {@code Vector}.
* @see #setSource(Object, int)
*/
public Object getSource(int index) {
return sources.elementAt(index);
}
@@ -204,16 +204,16 @@
/**
* Replaces an entry in the list of source with a new source.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param source the specified source image
- * @param index the index into the <code>sources</code>
- * <code>Vector</code> at which to
- * insert the specified <code>source</code>
- * @return a new <code>ParameterBlock</code> that contains the
- * specified <code>source</code> at the specified
- * <code>index</code>.
+ * @param index the index into the {@code sources}
+ * {@code Vector} at which to
+ * insert the specified {@code source}
+ * @return a new {@code ParameterBlock} that contains the
+ * specified {@code source} at the specified
+ * {@code index}.
* @see #getSource(int)
*/
public ParameterBlock setSource(Object source, int index) {
int oldSize = sources.size();
int newSize = index + 1;
@@ -223,18 +223,18 @@
sources.setElementAt(source, index);
return this;
}
/**
- * Returns a source as a <code>RenderedImage</code>. This method is
+ * Returns a source as a {@code RenderedImage}. This method is
* a convenience method.
* An exception will be thrown if the source is not a RenderedImage.
*
* @param index the index of the source to be returned
- * @return a <code>RenderedImage</code> that represents the source
+ * @return a {@code RenderedImage} that represents the source
* image that is at the specified index in the
- * <code>sources</code> <code>Vector</code>.
+ * {@code sources Vector}.
*/
public RenderedImage getRenderedSource(int index) {
return (RenderedImage) sources.elementAt(index);
}
@@ -242,39 +242,39 @@
* Returns a source as a RenderableImage. This method is a
* convenience method.
* An exception will be thrown if the sources is not a RenderableImage.
*
* @param index the index of the source to be returned
- * @return a <code>RenderableImage</code> that represents the source
+ * @return a {@code RenderableImage} that represents the source
* image that is at the specified index in the
- * <code>sources</code> <code>Vector</code>.
+ * {@code sources Vector}.
*/
public RenderableImage getRenderableSource(int index) {
return (RenderableImage) sources.elementAt(index);
}
/**
* Returns the number of source images.
- * @return the number of source images in the <code>sources</code>
- * <code>Vector</code>.
+ * @return the number of source images in the {@code sources}
+ * {@code Vector}.
*/
public int getNumSources() {
return sources.size();
}
/**
* Returns the entire Vector of sources.
- * @return the <code>sources</code> <code>Vector</code>.
+ * @return the {@code sources Vector}.
* @see #setSources(Vector)
*/
public Vector<Object> getSources() {
return sources;
}
/**
* Sets the entire Vector of sources to a given Vector.
- * @param sources the <code>Vector</code> of source images
+ * @param sources the {@code Vector} of source images
* @see #getSources
*/
public void setSources(Vector<Object> sources) {
this.sources = sources;
}
@@ -284,29 +284,29 @@
sources = new Vector<>();
}
/**
* Returns the number of parameters (not including source images).
- * @return the number of parameters in the <code>parameters</code>
- * <code>Vector</code>.
+ * @return the number of parameters in the {@code parameters}
+ * {@code Vector}.
*/
public int getNumParameters() {
return parameters.size();
}
/**
* Returns the entire Vector of parameters.
- * @return the <code>parameters</code> <code>Vector</code>.
+ * @return the {@code parameters Vector}.
* @see #setParameters(Vector)
*/
public Vector<Object> getParameters() {
return parameters;
}
/**
* Sets the entire Vector of parameters to a given Vector.
- * @param parameters the specified <code>Vector</code> of
+ * @param parameters the specified {@code Vector} of
* parameters
* @see #getParameters
*/
public void setParameters(Vector<Object> parameters) {
this.parameters = parameters;
@@ -317,91 +317,91 @@
parameters = new Vector<>();
}
/**
* Adds an object to the list of parameters.
- * @param obj the <code>Object</code> to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * @param obj the {@code Object} to add to the
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(Object obj) {
parameters.addElement(obj);
return this;
}
/**
* Adds a Byte to the list of parameters.
* @param b the byte to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(byte b) {
return add(Byte.valueOf(b));
}
/**
* Adds a Character to the list of parameters.
* @param c the char to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(char c) {
return add(Character.valueOf(c));
}
/**
* Adds a Short to the list of parameters.
* @param s the short to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(short s) {
return add(Short.valueOf(s));
}
/**
* Adds a Integer to the list of parameters.
* @param i the int to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(int i) {
return add(Integer.valueOf(i));
}
/**
* Adds a Long to the list of parameters.
* @param l the long to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(long l) {
return add(Long.valueOf(l));
}
/**
* Adds a Float to the list of parameters.
* @param f the float to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(float f) {
return add(new Float(f));
}
/**
* Adds a Double to the list of parameters.
* @param d the double to add to the
- * <code>parameters</code> <code>Vector</code>
- * @return a new <code>ParameterBlock</code> containing
+ * {@code parameters Vector}
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock add(double d) {
return add(new Double(d));
}
@@ -410,14 +410,14 @@
* Replaces an Object in the list of parameters.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param obj the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(Object obj, int index) {
int oldSize = parameters.size();
int newSize = index + 1;
@@ -432,14 +432,14 @@
* Replaces an Object in the list of parameters with a Byte.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param b the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(byte b, int index) {
return set(Byte.valueOf(b), index);
}
@@ -448,14 +448,14 @@
* Replaces an Object in the list of parameters with a Character.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param c the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(char c, int index) {
return set(Character.valueOf(c), index);
}
@@ -464,14 +464,14 @@
* Replaces an Object in the list of parameters with a Short.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param s the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(short s, int index) {
return set(Short.valueOf(s), index);
}
@@ -480,14 +480,14 @@
* Replaces an Object in the list of parameters with an Integer.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param i the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(int i, int index) {
return set(Integer.valueOf(i), index);
}
@@ -496,14 +496,14 @@
* Replaces an Object in the list of parameters with a Long.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param l the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(long l, int index) {
return set(Long.valueOf(l), index);
}
@@ -512,14 +512,14 @@
* Replaces an Object in the list of parameters with a Float.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param f the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(float f, int index) {
return set(new Float(f), index);
}
@@ -528,176 +528,176 @@
* Replaces an Object in the list of parameters with a Double.
* If the index lies beyond the current source list,
* the list is extended with nulls as needed.
* @param d the parameter that replaces the
* parameter at the specified index in the
- * <code>parameters</code> <code>Vector</code>
+ * {@code parameters Vector}
* @param index the index of the parameter to be
* replaced with the specified parameter
- * @return a new <code>ParameterBlock</code> containing
+ * @return a new {@code ParameterBlock} containing
* the specified parameter.
*/
public ParameterBlock set(double d, int index) {
return set(new Double(d), index);
}
/**
* Gets a parameter as an object.
* @param index the index of the parameter to get
- * @return an <code>Object</code> representing the
+ * @return an {@code Object} representing the
* the parameter at the specified index
- * into the <code>parameters</code>
- * <code>Vector</code>.
+ * into the {@code parameters}
+ * {@code Vector}.
*/
public Object getObjectParameter(int index) {
return parameters.elementAt(index);
}
/**
* A convenience method to return a parameter as a byte. An
* exception is thrown if the parameter is
- * <code>null</code> or not a <code>Byte</code>.
+ * {@code null} or not a {@code Byte}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>byte</code> value.
+ * as a {@code byte} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Byte</code>
+ * specified index is not a {@code Byte}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public byte getByteParameter(int index) {
return ((Byte)parameters.elementAt(index)).byteValue();
}
/**
* A convenience method to return a parameter as a char. An
* exception is thrown if the parameter is
- * <code>null</code> or not a <code>Character</code>.
+ * {@code null} or not a {@code Character}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>char</code> value.
+ * as a {@code char} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Character</code>
+ * specified index is not a {@code Character}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public char getCharParameter(int index) {
return ((Character)parameters.elementAt(index)).charValue();
}
/**
* A convenience method to return a parameter as a short. An
* exception is thrown if the parameter is
- * <code>null</code> or not a <code>Short</code>.
+ * {@code null} or not a {@code Short}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>short</code> value.
+ * as a {@code short} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Short</code>
+ * specified index is not a {@code Short}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public short getShortParameter(int index) {
return ((Short)parameters.elementAt(index)).shortValue();
}
/**
* A convenience method to return a parameter as an int. An
* exception is thrown if the parameter is
- * <code>null</code> or not an <code>Integer</code>.
+ * {@code null} or not an {@code Integer}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>int</code> value.
+ * as a {@code int} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Integer</code>
+ * specified index is not a {@code Integer}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public int getIntParameter(int index) {
return ((Integer)parameters.elementAt(index)).intValue();
}
/**
* A convenience method to return a parameter as a long. An
* exception is thrown if the parameter is
- * <code>null</code> or not a <code>Long</code>.
+ * {@code null} or not a {@code Long}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>long</code> value.
+ * as a {@code long} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Long</code>
+ * specified index is not a {@code Long}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public long getLongParameter(int index) {
return ((Long)parameters.elementAt(index)).longValue();
}
/**
* A convenience method to return a parameter as a float. An
* exception is thrown if the parameter is
- * <code>null</code> or not a <code>Float</code>.
+ * {@code null} or not a {@code Float}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>float</code> value.
+ * as a {@code float} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Float</code>
+ * specified index is not a {@code Float}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public float getFloatParameter(int index) {
return ((Float)parameters.elementAt(index)).floatValue();
}
/**
* A convenience method to return a parameter as a double. An
* exception is thrown if the parameter is
- * <code>null</code> or not a <code>Double</code>.
+ * {@code null} or not a {@code Double}.
*
* @param index the index of the parameter to be returned.
* @return the parameter at the specified index
- * as a <code>double</code> value.
+ * as a {@code double} value.
* @throws ClassCastException if the parameter at the
- * specified index is not a <code>Double</code>
+ * specified index is not a {@code Double}
* @throws NullPointerException if the parameter at the specified
- * index is <code>null</code>
- * @throws ArrayIndexOutOfBoundsException if <code>index</code>
+ * index is {@code null}
+ * @throws ArrayIndexOutOfBoundsException if {@code index}
* is negative or not less than the current size of this
- * <code>ParameterBlock</code> object
+ * {@code ParameterBlock} object
*/
public double getDoubleParameter(int index) {
return ((Double)parameters.elementAt(index)).doubleValue();
}
/**
* Returns an array of Class objects describing the types
* of the parameters.
- * @return an array of <code>Class</code> objects.
+ * @return an array of {@code Class} objects.
*/
public Class<?>[] getParamClasses() {
int numParams = getNumParameters();
Class<?>[] classes = new Class<?>[numParams];
int i;
< prev index next >