src/java.desktop/share/classes/javax/print/event/PrintServiceAttributeEvent.java
author darcy
Tue, 24 Sep 2019 18:25:54 -0700
changeset 58309 c6f8b2c3dc66
parent 47216 71c04702a3d5
permissions -rw-r--r--
8231334: Suppress warnings on non-serializable instance fields in client libs serializable classes Reviewed-by: prr
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
     2
 * Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1738
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1738
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1738
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1738
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 1738
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.print.event;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import javax.print.PrintService;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import javax.print.attribute.AttributeSetUtilities;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import javax.print.attribute.PrintServiceAttributeSet;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    33
 * Class {@code PrintServiceAttributeEvent} encapsulates an event a Print
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    34
 * Service instance reports to let the client know of changes in the print
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    35
 * service state.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
public class PrintServiceAttributeEvent extends PrintEvent {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    39
    /**
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    40
     * Use serialVersionUID from JDK 1.4 for interoperability.
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    41
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    private static final long serialVersionUID = -7565987018140326600L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    44
    /**
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    45
     * The printing service attributes that changed.
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    46
     */
58309
c6f8b2c3dc66 8231334: Suppress warnings on non-serializable instance fields in client libs serializable classes
darcy
parents: 47216
diff changeset
    47
    @SuppressWarnings("serial") // Not statically typed as Serializable
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    private PrintServiceAttributeSet attributes;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    /**
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    51
     * Constructs a {@code PrintServiceAttributeEvent} object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     *
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    53
     * @param  source the print job generating this event
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    54
     * @param  attributes the attribute changes being reported
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    55
     * @throws IllegalArgumentException if {@code source} is {@code null}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
    public PrintServiceAttributeEvent(PrintService source,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
                                      PrintServiceAttributeSet attributes) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        super(source);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
        this.attributes = AttributeSetUtilities.unmodifiableView(attributes);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * Returns the print service.
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    66
     *
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    67
     * @return {@code PrintService} object
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    public PrintService getPrintService() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
        return (PrintService) getSource();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * Determine the printing service attributes that changed and their new
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
     * values.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     *
47196
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    78
     * @return attributes containing the new values for the service attributes
a3211bb4daff 8184435: Cleanup of javadoc in javax.print package
serb
parents: 35667
diff changeset
    79
     *         that changed. The returned set may be unmodifiable.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    public PrintServiceAttributeSet getAttributes() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
        return attributes;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
}