1 /*
  2  * Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
  3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  4  *
  5  * This code is free software; you can redistribute it and/or modify it
  6  * under the terms of the GNU General Public License version 2 only, as
  7  * published by the Free Software Foundation.  Oracle designates this
  8  * particular file as subject to the "Classpath" exception as provided
  9  * by Oracle in the LICENSE file that accompanied this code.
 10  *
 11  * This code is distributed in the hope that it will be useful, but WITHOUT
 12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 14  * version 2 for more details (a copy is included in the LICENSE file that
 15  * accompanied this code).
 16  *
 17  * You should have received a copy of the GNU General Public License version
 18  * 2 along with this work; if not, write to the Free Software Foundation,
 19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 20  *
 21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 22  * or visit www.oracle.com if you need additional information or have any
 23  * questions.
 24  */
 25 
 26 package java.awt;
 27 
 28 /**
 29  * An abstract class which initiates and executes a print job.
 30  * It provides access to a print graphics object which renders
 31  * to an appropriate print device.
 32  *
 33  * @see Toolkit#getPrintJob
 34  *
 35  * @author      Amy Fowler
 36  */
 37 public abstract class PrintJob {
 38 
 39     /**
 40      * Constructor for subclasses to call.
 41      */
 42     protected PrintJob() {}
 43 
 44     /**
 45      * Gets a Graphics object that will draw to the next page.
 46      * The page is sent to the printer when the graphics
 47      * object is disposed.  This graphics object will also implement
 48      * the PrintGraphics interface.
 49      * @see PrintGraphics
 50      * @return the graphics context for printing the next page
 51      */
 52     public abstract Graphics getGraphics();
 53 
 54     /**
 55      * Returns the dimensions of the page in pixels.
 56      * The resolution of the page is chosen so that it
 57      * is similar to the screen resolution.
 58      *
 59      * @return the page dimension
 60      */
 61     public abstract Dimension getPageDimension();
 62 
 63     /**
 64      * Returns the resolution of the page in pixels per inch.
 65      * Note that this doesn't have to correspond to the physical
 66      * resolution of the printer.
 67      *
 68      * @return the page resolution
 69      */
 70     public abstract int getPageResolution();
 71 
 72     /**
 73      * Returns true if the last page will be printed first.
 74      *
 75      * @return {@code true} if the last page will be printed first;
 76      *         otherwise {@code false}
 77      */
 78     public abstract boolean lastPageFirst();
 79 
 80     /**
 81      * Ends the print job and does any necessary cleanup.
 82      */
 83     public abstract void end();
 84 
 85     /**
 86      * Ends this print job once it is no longer referenced.
 87      *
 88      * @deprecated Finalization has been deprecated for removal.  See
 89      * {@link java.lang.Object#finalize} for background information and details
 90      * about migration options.
 91      *
 92      * @see #end
 93      */
 94     @Deprecated(since="9", forRemoval=true)
 95     @SuppressWarnings("removal")
 96     public void finalize() {
 97         end();
 98     }
 99 
100 }