Class ResolutionSyntax
- All Implemented Interfaces:
-
Serializable
,Cloneable
- Direct Known Subclasses:
PrinterResolution
public abstract class ResolutionSyntax extends Object implements Serializable, Cloneable
ResolutionSyntax
is an abstract base class providing the common implementation of all attributes denoting a printer resolution. A resolution attribute's value consists of two items, the cross feed direction resolution and the feed direction resolution. A resolution attribute may be constructed by supplying the two values and indicating the units in which the values are measured. Methods are provided to return a resolution attribute's values, indicating the units in which the values are to be returned. The two most common resolution units are dots per inch (dpi) and dots per centimeter (dpcm), and exported constants DPI
and DPCM
are provided for indicating those units.
Once constructed, a resolution attribute's value is immutable.
Design
A resolution attribute's cross feed direction resolution and feed direction resolution values are stored internally using units of dots per 100 inches (dphi). Storing the values in dphi rather than, say, metric units allows precise integer arithmetic conversions between dpi and dphi and between dpcm and dphi: 1 dpi = 100 dphi, 1 dpcm = 254 dphi. Thus, the values can be stored into and retrieved back from a resolution attribute in either units with no loss of precision. This would not be guaranteed if a floating point representation were used. However, roundoff error will in general occur if a resolution attribute's values are created in one units and retrieved in different units; for example, 600 dpi will be rounded to 236 dpcm, whereas the true value (to five figures) is 236.22 dpcm.
Storing the values internally in common units of dphi lets two resolution attributes be compared without regard to the units in which they were created; for example, 300 dpcm will compare equal to 762 dpi, as they both are stored as 76200 dphi. In particular, a lookup service can match resolution attributes based on equality of their serialized representations regardless of the units in which they were created. Again, using integers for internal storage allows precise equality comparisons to be done, which would not be guaranteed if a floating point representation were used.
The exported constant DPI
is actually the conversion factor by which to multiply a value in dpi to get the value in dphi. Likewise, the exported constant DPCM
is the conversion factor by which to multiply a value in dpcm to get the value in dphi. A client can specify a resolution value in units other than dpi or dpcm by supplying its own conversion factor. However, since the internal units of dphi was chosen with supporting only the external units of dpi and dpcm in mind, there is no guarantee that the conversion factor for the client's units will be an exact integer. If the conversion factor isn't an exact integer, resolution values in the client's units won't be stored precisely.
- See Also:
Field Summary
Modifier and Type | Field | Description |
---|---|---|
static final int |
DPCM |
Value to indicate units of dots per centimeter (dpcm). |
static final int |
DPI |
Value to indicate units of dots per inch (dpi). |
Constructor Summary
Constructor | Description |
---|---|
ResolutionSyntax |
Construct a new resolution attribute from the given items. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
boolean |
equals |
Returns whether this resolution attribute is equivalent to the passed in object. |
int |
getCrossFeedResolution |
Returns this resolution attribute's cross feed direction resolution in the given units. |
protected int |
getCrossFeedResolutionDphi() |
Returns this resolution attribute's cross feed direction resolution in units of dphi. |
int |
getFeedResolution |
Returns this resolution attribute's feed direction resolution in the given units. |
protected int |
getFeedResolutionDphi() |
Returns this resolution attribute's feed direction resolution in units of dphi. |
int[] |
getResolution |
Get this resolution attribute's resolution values in the given units. |
int |
hashCode() |
Returns a hash code value for this resolution attribute. |
boolean |
lessThanOrEquals |
Determine whether this resolution attribute's value is less than or equal to the given resolution attribute's value. |
String |
toString() |
Returns a string version of this resolution attribute. |
String |
toString |
Returns a string version of this resolution attribute in the given units. |
Field Details
DPI
public static final int DPI
- See Also:
DPCM
public static final int DPCM
- See Also:
Constructor Details
ResolutionSyntax
public ResolutionSyntax(int crossFeedResolution, int feedResolution, int units)
- Parameters:
-
crossFeedResolution
- cross feed direction resolution -
feedResolution
- feed direction resolution -
units
- unit conversion factor, e.g.DPI
orDPCM
- Throws:
-
IllegalArgumentException
- ifcrossFeedResolution < 1
orfeedResolution < 1
orunits < 1
Method Details
getResolution
public int[] getResolution(int units)
- Parameters:
-
units
- unit conversion factor, e.g.DPI
orDPCM
- Returns:
- a two-element array with the cross feed direction resolution at index 0 and the feed direction resolution at index 1
- Throws:
-
IllegalArgumentException
- ifunits < 1
getCrossFeedResolution
public int getCrossFeedResolution(int units)
- Parameters:
-
units
- unit conversion factor, e.g.DPI
orDPCM
- Returns:
- cross feed direction resolution
- Throws:
-
IllegalArgumentException
- ifunits < 1
getFeedResolution
public int getFeedResolution(int units)
- Parameters:
-
units
- unit conversion factor, e.g.DPI
orDPCM
- Returns:
- feed direction resolution
- Throws:
-
IllegalArgumentException
- ifunits < 1
toString
public String toString(int units, String unitsName)
"CxF U"
, where C is the cross feed direction resolution, F is the feed direction resolution, and U is the units name. The values are rounded to the nearest integer.- Parameters:
-
units
- unit conversion factor, e.g.CODE>DPI
orDPCM
-
unitsName
- units name string, e.g."dpi"
or"dpcm"
. Ifnull
, no units name is appended to the result. - Returns:
- string version of this resolution attribute
- Throws:
-
IllegalArgumentException
- ifunits < 1
lessThanOrEquals
public boolean lessThanOrEquals(ResolutionSyntax other)
- This attribute's cross feed direction resolution is less than or equal to the
other
attribute's cross feed direction resolution. - This attribute's feed direction resolution is less than or equal to the
other
attribute's feed direction resolution.
- Parameters:
-
other
- resolution attribute to compare with - Returns:
-
true
if this resolution attribute is less than or equal to theother
resolution attribute,false
otherwise - Throws:
-
NullPointerException
- ifother
isnull
equals
public boolean equals(Object object)
-
object
is notnull
. -
object
is an instance of classResolutionSyntax
. - This attribute's cross feed direction resolution is equal to
object
's cross feed direction resolution. - This attribute's feed direction resolution is equal to
object
's feed direction resolution.
hashCode
public int hashCode()
toString
public String toString()
"CxF dphi"
, where C is the cross feed direction resolution and F is the feed direction resolution. The values are reported in the internal units of dphi.getCrossFeedResolutionDphi
protected int getCrossFeedResolutionDphi()
- Returns:
- cross feed direction resolution
getFeedResolutionDphi
protected int getFeedResolutionDphi()
- Returns:
- feed direction resolution
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/print/attribute/ResolutionSyntax.html