javax.print.attribute
Class SetOfIntegerSyntax
- 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:
SetOfIntegerSyntax(int member)
Constructor for an instance with only one integer value.
SetOfIntegerSyntax(int lowerBound, int upperBound)
Constructor for an instance with one range of integer values.
SetOfIntegerSyntax(int[][] members)
Flexible constructor for an instance with several single integer values
and/or several ranges of integer values. The allowed array form is an
array of integer arrays of length one or two. Examples are:
int[0][] for empty set of integers, int[][] {{1}}
, int[][] {{1,5}}, int[][] {{1,5},{7,9}},
int[][] {{3,7},{19}}.
SetOfIntegerSyntax(String s)
Flexible constructor for an instance with several single integer values
and/or several ranges of integer values. The allowed String instance have
to be a String with comma separated ranges of integer values or single
values. Ranges are represented by two integer with a hypen (-) or colon (:)
between the lower and upper bound value. Whitespace characters are ignored.
Examples are: "" for an empty set of integers,
"1", "1-5", "1-5,7-9",
"3-7,19" and "1:2,4".
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.
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.
|
clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait |
SetOfIntegerSyntax
protected SetOfIntegerSyntax(int member)
Creates a SetOfIntegerSyntax object.
member - the member value
SetOfIntegerSyntax
protected SetOfIntegerSyntax(int lowerBound,
int upperBound) Creates a SetOfIntegerSyntax object.
lowerBound - the lower bound valueupperBound - the upper bound value
SetOfIntegerSyntax
protected SetOfIntegerSyntax(int[][] members)
Creates a SetOfIntegerSyntax object.
members - the members to use in this set. If
null an empty set is created.
SetOfIntegerSyntax
protected SetOfIntegerSyntax(String s)
Creates a SetOfIntegerSyntax object.
s - the members to use in this set in string form. If
null an empty set is created.
contains
public boolean contains(int value)
Checks if this set contains the given value.
value - the value to test for
- true if this set contains value, false otherwise
contains
public boolean contains(IntegerSyntax value)
Checks if this set contains the given value.
value - the value to test for
- true if this set contains value, false otherwise
equals
public boolean equals(Object obj)
Tests if the given object is equal to this object.
- equals in interface Object
- true if both objects are equal, false otherwise.
getMembers
public int[][] getMembers()
Returns an array describing the members included in this set.
- The members in normalized array form.
next
public int next(int x)
Returns the smallest value that is greater than x which is in this set.
- 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".
- toString in interface Object
- The string representation.
SetOfIntegerSyntax.java --
Copyright (C) 2003, 2004, 2005 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.