javax.print.attribute

クラスSetOfIntegerSyntax

java.lang.Object

javax.print.attribute.SetOfIntegerSyntax

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

Serializable、Cloneable

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

CopiesSupported, JobImpressionsSupported, JobKOctetsSupported, JobMediaSheetsSupported, NumberUpSupported, PageRanges

public abstract class SetOfIntegerSyntax
extends Object
implements Serializable, Cloneable

SetOfIntegerSyntaxクラスは、負以外の整数値を持つすべての属性の一般的な実装を提供する抽象基底クラスです。これは、値が整数型の単一の範囲である属性と値が整数型の範囲のセットである属性を含みます。

「文字列形式」を使用してSetOfIntegerSyntaxのインスタンスを構築できます。この文字列は、0またはそれ以上のカンマで区切られた整数型のグループから構成されます。各整数型のグループは、1つの整数型、ハイフン(-)で区切られた2つの整数型、またはコロン(:)で区切られた2つの整数型のどれかから構成されます。各整数型は、1つ以上の10進数(0 - 9)から構成されます。空白文字は整数型の内部では使用されないか、または無視されます。例: ""、"1"、"5-10"、"1:2, 4"など。

「配列形式」を使用して、SetOfIntegerSyntaxのインスタンスを構築することもできます。配列形式は、0またはそれ以上の整数型のグループから構成されます。各整数型グループは、長さ1または長さ2のint配列から構成されます。たとえば、int[0][]、int[][]{{1}}、int[][]{{5,10}}、int[][]{{1,2},{4}}のようになります。

文字列形式と配列形式の両方で、連続する各整数型のグループはセットに含まれる整数型の範囲を指定します。各グループの最初の整数型は範囲の下限を指定します。各グループの2番目の整数型は範囲の上限を指定します。グループに1つの整数型しかない場合、上限は下限と同じになります。上限が下限より小さい場合、範囲がnullであることを示します(値なし)。上限が下限と等しい場合、単一の値から構成される範囲を示します。上限が下限より大きい場合、複数の値から構成される範囲を示します。範囲は任意の順番で表示され、オーバーラップできます。すべての範囲の結合は、セットの内容を提供します。いったんSetOfIntegerSyntaxインスタンスが構築されると、その値は変更できません。

SetOfIntegerSyntaxオブジェクトの値は、実際には「正規配列形式」で格納されます。これは、nullとなる範囲がないことを除き、配列形式と同じです。セットのメンバーは、可能なかぎり少ない範囲で表されます。つまり、オーバーラップする範囲は合体します。範囲は昇順で表示されます。各範囲は、常に長さ2のint配列として{lower bound, upper bound}の形式で表されます。空のセットは、長さ0の配列として表されます。

SetOfIntegerSyntaxクラスは、正規配列形式のセットのメンバーを返すオペレーションを持ち、指定された整数型がセットのメンバーであるかどうかを検査し、セットのメンバーを次々と繰返し検査します。

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	SetOfIntegerSyntax(int member) 単一の整数型を保持する新しい整数型セットの属性を構築します。
protected	SetOfIntegerSyntax(int[][] members) 指定されたメンバーを持つ新しい整数型セットの属性を配列形式で構築します。
protected	SetOfIntegerSyntax(int lowerBound, int upperBound) 単一の整数型の範囲を保持する新しい整数型セットの属性を構築します。
protected	SetOfIntegerSyntax(String members) 指定されたメンバーを持つ新しい整数型セットの属性を文字列形式で構築します。

メソッドのサマリー

修飾子と型	メソッドと説明
boolean	contains(int x) 整数型セットの属性が指定された値を保持しているかどうかを判定します。
boolean	contains(IntegerSyntax attribute) 整数型セットの属性が指定された整数型の属性の値を保持しているかどうかを判定します。
boolean	equals(Object object) この整数型セットの属性がオブジェクトに渡された属性と等しいかどうかを返します。
int[][]	getMembers() この整数型セットの属性のメンバーを正規配列形式で取得します。
int	hashCode() この整数型セットの属性のハッシュ・コード値を返します。
int	next(int x) 整数型セットの属性の中で、指定された値より大きい最小の整数を判定します。
String	toString() この整数型セットの属性に対応する文字列値を返します。

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

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

コンストラクタの詳細

SetOfIntegerSyntax

protected SetOfIntegerSyntax(String members)

指定されたメンバーを持つ新しい整数型セットの属性を文字列形式で構築します。

パラメータ:

members - 文字列形式のセット・メンバー。nullの場合、空のセットが構築される。

例外:

IllegalArgumentException - 非チェック例外。membersが正しい構文に従わない場合にスローされる。

SetOfIntegerSyntax

protected SetOfIntegerSyntax(int[][] members)

指定されたメンバーを持つ新しい整数型セットの属性を配列形式で構築します。

パラメータ:

members - 配列形式のセット・メンバー。nullの場合、空のセットが構築される。

例外:

NullPointerException - 非チェック例外。membersのいずれかの要素がnullの場合にスローされる。

IllegalArgumentException - 非チェック例外。membersの要素が長さ1または長さ2の配列ではない場合、あるいはmembersのnull以外の範囲が0より小さい下限を持つ場合、スローされる。

SetOfIntegerSyntax

protected SetOfIntegerSyntax(int member)

単一の整数型を保持する新しい整数型セットの属性を構築します。

パラメータ:

member - セットのメンバー。

例外:

IllegalArgumentException - 非チェック例外。memberが0より小さい場合にスローされる。

SetOfIntegerSyntax

protected SetOfIntegerSyntax(int lowerBound,
                             int upperBound)

単一の整数型の範囲を保持する新しい整数型セットの属性を構築します。下限が上限より大きい場合(nullの範囲)、空のセットが構築されます。

パラメータ:

lowerBound - 範囲の下限。

upperBound - 範囲の上限。

例外:

IllegalArgumentException - 非チェック例外。範囲がnull以外で、lowerBoundが0より小さい場合、スローされる。

メソッドの詳細

getMembers

public int[][] getMembers()

この整数型セットの属性のメンバーを正規配列形式で取得します。返される配列は「安全」です。クライアントはこの整数型セットの属性に影響を与えずに配列を変更できます。

戻り値:

正規配列形式の整数型セットの属性のメンバー

contains

public boolean contains(int x)

整数型セットの属性が指定された値を保持しているかどうかを判定します。

パラメータ:

x - 整数値。

戻り値:

整数型セットの属性が値xを保持している場合はtrue、そうでない場合はfalse。

contains

public boolean contains(IntegerSyntax attribute)

整数型セットの属性が指定された整数型の属性の値を保持しているかどうかを判定します。

パラメータ:

attribute - 整数型の属性。

戻り値:

整数型セットの属性がtheAttributeの値を保持している場合はtrue、そうでない場合はfalse。

next

public int next(int x)

整数型セットの属性の中で、指定された値より大きい最小の整数を判定します。指定された値より大きい整数型セットに整数型がない場合、-1が返されます。整数型セットの属性は負以外の値だけしか保持できないので、-1がセットに表示されることはありません。次のように、next()メソッドを使用して、整数型セットの属性の整数値を昇順で反復処理することができます。

     SetOfIntegerSyntax attribute = . . .;
     int i = -1;
     while ((i = attribute.next (i)) != -1)
         {
         foo (i);
         }
 

パラメータ:

x - 整数値。

戻り値:

整数型セットの属性の中で、xより大きい最小の整数。あるいは、整数型セットの属性にxより大きい整数がない場合は-1。

equals

public boolean equals(Object object)

この整数型セットの属性がオブジェクトに渡された属性と等しいかどうかを返します。次の条件がすべてtrueの場合に同等とみなされます。

1. objectがnullではない。
2. objectがSetOfIntegerSyntaxクラスのインスタンスである。
3. この整数型セットの属性のメンバーとobjectのメンバーが同じである。

オーバーライド:

equals、クラス: Object

パラメータ:

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

戻り値:

objectがこの整数型セットの属性と等しい場合はtrue、そうでない場合はfalse。

関連項目:

Object.hashCode(), HashMap

hashCode

public int hashCode()

この整数型セットの属性のハッシュ・コード値を返します。ハッシュ・コードは正規配列形式の範囲の下限と上限の合計、または空のセットの場合0です。

オーバーライド:

hashCode、クラス: Object

戻り値:

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

関連項目:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

toString

public String toString()

この整数型セットの属性に対応する文字列値を返します。このセットが空の場合、文字列値は長さ0の文字列です。それ以外の場合、文字列値は正規配列形式のカンマで区切られた範囲のリストです。各範囲は、下限が上限と等しい場合は"i"で表され、そうでない場合は"i-j"で表されます。

オーバーライド:

toString、クラス: Object

戻り値:

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