javax.print.attribute
Class SetOfIntegerSyntax

java.lang.Object
  extended by 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 Cloneable, Serializable

SetOfIntegerSyntax is the abstract base class of all attribute classes which provide a set of non-negative integers as value (e.g. the page ranges to print) represented as single values or ranges of values.

A SetOfIntegerSyntax instance consists of an integer array of ranges. Ranges may have the same lower and upper bound representing a single integer value. Ranges with a lower bound greater than the upper bound are null ranges and discarded. Ranges may overlap in their values. In no case negative integers are allowed.

There are several constructors available:

Internal storage:
The set of integers are stored internally in a normalized array form. In the normalized array form the set of integer ranges are represented in as few ranges as possible and overlapping ranges are merged. The ranges are always represented as an integer array of length two with ranges stored in {lower bound, upper bound} form. The ranges are stored in ascending order, without any null ranges.

See Also:
Serialized Form

Constructor Summary
protected SetOfIntegerSyntax(int member)
          Creates a SetOfIntegerSyntax object.
protected SetOfIntegerSyntax(int[][] members)
          Creates a SetOfIntegerSyntax object.
protected SetOfIntegerSyntax(int lowerBound, int upperBound)
          Creates a SetOfIntegerSyntax object.
protected SetOfIntegerSyntax(String s)
          Creates a SetOfIntegerSyntax object.
 
Method Summary
 boolean contains(int value)
          Checks if this set contains the given value.
 boolean contains(IntegerSyntax value)
          Checks if this set contains the given value.
 boolean equals(Object obj)
          Tests if the given object is equal to this object.
 int[][] getMembers()
          Returns an array describing the members included in this set.
 int hashCode()
          Returns the hashcode for this object.
 int next(int x)
          Returns the smallest value that is greater than x which is in this set.
 String toString()
          Returns the string representation for this object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SetOfIntegerSyntax

protected SetOfIntegerSyntax(int member)
Creates a SetOfIntegerSyntax object.

Parameters:
member - the member value
Throws:
IllegalArgumentException - if member is < 0

SetOfIntegerSyntax

protected SetOfIntegerSyntax(int[][] members)
Creates a SetOfIntegerSyntax object.

Parameters:
members - the members to use in this set. If null an empty set is created.
Throws:
IllegalArgumentException - if any element is invalid
NullPointerException - if any element of members is null

SetOfIntegerSyntax

protected SetOfIntegerSyntax(String s)
Creates a SetOfIntegerSyntax object.

Parameters:
s - the members to use in this set in string form. If null an empty set is created.
Throws:
IllegalArgumentException - if any element is invalid

SetOfIntegerSyntax

protected SetOfIntegerSyntax(int lowerBound,
                             int upperBound)
Creates a SetOfIntegerSyntax object.

Parameters:
lowerBound - the lower bound value
upperBound - the upper bound value
Throws:
IllegalArgumentException - if lowerBound <= upperbound and lowerBound < 0
Method Detail

contains

public boolean contains(int value)
Checks if this set contains the given value.

Parameters:
value - the value to test for
Returns:
true if this set contains value, false otherwise

contains

public boolean contains(IntegerSyntax value)
Checks if this set contains the given value.

Parameters:
value - the value to test for
Returns:
true if this set contains value, false otherwise

equals

public boolean equals(Object obj)
Tests if the given object is equal to this object.

Overrides:
equals in class Object
Parameters:
obj - the object to test
Returns:
true if both objects are equal, false otherwise.
See Also:
Object.hashCode()

getMembers

public int[][] getMembers()
Returns an array describing the members included in this set.

Returns:
The members in normalized array form.

hashCode

public int hashCode()
Returns the hashcode for this object.

Overrides:
hashCode in class Object
Returns:
The hashcode.
See Also:
Object.equals(Object), System.identityHashCode(Object)

next

public int next(int x)
Returns the smallest value that is greater than x which is in this set.

Parameters:
x - an integer value
Returns:
The next smallest integer value, or -1 if there is no greater integer in the set.

toString

public String toString()
Returns the string representation for this object. The value is a zero length string for an empty set, or a comma seperated list of ranges and single values in the form "1-2,5-7,10".

Overrides:
toString in class Object
Returns:
The string representation.
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)