Statistics
| Revision:

svn-gvsig-desktop / trunk / org.gvsig.desktop / org.gvsig.desktop.library / org.gvsig.utils / src / main / java / org / gvsig / utils / save / SaveEvent.java @ 40561

History | View | Annotate | Download (3.91 KB)

1
/**
2
 * gvSIG. Desktop Geographic Information System.
3
 *
4
 * Copyright (C) 2007-2013 gvSIG Association.
5
 *
6
 * This program is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU General Public License
8
 * as published by the Free Software Foundation; either version 3
9
 * of the License, or (at your option) any later version.
10
 *
11
 * This program is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 * GNU General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU General Public License
17
 * along with this program; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19
 * MA  02110-1301, USA.
20
 *
21
 * For any additional information, do not hesitate to contact us
22
 * at info AT gvsig.com, or visit our website www.gvsig.com.
23
 */
24
package org.gvsig.utils.save;
25

    
26
import java.io.File;
27
import java.util.EventObject;
28

    
29
/* gvSIG. Geographic Information System of the Valencian Government
30
 *
31
 * Copyright (C) 2007-2008 Infrastructures and Transports Department
32
 * of the Valencian Government (CIT)
33
 * 
34
 * This program is free software; you can redistribute it and/or
35
 * modify it under the terms of the GNU General Public License
36
 * as published by the Free Software Foundation; either version 2
37
 * of the License, or (at your option) any later version.
38
 * 
39
 * This program is distributed in the hope that it will be useful,
40
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
41
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
42
 * GNU General Public License for more details.
43
 *  
44
 * You should have received a copy of the GNU General Public License
45
 * along with this program; if not, write to the Free Software
46
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
47
 * MA  02110-1301, USA.
48
 * 
49
 */
50

    
51
/**
52
 * Event which indicates that a file is going to be saved, or has been saved.
53
 *
54
 * @see BeforeSavingListener
55
 * @see AfterSavingListener
56
 *
57
 * @author Pablo Piqueras Bartolom? (pablo.piqueras@iver.es)
58
 */
59
public class SaveEvent extends EventObject {
60
        private static final long serialVersionUID = -4477418408438214208L;
61

    
62
        /**
63
     * Determines that's going to save a file.
64
     */
65
    public static final short BEFORE_SAVING = 0;
66

    
67
    /**
68
     * Determines that has saved a file.
69
     */
70
    public static final short AFTER_SAVING = 1;
71

    
72
    /**
73
     * Identifies the type of this event.
74
     */
75
    private short id;
76

    
77
    /**
78
     * File to be saved or saved.
79
     */
80
    private File file;
81

    
82
    /**
83
     * <p>Creates a new <code>SaveEvent</code> instance.</p>
84
     * 
85
     * @param source 
86
     * @param id identifies this event
87
     * @param file path of the associated file
88
     */
89
    public SaveEvent(Object source, short id, File file) {
90
                super(source);
91
                this.id = id;
92
                this.file = file;
93
        }
94

    
95
    /**
96
     * Returns a String representation of this EventObject.
97
     *
98
     * @return  A a String representation of this EventObject.
99
     */
100
    public String toString() {
101
        return getClass().getName() + " [" + paramString() + "] on " + (source != null? source.getClass().toString() : "");
102
    }
103

    
104
    /**
105
     * Returns a string representing the kind of this <code>Event</code>.
106
     * 
107
     * @return  a string representation of this event
108
     */
109
    protected String paramString() {
110
            String s_id = null;
111
            
112
            switch(id) {
113
                    case BEFORE_SAVING:
114
                            s_id = "BEFORE SAVE";
115
                            break;
116
                    case AFTER_SAVING:
117
                            s_id = "AFTER SAVE";
118
                            break;
119
            }
120

    
121
        return "ID: " + s_id + " File Absolute Path: " + file.getAbsolutePath();
122
    }
123

    
124
    /**
125
     * Returns the event type.
126
     */
127
    public int getID() {
128
        return id;
129
    }
130

    
131
    /**
132
     * Gets the file saved or going to be saved.
133
     * 
134
     * @return the referenced file
135
     */
136
    public File getFile() {
137
            return file;
138
    }
139
}