aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/service/sysactivity/event/SystemActivityEvent.java
blob: fa5df5162a058e63da6f3cbcf9c02b99196fbeec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.service.sysactivity.event;

import java.util.*;

/**
 * An event class representing system activity that has occurred.
 * The event id indicates the exact reason for this event.
 * @author Damian Minkov
 */
public class SystemActivityEvent
    extends EventObject
{
    /**
     * Serial version UID.
     */
    private static final long serialVersionUID = 0L;

    /**
     * Notify that computers is going to sleep.
     */
    public static final int EVENT_SLEEP = 0;

    /**
     * Notify that computer is wakeing up after stand by.
     */
    public static final int EVENT_WAKE = 1;

    /**
     * Computer display has stand by.
     */
    public static final int EVENT_DISPLAY_SLEEP = 2;

    /**
     * Computer display wakes up after stand by.
     */
    public static final int EVENT_DISPLAY_WAKE = 3;

    /**
     * Screensaver has been started.
     */
    public static final int EVENT_SCREENSAVER_START = 4;

    /**
     * Screensaver will stop.
     */
    public static final int EVENT_SCREENSAVER_WILL_STOP = 5;

    /**
     * Screensaver has been stopped.
     */
    public static final int EVENT_SCREENSAVER_STOP = 6;

    /**
     * Screen has been locked.
     */
    public static final int EVENT_SCREEN_LOCKED = 7;

    /**
     * Screen has been unlocked.
     */
    public static final int EVENT_SCREEN_UNLOCKED = 8;

    /**
     * A change in network configuration has occurred.
     */
    public static final int EVENT_NETWORK_CHANGE = 9;

    /**
     * A system idle event has occurred.
     */
    public static final int EVENT_SYSTEM_IDLE = 10;

    /**
     * A system was in idle state and now exits.
     */
    public static final int EVENT_SYSTEM_IDLE_END = 11;

    /**
     * A change in dns configuration has occurred.
     */
    public static final int EVENT_DNS_CHANGE = 12;

    /**
     * Informing that the machine is logging of or shutting down.
     */
    public static final int EVENT_QUERY_ENDSESSION = 13;

    /**
     * The log off or shutdown is in process for us, no matter
     * what other process has replied, whether one of them has canceled
     * or not the current end of session. It's like that cause we have answered
     * that we will shutdown.
     */
    public static final int EVENT_ENDSESSION = 14;

    /**
     * The type of the event.
     */
    private final int eventID;

    /**
     * Constructs a prototypical Event.
     *
     * @param source The object on which the Event initially occurred.
     * @param eventID the type of the event.
     * @throws IllegalArgumentException if source is null.
     */
    public SystemActivityEvent(Object source, int eventID)
    {
        super(source);

        this.eventID = eventID;
    }

    /**
     * Returns the type of the event.
     * @return the event ID
     */
    public int getEventID()
    {
        return this.eventID;
    }

    /**
     * Returns a String representation of this SystemActivityEvent object.
     *
     * @return  A a String representation of this SystemActivityEvent object.
     */
    @Override
    public String toString() {
        return getClass().getName() + "[eventID=" + eventID + "]";
    }
}