javax.print.attribute
クラス Size2DSyntax

java.lang.Object
  javax.print.attribute.Size2DSyntax

すべての実装されたインタフェース:

Serializable, Cloneable

直系の既知のサブクラス:

MediaSize

public abstract class Size2DSyntax
extends Object
implements Serializable, Cloneable

Size2DSyntax クラスは、2 次元のサイズを示すすべての属性の一般的な実装を提供する抽象基底クラスです。

2 次元のサイズの属性値は、寸法 X と寸法 Y の 2 つの項目から構成されます。2 次元のサイズの属性値は、2 つの値を提供し、その値を測定する単位を示すことによって構築されます。メソッドは 2 次元のサイズの属性値を返すために提供され、値を返す単位を示します。もっとも一般的な 2 つのサイズの単位は、インチ (in) と ミリメートル (mm) で、これらの単位を示すためにエクスポートされる定数 INCH と MM が提供されます。

2 次元のサイズの属性値は、いったん構築されると変更できません。

設計

2 次元のサイズの属性値の寸法 X と寸法 Y の値は、整数型としてミクロン (µm) 単位で内部に格納されます。ここで、1 ミクロン = 10^-6 メートル = 1/1000 ミリメートル = 1/25400 インチです。これにより、寸法を 1/1000 ミリメートル (= 1 µm) または 1/100 インチ (= 254 µm) の精度で正確に表すことができます。インチの小数部が負の 2 の累乗で表される場合、これは寸法を 1/8 インチ (= 3175 µm) の精度で正確に表すことができます。ただし、1/16 インチは µm の積分数と等しくないため、1/16 インチで表すことはできません。

寸法を共通の µm 単位で内部に格納することにより、作成時の単位にかかわらず 2 つのサイズの属性が比較可能になります。たとえば、両方とも 215900 µm として格納されるため、比較の結果 8.5 インチは 215.9 mm と等しいことがわかります。たとえば、検索サービスは、作成時の単位にかかわらず、直列化表現の同等性に基づいて解像度属性を照合できます。内部記憶に整数型を使用することにより、正確な同等性の比較が可能になります。ただし、これは内部表現に浮動小数点が使用される場合は保証されません。メートル法単位の U.S. レターサイズメディアを検出する場合、215.9 x 279.4 mm のメディアサイズを検索しなければならないことに注意してください。整数型 216 x 279 mm に四捨五入すると照合されません。

エクスポートされる定数 INCH は、実際にインチ単位の値に乗算して、µm 単位の値を取得する変換係数です。同様に、エクスポートされる定数 MM は、mm 単位の値に乗算して µm 単位の値を取得する変換係数です。クライアントは、クライアント自身の変換係数を提供して、インチまたは mm 以外の単位で解像度属性を指定できます。ただし、内部単位 µm は、外部単位として、インチと mm だけを考慮してサポートするよう選択されているので、クライアントの単位の変換係数が正確な整数型となるかどうか保証されません。変換係数が正確な整数型ではない場合、クライアントの単位の解像度の値は正確に格納されません。

関連項目:

直列化された形式

フィールドの概要

static int	INCH インチ (in) 単位を示す値です。
static int	MM ミリメートル (mm) 単位を示す値です。

コンストラクタの概要

protected	Size2DSyntax(float x, float y, int units) 指定された浮動小数点の値で新しい 2 次元のサイズの属性を構築します。
protected	Size2DSyntax(int x, int y, int units) 指定された整数値で新しい 2 次元のサイズの属性を構築します。

メソッドの概要

boolean	equals(Object object) この 2 次元のサイズの属性がオブジェクトに渡された属性と等しいかどうかを返します。
float[]	getSize(int units) 浮動小数点の値として指定された単位で、この 2 次元のサイズの属性の寸法を返します。
float	getX(int units) 浮動小数点の値として指定された単位で、この 2 次元のサイズの属性の寸法 X を返します。
protected int	getXMicrometers() この 2 次元のサイズの属性の寸法 X をミクロン (µm) 単位で返します (サブクラスで使用)。
float	getY(int units) 浮動小数点の値として指定された単位で、この 2 次元のサイズの属性の寸法 Y を返します。
protected int	getYMicrometers() この 2 次元のサイズの属性の寸法 Y をミクロン (µm) 単位で返します (サブクラスで使用)。
int	hashCode() この 2 次元のサイズの属性のハッシュコード値を返します。
String	toString() この 2 次元のサイズの属性の文字列バージョンを返します。
String	toString(int units, String unitsName) この 2 次元のサイズの属性の文字列バージョンを指定された単位で返します。

クラス java.lang.Object から継承されたメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

フィールドの詳細

INCH

public static final int INCH

インチ (in) 単位を示す値です。これは、実際にインチに乗算して µm (25400) を算出する変換係数です。

関連項目:

定数フィールド値

MM

public static final int MM

ミリメートル (mm) 単位を示す値です。これは、実際に mm に乗算して µm (1000) を算出する変換係数です。

関連項目:

定数フィールド値

コンストラクタの詳細

Size2DSyntax

protected Size2DSyntax(float x,
                       float y,
                       int units)

指定された浮動小数点の値で新しい 2 次元のサイズの属性を構築します。

パラメータ:

x - 寸法 X

y - 寸法 Y

units - 単位変換係数。たとえば、INCH または MM

例外:

IllegalArgumentException - (チェックされない例外) x < 0 または y < 0 または units < 1 の場合にスローされる

Size2DSyntax

protected Size2DSyntax(int x,
                       int y,
                       int units)

指定された整数値で新しい 2 次元のサイズの属性を構築します。

パラメータ:

x - 寸法 X

y - 寸法 Y

units - 単位変換係数。たとえば、INCH または MM

例外:

IllegalArgumentException - (チェックされない例外) x < 0 または y < 0 または units < 1 の場合にスローされる

メソッドの詳細

getSize

public float[] getSize(int units)

浮動小数点の値として指定された単位で、この 2 次元のサイズの属性の寸法を返します。

パラメータ:

units - 単位変換係数。たとえば、INCH または MM

戻り値:

インデックス 0 の寸法 X およびインデックス 1 の寸法 Y を持つ 2 要素の配列

例外:

IllegalArgumentException - (チェックされない例外) units < 1 の場合にスローされる

getX

public float getX(int units)

浮動小数点の値として指定された単位で、この 2 次元のサイズの属性の寸法 X を返します。

パラメータ:

units - 単位変換係数。たとえば、INCH または MM

戻り値:

寸法 X

例外:

IllegalArgumentException - (チェックされない例外) units < 1 の場合にスローされる

getY

public float getY(int units)

浮動小数点の値として指定された単位で、この 2 次元のサイズの属性の寸法 Y を返します。

パラメータ:

units - 単位変換係数。たとえば、INCH または MM

戻り値:

寸法 Y

例外:

IllegalArgumentException - (チェックされない例外) units < 1 の場合にスローされる

toString

public String toString(int units,
                       String unitsName)

この 2 次元のサイズの属性の文字列バージョンを指定された単位で返します。文字列は 「XxY U」 の形式をとります。ここで、「X」は寸法 X、「Y」は寸法 Y、「U」は単位名です。値は浮動小数点で表示されます。

パラメータ:

units - 単位変換係数。たとえば、INCH または MM

unitsName - 単位名の文字列。たとえば、「in」 または 「mm」。null の場合、結果に単位名は付けられない

戻り値:

この 2 次元のサイズの属性の文字列バージョン

例外:

IllegalArgumentException - (チェックされない例外) units < 1 の場合にスローされる

equals

public boolean equals(Object object)

この 2 次元のサイズの属性がオブジェクトに渡された属性と等しいかどうかを返します。同等であるためには、次の条件のすべてが true でなければなりません。

1. object が null ではない
2. object が Size2DSyntax のインスタンスである
3. この属性の寸法 X が object の寸法 X と等しい
4. この属性の寸法 Y が object の寸法 Y と等しい

オーバーライド:

クラス Object 内の equals

パラメータ:

object - 比較対象のオブジェクト

戻り値:

object がこの 2 次元のサイズの属性と等しい場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

この 2 次元のサイズの属性のハッシュコード値を返します。

オーバーライド:

クラス Object 内の hashCode

戻り値:

このオブジェクトのハッシュコード値

関連項目:

Object.equals(java.lang.Object), Hashtable

toString

public String toString()

この 2 次元のサイズの属性の文字列バージョンを返します。文字列は 「XxY um」 の形式をとります。ここで、「X」は寸法 X、「Y」は寸法 Y です。値は内部単位ミクロンで報告されます。

オーバーライド:

クラス Object 内の toString

戻り値:

このオブジェクトの文字列表現

getXMicrometers

protected int getXMicrometers()

この 2 次元のサイズの属性の寸法 X をミクロン (µm) 単位で返します (サブクラスで使用)。

戻り値:

寸法 X (µm)

getYMicrometers

protected int getYMicrometers()

この 2 次元のサイズの属性の寸法 Y をミクロン (µm) 単位で返します (サブクラスで使用)。

戻り値:

寸法 Y (µm)