jdk

1
/*
2
 * Copyright (c) 2016, 2021, 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.desktop;
27

28
import java.awt.Desktop;
29
import java.awt.GraphicsEnvironment;
30
import java.awt.HeadlessException;
31
import java.io.Serial;
32

33
/**
34
 * Event sent when the displays attached to the system enter and exit power save
35
 * sleep.
36
 *
37
 * @see ScreenSleepListener#screenAboutToSleep(ScreenSleepEvent)
38
 * @see ScreenSleepListener#screenAwoke(ScreenSleepEvent)
39
 * @since 9
40
 */
41
public final class ScreenSleepEvent extends AppEvent {
42

43
    /**
44
     * Use serialVersionUID from JDK 9 for interoperability.
45
     */
46
    @Serial
47
    private static final long serialVersionUID = 7521606180376544150L;
48

49
    /**
50
     * Constructs a {@code ScreenSleepEvent}.
51
     *
52
     * @throws HeadlessException if {@link GraphicsEnvironment#isHeadless()}
53
     *         returns {@code true}
54
     * @throws UnsupportedOperationException if Desktop API is not supported on
55
     *         the current platform
56
     * @see Desktop#isDesktopSupported()
57
     * @see java.awt.GraphicsEnvironment#isHeadless
58
     */
59
    public ScreenSleepEvent() {
60
    }
61
}
62