java.awt.image.renderable
類別 ParameterBlock

java.lang.Object
  java.awt.image.renderable.ParameterBlock

所有已實作的介面：

Serializable, Cloneable

public class ParameterBlock
extends Object
implements Cloneable, Serializable

ParameterBlock 封裝有關 RenderableImageOp 所需的源和參數 (Object) 的所有資訊，或者其他處理圖像的類別。

儘管可以將任意物件放入源 Vector，但此類別的使用者可能會強加一些語義限制，如要求所有源都作為 RenderedImages 或 RenderableImage。ParameterBlock 本身只是一個容器，而且不對源或參數型別執行檢查。

ParameterBlock 中的所有參數都是物件；可以使用便捷的 add 和 set 方法，這些方法帶基本型別的參數並建構 Number（Integer 或 Float）的適當子類別。相應的 get 方法執行向下強制轉換並擁有基本型別的返回值；如果存儲的值沒有正確的型別，則會拋出異常。無法區分 "short s; add(s)" 和 "add(new Short(s))" 之間的結果。

注意，get 和 set 方法對參考進行操作。因此，需要小心的是，在不適當的時候一定不要共享 ParameterBlock 之間的參考。例如，要創建一個與舊 ParameterBlock（除了添加的源之外）相等的新 ParameterBlock，有人可能會嘗試編寫以下程序：

 ParameterBlock addSource(ParameterBlock pb, RenderableImage im) {
     ParameterBlock pb1 = new ParameterBlock(pb.getSources());
     pb1.addSource(im);
     return pb1;
 }
 

這段程式碼具有替換原來 ParameterBlock 的負作用，因為 getSources 操作返回一個對其源 Vector 的參考。pb 和 pb1 同時共享其源 Vector，而且對其中之一的更改相對於兩者來說都是可見的。

編寫 addSource 函數的正確方法是複製源 Vector：

 ParameterBlock addSource (ParameterBlock pb, RenderableImage im) {
     ParameterBlock pb1 = new ParameterBlock(pb.getSources().clone());
     pb1.addSource(im);
     return pb1;
 }
 

因此，定義了 ParameterBlock 的 clone 方法，以執行源和參數 Vectors 的副本。可以使用標準的淺表副本 shallowClone。

定義了 addSource、setSource、add 和 set 方法，以在添加其參數後返回 'this'。這允許使用類似以下的語法：

 ParameterBlock pb = new ParameterBlock();
 op = new RenderableImageOp("operation", pb.add(arg1).add(arg2));
 

另請參見：

序列化表格

欄位摘要

protected Vector<Object>	parameters 一個非源參數的 Vector，存儲為任意 Object。
protected Vector<Object>	sources 源的 Vector，存儲為任意 Objects。

建構子摘要

ParameterBlock()
一個 dummy 建構子。

ParameterBlock(Vector<Object> sources)
使用源的給定 Vector 建構一個 ParameterBlock。

ParameterBlock(Vector<Object> sources, Vector<Object> parameters)
使用源的給定 Vector 和參數的 Vector 建構一個 ParameterBlock。

方法摘要

ParameterBlock	add(byte b) 將一個 Byte 添加到此參數列表。
ParameterBlock	add(char c) 將一個 Character 添加到此參數列表。
ParameterBlock	add(double d) 將一個 Double 添加到此參數列表。
ParameterBlock	add(float f) 將一個 Float 添加到此參數列表。
ParameterBlock	add(int i) 將一個 Integer 添加到此參數列表。
ParameterBlock	add(long l) 將一個 Long 添加到此參數列表。
ParameterBlock	add(Object obj) 將一個 Object 添加到此參數列表。
ParameterBlock	add(short s) 將一個 Short 添加到此參數列表。
ParameterBlock	addSource(Object source) 將一個圖像添加到源列表的末尾。
Object	clone() 創建 ParameterBlock 的一個副本。
byte	getByteParameter(int index) 作為 byte 返回參數的便捷方法。
char	getCharParameter(int index) 作為 char 返回參數的便捷方法。
double	getDoubleParameter(int index) 作為 double 返回參數的便捷方法。
float	getFloatParameter(int index) 作為 float 返回參數的便捷方法。
int	getIntParameter(int index) 作為 int 返回參數的便捷方法。
long	getLongParameter(int index) 作為 long 返回參數的便捷方法。
int	getNumParameters() 返回參數的數量（不包括源圖像）。
int	getNumSources() 返回源圖像的數量。
Object	getObjectParameter(int index) 獲取作為物件的參數。
Class[]	getParamClasses() 返回描述該參數的 Class 物件的陣列。
Vector<Object>	getParameters() 返回參數的整個 Vector。
RenderableImage	getRenderableSource(int index) 返回作為 RenderableImage 的源。
RenderedImage	getRenderedSource(int index) 返回作為 RenderedImage 的源。
short	getShortParameter(int index) 作為 short 返回參數的便捷方法。
Object	getSource(int index) 返回作為通用 Object 的源。
Vector<Object>	getSources() 返回源的整個 Vector。
void	removeParameters() 清除參數列表。
void	removeSources() 清除源圖像的列表。
ParameterBlock	set(byte b, int index) 使用 Byte 替換參數列表中的一個 Object。
ParameterBlock	set(char c, int index) 使用 Character 替換參數列表中的一個 Object。
ParameterBlock	set(double d, int index) 使用 Double 替換參數列表中的一個 Object。
ParameterBlock	set(float f, int index) 使用 Float 替換參數列表中的一個 Object。
ParameterBlock	set(int i, int index) 使用 Integer 替換參數列表中的一個 Object。
ParameterBlock	set(long l, int index) 使用 Long 替換參數列表中的一個 Object。
ParameterBlock	set(Object obj, int index) 替換此參數列表中的一個 Object。
ParameterBlock	set(short s, int index) 使用 Short 替換參數列表中的一個 Object。
void	setParameters(Vector<Object> parameters) 將參數的整個 Vector 設置為給定 Vector。
ParameterBlock	setSource(Object source, int index) 將源列表中的某個項替換為一個新源。
void	setSources(Vector<Object> sources) 將源的整個 Vector 設置為給定 Vector。
Object	shallowClone() 創建 ParameterBlock 的一個淺表副本。

從類別 java.lang.Object 繼承的方法

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

欄位詳細資訊

sources

protected Vector<Object> sources

源的 Vector，存儲為任意 Objects。

parameters

protected Vector<Object> parameters

一個非源參數的 Vector，存儲為任意 Object。

建構子詳細資訊

ParameterBlock

public ParameterBlock()

一個 dummy 建構子。

ParameterBlock

public ParameterBlock(Vector<Object> sources)

使用源的給定 Vector 建構一個 ParameterBlock。

參數：

sources - 源映像的 Vector

ParameterBlock

public ParameterBlock(Vector<Object> sources,
                      Vector<Object> parameters)

使用源的給定 Vector 和參數的 Vector 建構一個 ParameterBlock。

參數：

sources - 源映像的 Vector

parameters - 要在呈現操作中使用的參數的 Vector

方法詳細資訊

shallowClone

public Object shallowClone()

創建 ParameterBlock 的一個淺表副本。按參考複製源和參數 Vectors，添加或更改將對兩個版本都可見。

返回：

ParameterBlock 的 Object 副本。

clone

public Object clone()

創建 ParameterBlock 的一個副本。複製源和參數 Vector，但實際源和參數按參考複製。這允許對副本中源和參數的順序和數量的更改在初始 ParameterBlock 中可見。對共享源或參數本身的更改仍將可見。

覆寫：

類別 Object 中的 clone

返回：

ParameterBlock 的 Object 副本。

另請參見：

Cloneable

addSource

public ParameterBlock addSource(Object source)

將一個圖像添加到源列表的末尾。將圖像存儲為物件，以便將來允許新的節點型別。

參數：

source - 將存儲到源列表中的圖像物件。

返回：

包含指定 source 的新 ParameterBlock。

getSource

public Object getSource(int index)

返回作為通用 Object 的源。調用者必須將其強制轉換為一個適當的型別。

參數：

index - 要返回的源的索引。

返回：

表示位於 sources Vector 中指定索引處的源的 Object。

另請參見：

setSource(Object, int)

setSource

public ParameterBlock setSource(Object source,
                                int index)

將源列表中的某個項替換為一個新源。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

source - 指定的源圖像

index - 指向 sources Vector 索引，在該處將插入指定的 source

返回：

包含位於指定 index 處的指定 source 的新 ParameterBlock。

另請參見：

getSource(int)

getRenderedSource

public RenderedImage getRenderedSource(int index)

返回作為 RenderedImage 的源。這是一種便捷方法。如果源不是 RenderedImage，則會拋出異常。

參數：

index - 要返回的源的索引

返回：

表示位於 sources Vector 中指定索引處的源圖像的 RenderedImage。

getRenderableSource

public RenderableImage getRenderableSource(int index)

返回作為 RenderableImage 的源。這是一種便捷方法。如果源不是 RenderableImage，則會拋出異常。

參數：

index - 要返回的源的索引

返回：

表示位於此 sources Vector 中指定索引處的源圖像的 RenderableImage。

getNumSources

public int getNumSources()

返回源圖像的數量。

返回：

返回此 sources Vector 中源圖像的數量。

getSources

public Vector<Object> getSources()

返回源的整個 Vector。

返回：

sources Vector。

另請參見：

setSources(Vector)

setSources

public void setSources(Vector<Object> sources)

將源的整個 Vector 設置為給定 Vector。

參數：

sources - 源圖像的 Vector

另請參見：

getSources()

removeSources

public void removeSources()

清除源圖像的列表。

getNumParameters

public int getNumParameters()

返回參數的數量（不包括源圖像）。

返回：

此 parameters Vector 中的參數數量。

getParameters

public Vector<Object> getParameters()

返回參數的整個 Vector。

返回：

parameters Vector。

另請參見：

setParameters(Vector)

setParameters

public void setParameters(Vector<Object> parameters)

將參數的整個 Vector 設置為給定 Vector。

參數：

parameters - 參數的指定 Vector

另請參見：

getParameters()

removeParameters

public void removeParameters()

清除參數列表。

add

public ParameterBlock add(Object obj)

將一個 Object 添加到此參數列表。

參數：

obj - 要添加到此 parameters Vector 的 Object

返回：

一個套件含指定參數的新 ParameterBlock。

add

public ParameterBlock add(byte b)

將一個 Byte 添加到此參數列表。

參數：

b - 要添加到此 parameters Vector 的 Byte

返回：

一個套件含指定參數的新 ParameterBlock。

add

public ParameterBlock add(char c)

將一個 Character 添加到此參數列表。

參數：

c - 要添加到此 parameters Vector 的 char

返回：

包含指定參數的新 ParameterBlock。

add

public ParameterBlock add(short s)

將一個 Short 添加到此參數列表。

參數：

s - 要添加到此 parameters Vector 的 short

返回：

一個套件含指定參數的新 ParameterBlock。

add

public ParameterBlock add(int i)

將一個 Integer 添加到此參數列表。

參數：

i - 要添加到此 parameters Vector 的 int

返回：

一個套件含指定參數的新 ParameterBlock。

add

public ParameterBlock add(long l)

將一個 Long 添加到此參數列表。

參數：

l - 要添加到此 parameters Vector 的 long

返回：

一個套件含指定參數的新 ParameterBlock。

add

public ParameterBlock add(float f)

將一個 Float 添加到此參數列表。

參數：

f - 要添加到此 parameters Vector 的 float

返回：

一個套件含指定參數的新 ParameterBlock。

add

public ParameterBlock add(double d)

將一個 Double 添加到此參數列表。

參數：

d - 要添加到此 parameters Vector 的 double

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(Object obj,
                          int index)

替換此參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

obj - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(byte b,
                          int index)

使用 Byte 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

b - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(char c,
                          int index)

使用 Character 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

c - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(short s,
                          int index)

使用 Short 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

s - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(int i,
                          int index)

使用 Integer 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

i - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(long l,
                          int index)

使用 Long 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

l - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(float f,
                          int index)

使用 Float 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

f - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

set

public ParameterBlock set(double d,
                          int index)

使用 Double 替換參數列表中的一個 Object。如果索引位於當前源列表之外，則該列表將根據需要使用 null 進行擴展。

參數：

d - 替換 parameters Vector 中指定索引處參數的參數

index - 要使用指定參數替換的參數索引

返回：

一個套件含指定參數的新 ParameterBlock。

getObjectParameter

public Object getObjectParameter(int index)

獲取作為物件的參數。

參數：

index - 要獲取的參數的索引

返回：

表示 parameters Vector 中指定索引處參數的 Object。

getByteParameter

public byte getByteParameter(int index)

作為 byte 返回參數的便捷方法。如果該參數為 null 或者不是一個 Byte，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 byte 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Byte

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getCharParameter

public char getCharParameter(int index)

作為 char 返回參數的便捷方法。如果該參數為 null 或者不是 Character，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 char 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Character

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getShortParameter

public short getShortParameter(int index)

作為 short 返回參數的便捷方法。如果該參數為 null 或者不是一個 Short，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 short 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Short

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getIntParameter

public int getIntParameter(int index)

作為 int 返回參數的便捷方法。如果該參數為 null 或者不是一個 Integer，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 int 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Integer

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getLongParameter

public long getLongParameter(int index)

作為 long 返回參數的便捷方法。如果該參數為 null 或者不是 Long，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 long 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Long

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getFloatParameter

public float getFloatParameter(int index)

作為 float 返回參數的便捷方法。如果該參數為 null 或者不是一個 Float，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 float 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Float

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getDoubleParameter

public double getDoubleParameter(int index)

作為 double 返回參數的便捷方法。如果該參數為 null 或者不是一個 Double，則拋出異常。

參數：

index - 要返回的參數的索引。

返回：

指定索引處作為 double 值的參數。

拋出：

ClassCastException - 如果指定索引處的參數不是一個 Double

NullPointerException - 如果指定索引處的參數為 null

ArrayIndexOutOfBoundsException - 如果 index 為負或不小於此 ParameterBlock 物件的當前大小

getParamClasses

public Class[] getParamClasses()

返回描述該參數的 Class 物件的陣列。

返回：

Class 物件的陣列。