- java.lang.Object
- 
- javax.print.attribute.SetOfIntegerSyntax
 
- 
- All Implemented Interfaces:
- Serializable,- Cloneable
 - Direct Known Subclasses:
- CopiesSupported,- JobImpressionsSupported,- JobKOctetsSupported,- JobMediaSheetsSupported,- NumberUpSupported,- PageRanges
 
 public abstract class SetOfIntegerSyntax extends Object implements Serializable, Cloneable ClassSetOfIntegerSyntaxis an abstract base class providing the common implementation of all attributes whose value is a set of nonnegative integers. This includes attributes whose value is a single range of integers and attributes whose value is a set of ranges of integers.You can construct an instance of SetOfIntegerSyntaxby giving it in "string form." The string consists of zero or more comma-separated integer groups. Each integer group consists of either one integer, two integers separated by a hyphen (-), or two integers separated by a colon (:). Each integer consists of one or more decimal digits (0through9). Whitespace characters cannot appear within an integer but are otherwise ignored. For example:"","1","5-10","1:2, 4".You can also construct an instance of SetOfIntegerSyntaxby giving it in "array form." Array form consists of an array of zero or more integer groups where each integer group is a length-1 or length-2 array ofints; for example,int[0][],int[][]{{1}},int[][]{{5,10}},int[][]{{1,2},{4}}.In both string form and array form, each successive integer group gives a range of integers to be included in the set. The first integer in each group gives the lower bound of the range; the second integer in each group gives the upper bound of the range; if there is only one integer in the group, the upper bound is the same as the lower bound. If the upper bound is less than the lower bound, it denotes a nullrange (no values). If the upper bound is equal to the lower bound, it denotes a range consisting of a single value. If the upper bound is greater than the lower bound, it denotes a range consisting of more than one value. The ranges may appear in any order and are allowed to overlap. The union of all the ranges gives the set's contents. Once aSetOfIntegerSyntaxinstance is constructed, its value is immutable.The SetOfIntegerSyntaxobject's value is actually stored in "canonical array form." This is the same as array form, except there are nonullranges; the members of the set are represented in as few ranges as possible (i.e., overlapping ranges are coalesced); the ranges appear in ascending order; and each range is always represented as a length-two array ofints in the form {lower bound, upper bound}. An empty set is represented as a zero-length array.Class SetOfIntegerSyntaxhas operations to return the set's members in canonical array form, to test whether a given integer is a member of the set, and to iterate through the members of the set.- See Also:
- Serialized Form
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedSetOfIntegerSyntax(int member)Construct a new set-of-integer attribute containing a single integer.protectedSetOfIntegerSyntax(int[][] members)Construct a new set-of-integer attribute with the given members in array form.protectedSetOfIntegerSyntax(int lowerBound, int upperBound)Construct a new set-of-integer attribute containing a single range of integers.protectedSetOfIntegerSyntax(String members)Construct a new set-of-integer attribute with the given members in string form.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancontains(int x)Determine if this set-of-integer attribute contains the given value.booleancontains(IntegerSyntax attribute)Determine if this set-of-integer attribute contains the given integer attribute's value.booleanequals(Object object)Returns whether this set-of-integer attribute is equivalent to the passed in object.int[][]getMembers()Obtain this set-of-integer attribute's members in canonical array form.inthashCode()Returns a hash code value for this set-of-integer attribute.intnext(int x)Determine the smallest integer in this set-of-integer attribute that is greater than the given value.StringtoString()Returns a string value corresponding to this set-of-integer attribute.
 
- 
- 
- 
Constructor Detail- 
SetOfIntegerSyntaxprotected SetOfIntegerSyntax(String members) Construct a new set-of-integer attribute with the given members in string form.- Parameters:
- members- set members in string form. If- null, an empty set is constructed.
- Throws:
- IllegalArgumentException- if- membersdoes not obey the proper syntax
 
 - 
SetOfIntegerSyntaxprotected SetOfIntegerSyntax(int[][] members) Construct a new set-of-integer attribute with the given members in array form.- Parameters:
- members- set members in array form. If- null, an empty set is constructed.
- Throws:
- NullPointerException- if any element of- membersis- null
- IllegalArgumentException- if any element of- membersis not a length-one or length-two array or if any- non-nullrange in- membershas a lower bound less than zero
 
 - 
SetOfIntegerSyntaxprotected SetOfIntegerSyntax(int member) Construct a new set-of-integer attribute containing a single integer.- Parameters:
- member- set member
- Throws:
- IllegalArgumentException- if- memberis negative
 
 - 
SetOfIntegerSyntaxprotected SetOfIntegerSyntax(int lowerBound, int upperBound)Construct a new set-of-integer attribute containing a single range of integers. If the lower bound is greater than the upper bound (a null range), an empty set is constructed.- Parameters:
- lowerBound- Lower bound of the range
- upperBound- Upper bound of the range
- Throws:
- IllegalArgumentException- if the range is- non-nulland- lowerBoundis less than zero
 
 
- 
 - 
Method Detail- 
getMemberspublic int[][] getMembers() Obtain this set-of-integer attribute's members in canonical array form. The returned array is "safe;" the client may alter it without affecting this set-of-integer attribute.- Returns:
- this set-of-integer attribute's members in canonical array form
 
 - 
containspublic boolean contains(int x) Determine if this set-of-integer attribute contains the given value.- Parameters:
- x- the Integer value
- Returns:
- trueif this set-of-integer attribute contains the value- x,- falseotherwise
 
 - 
containspublic boolean contains(IntegerSyntax attribute) Determine if this set-of-integer attribute contains the given integer attribute's value.- Parameters:
- attribute- the Integer attribute
- Returns:
- trueif this set-of-integer attribute contains- attribute's value,- falseotherwise
 
 - 
nextpublic int next(int x) Determine the smallest integer in this set-of-integer attribute that is greater than the given value. If there are no integers in this set-of-integer attribute greater than the given value,-1is returned. (Since a set-of-integer attribute can only contain nonnegative values,-1will never appear in the set.) You can use thenext()method to iterate through the integer values in a set-of-integer attribute in ascending order, like this:SetOfIntegerSyntax attribute = . . .; int i = -1; while ((i = attribute.next (i)) != -1) { foo (i); }- Parameters:
- x- the Integer value
- Returns:
- the smallest integer in this set-of-integer attribute that is
         greater than x, or-1if no integer in this set-of-integer attribute is greater thanx.
 
 - 
equalspublic boolean equals(Object object) Returns whether this set-of-integer attribute is equivalent to the passed in object. To be equivalent, all of the following conditions must be true:- objectis not- null.
- objectis an instance of class- SetOfIntegerSyntax.
- This set-of-integer attribute's members and object's members are the same.
 - Overrides:
- equalsin class- Object
- Parameters:
- object-- Objectto compare to
- Returns:
- trueif- objectis equivalent to this set-of-integer attribute,- falseotherwise
- See Also:
- Object.hashCode(),- HashMap
 
 - 
hashCodepublic int hashCode() Returns a hash code value for this set-of-integer attribute. The hash code is the sum of the lower and upper bounds of the ranges in the canonical array form, or 0 for an empty set.- Overrides:
- hashCodein class- Object
- Returns:
- a hash code value for this object.
- See Also:
- Object.equals(java.lang.Object),- System.identityHashCode(java.lang.Object)
 
 - 
toStringpublic String toString() Returns a string value corresponding to this set-of-integer attribute. The string value is a zero-length string if this set is empty. Otherwise, the string value is a comma-separated list of the ranges in the canonical array form, where each range is represented as"i"if the lower bound equals the upper bound or"i-j"otherwise.
 
- 
 
-