java.awt
Class JobAttributes

java.lang.Object
  extended by java.awt.JobAttributes
All Implemented Interfaces:
Cloneable

public final class JobAttributes
extends Object
implements Cloneable

Needs documentation...

Since:
1.3

Nested Class Summary
static class JobAttributes.DefaultSelectionType
           
static class JobAttributes.DestinationType
           
static class JobAttributes.DialogType
           
static class JobAttributes.MultipleDocumentHandlingType
           
static class JobAttributes.SidesType
           
 
Constructor Summary
JobAttributes()
           
JobAttributes(int copies, JobAttributes.DefaultSelectionType selection, JobAttributes.DestinationType destination, JobAttributes.DialogType dialog, String filename, int max, int min, JobAttributes.MultipleDocumentHandlingType multiple, int[][] pageRanges, String printer, JobAttributes.SidesType sides)
           
JobAttributes(JobAttributes attr)
           
 
Method Summary
 Object clone()
          This method may be called to create a new copy of the Object.
 boolean equals(Object o)
          Determine whether this Object is semantically equal to another Object.
 int getCopies()
           
 JobAttributes.DefaultSelectionType getDefaultSelection()
           
 JobAttributes.DestinationType getDestination()
           
 JobAttributes.DialogType getDialog()
           
 String getFileName()
           
 int getFromPage()
           
 int getMaxPage()
           
 int getMinPage()
           
 JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()
           
 int[][] getPageRanges()
           
 String getPrinter()
           
 JobAttributes.SidesType getSides()
           
 int getToPage()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 void set(JobAttributes attr)
           
 void setCopies(int copies)
           
 void setCopiesToDefault()
           
 void setDefaultSelection(JobAttributes.DefaultSelectionType selection)
           
 void setDestination(JobAttributes.DestinationType destination)
           
 void setDialog(JobAttributes.DialogType dialog)
           
 void setFileName(String filename)
           
 void setFromPage(int fromPage)
           
 void setMaxPage(int maxPage)
           
 void setMinPage(int minPage)
           
 void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multiple)
           
 void setMultipleDocumentHandlingToDefault()
           
 void setPageRanges(int[][] pageRanges)
           
 void setPrinter(String printer)
           
 void setSides(JobAttributes.SidesType sides)
           
 void setSidesToDefault()
           
 void setToPage(int toPage)
           
 String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobAttributes

public JobAttributes()

JobAttributes

public JobAttributes(JobAttributes attr)

JobAttributes

public JobAttributes(int copies,
                     JobAttributes.DefaultSelectionType selection,
                     JobAttributes.DestinationType destination,
                     JobAttributes.DialogType dialog,
                     String filename,
                     int max,
                     int min,
                     JobAttributes.MultipleDocumentHandlingType multiple,
                     int[][] pageRanges,
                     String printer,
                     JobAttributes.SidesType sides)
Method Detail

clone

public Object clone()
Description copied from class: Object
This method may be called to create a new copy of the Object. The typical behavior is as follows:

However, these are not strict requirements, and may be violated if necessary. Of the three requirements, the last is the most commonly violated, particularly if the subclass does not override Object.equals(Object).

If the Object you call clone() on does not implement Cloneable (which is a placeholder interface), then a CloneNotSupportedException is thrown. Notice that Object does not implement Cloneable; this method exists as a convenience for subclasses that do.

Object's implementation of clone allocates space for the new Object using the correct class, without calling any constructors, and then fills in all of the new field values with the old field values. Thus, it is a shallow copy. However, subclasses are permitted to make a deep copy.

All array types implement Cloneable, and override this method as follows (it should never fail):

 public Object clone()
 {
   try
     {
       super.clone();
     }
   catch (CloneNotSupportedException e)
     {
       throw new InternalError(e.getMessage());
     }
 }
 

Overrides:
clone in class Object
Returns:
a copy of the Object
See Also:
Cloneable

set

public void set(JobAttributes attr)

getCopies

public int getCopies()

setCopies

public void setCopies(int copies)

setCopiesToDefault

public void setCopiesToDefault()

getDefaultSelection

public JobAttributes.DefaultSelectionType getDefaultSelection()

setDefaultSelection

public void setDefaultSelection(JobAttributes.DefaultSelectionType selection)

getDestination

public JobAttributes.DestinationType getDestination()

setDestination

public void setDestination(JobAttributes.DestinationType destination)

getDialog

public JobAttributes.DialogType getDialog()

setDialog

public void setDialog(JobAttributes.DialogType dialog)

getFileName

public String getFileName()

setFileName

public void setFileName(String filename)

getFromPage

public int getFromPage()

setFromPage

public void setFromPage(int fromPage)

getMaxPage

public int getMaxPage()

setMaxPage

public void setMaxPage(int maxPage)

getMinPage

public int getMinPage()

setMinPage

public void setMinPage(int minPage)

getMultipleDocumentHandling

public JobAttributes.MultipleDocumentHandlingType getMultipleDocumentHandling()

setMultipleDocumentHandling

public void setMultipleDocumentHandling(JobAttributes.MultipleDocumentHandlingType multiple)

setMultipleDocumentHandlingToDefault

public void setMultipleDocumentHandlingToDefault()

getPageRanges

public int[][] getPageRanges()

setPageRanges

public void setPageRanges(int[][] pageRanges)

getPrinter

public String getPrinter()

setPrinter

public void setPrinter(String printer)

getSides

public JobAttributes.SidesType getSides()

setSides

public void setSides(JobAttributes.SidesType sides)

setSidesToDefault

public void setSidesToDefault()

getToPage

public int getToPage()

setToPage

public void setToPage(int toPage)

equals

public boolean equals(Object o)
Description copied from class: Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:
equals in class Object
Parameters:
o - the Object to compare to
Returns:
whether this Object is semantically equal to another
See Also:
Object.hashCode()

hashCode

public int hashCode()
Description copied from class: Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:
hashCode in class Object
Returns:
the hash code for this Object
See Also:
Object.equals(Object), System.identityHashCode(Object)

toString

public String toString()
Description copied from class: Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in class Object
Returns:
the String representing this Object, which may be null
See Also:
Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)