javax.print.attribute

Class Size2DSyntax

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
MediaSize

public abstract class Size2DSyntax
extends Object
implements Cloneable, Serializable

See Also:
Serialized Form

Field Summary

static int
INCH
Constant for units of dots per mircometer to describe an inch.
static int
MM
Constant for units of dots per mircometer to describe a centimeter.

Constructor Summary

Size2DSyntax(float x, float y, int units)
Creates a Size2DSyntax object with the given arguments.
Size2DSyntax(int x, int y, int units)
Creates a Size2DSyntax object with the given arguments.

Method Summary

boolean
equals(Object obj)
Tests of obj is equal to this object.
float[]
getSize(int units)
Return the size described in this object as a two field array.
float
getX(int units)
Return the size in x direction.
protected int
getXMicrometers()
Returns the size in x direction in mircometers.
float
getY(int units)
Return the size in y direction.
protected int
getYMicrometers()
Returns the size in y direction in mircometers.
int
hashCode()
Returns the hashcode for this object.
String
toString()
Returns the string representation for this object.
String
toString(int units, String unitsName)
Returns the string representation for this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INCH

public static final int INCH
Constant for units of dots per mircometer to describe an inch.
Field Value:
25400

MM

public static final int MM
Constant for units of dots per mircometer to describe a centimeter.
Field Value:
1000

Constructor Details

Size2DSyntax

protected Size2DSyntax(float x,
                       float y,
                       int units)
Creates a Size2DSyntax object with the given arguments.
Parameters:
x - the size in x direction
y - the size in y direction
units - the units to use for the sizes
Throws:
IllegalArgumentException - if preconditions fail

Size2DSyntax

protected Size2DSyntax(int x,
                       int y,
                       int units)
Creates a Size2DSyntax object with the given arguments.
Parameters:
x - the size in x direction
y - the size in y direction
units - the units to use for the sizes
Throws:
IllegalArgumentException - if preconditions fail

Method Details

equals

public boolean equals(Object obj)
Tests of obj is equal to this object.
Overrides:
equals in interface Object
Parameters:
obj - the object to test

getSize

public float[] getSize(int units)
Return the size described in this object as a two field array. Index 0 contains the size in x direction, index 1 the size in y direction.
Parameters:
units - the units to use
Returns:
the array that describes the size
Throws:
IllegalArgumentException - if units <321

getX

public float getX(int units)
Return the size in x direction.
Parameters:
units - the units to use
Returns:
the size value
Throws:
IllegalArgumentException - if units <321

getXMicrometers

protected int getXMicrometers()
Returns the size in x direction in mircometers.
Returns:
the size value

getY

public float getY(int units)
Return the size in y direction.
Parameters:
units - the units to use
Returns:
the size value
Throws:
IllegalArgumentException - if units <321

getYMicrometers

protected int getYMicrometers()
Returns the size in y direction in mircometers.
Returns:
the size value

hashCode

public int hashCode()
Returns the hashcode for this object.
Overrides:
hashCode in interface Object
Returns:
the hashcode

toString

public String toString()
Returns the string representation for this object.
Overrides:
toString in interface Object
Returns:
the string representation

toString

public String toString(int units,
                       String unitsName)
Returns the string representation for this object.
Parameters:
units - the units to use
unitsName - the name of the units
Returns:
the string representation

Size2DSyntax.java -- Copyright (C) 2003 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.