update to latest nikiroo-utils
[jvcard.git] / nikiroo / jvcard / Card.java
1 package be.nikiroo.jvcard;
2
3 import java.io.BufferedWriter;
4 import java.io.File;
5 import java.io.FileWriter;
6 import java.io.IOException;
7 import java.security.InvalidParameterException;
8 import java.util.List;
9
10 import be.nikiroo.jvcard.parsers.Format;
11 import be.nikiroo.jvcard.parsers.Parser;
12
13 /**
14 * A card is a contact information card. It contains data about one or more
15 * contacts.
16 *
17 * @author niki
18 *
19 */
20 public class Card extends BaseClass<Contact> {
21 private File file;
22 private String name;
23 private Format format;
24 private long lastModified;
25
26 /**
27 * Create a new {@link Card} from the given {@link File} and {@link Format}.
28 *
29 * @param file
30 * the input {@link File} containing the {@link Card} data or
31 * NULL for an empty card (usually a {@link File} name or a
32 * network path)
33 * @param format
34 * the {@link Format} to use to parse it
35 *
36 * @throws IOException
37 * in case of IO error
38 * @throws InvalidParameterException
39 * if format is NULL
40 */
41 public Card(File file, Format format) throws IOException {
42 this(Parser.parseContact(file, format));
43
44 if (file != null && file.exists()) {
45 lastModified = file.lastModified();
46 }
47
48 this.format = format;
49
50 if (file != null) {
51 this.file = file;
52 switch (format) {
53 case VCard21:
54 this.name = file.getName().replaceAll(".[vV][cC][fF]$", "");
55 break;
56 case Abook:
57 default:
58 this.name = file.getName();
59 break;
60 }
61 }
62 }
63
64 /**
65 * Create a new {@link Card} from the given {@link Contact}s.
66 *
67 * @param contacts
68 * the input contacts
69 *
70 * @throws IOException
71 * in case of IO error
72 * @throws InvalidParameterException
73 * if format is NULL
74 */
75 public Card(List<Contact> contacts) {
76 super(contacts);
77
78 lastModified = -1;
79 }
80
81 /**
82 * Save the {@link Card} to the given {@link File} with the given
83 * {@link Format}.
84 *
85 * @param file
86 * the output to save to
87 * @param format
88 * the {@link Format} to use
89 *
90 * @return TRUE if it was saved
91 *
92 * @throws IOException
93 * in case of IO errors
94 */
95 public boolean saveAs(File file, Format format) throws IOException {
96 if (file == null)
97 return false;
98
99 BufferedWriter writer = new BufferedWriter(new FileWriter(file));
100 Parser.write(writer, format, this);
101 writer.close();
102
103 if (this.file != null
104 && file.getCanonicalPath().equals(this.file.getCanonicalPath())) {
105 lastModified = file.lastModified();
106 setPristine();
107 }
108
109 return true;
110 }
111
112 /**
113 * Save the {@link Card} to the original {@link File} it was open from.
114 *
115 * @return TRUE if it was saved
116 *
117 * @throws IOException
118 * in case of IO errors
119 */
120 public boolean save() throws IOException {
121 return saveAs(file, format);
122 }
123
124 /**
125 * Reload the data from the input.
126 *
127 * @return TRUE if it was done
128 *
129 * @throws IOException
130 * in case of IO error
131 */
132 public boolean reload() throws IOException {
133 if (file == null)
134 return false;
135
136 this.replaceListContent(Parser.parseContact(file, format));
137 lastModified = file.lastModified();
138 setPristine();
139
140 return true;
141 }
142
143 /**
144 * Return the name of this card (the name of the {@link File} which it was
145 * opened from).
146 *
147 * @return the name
148 */
149 public String getName() {
150 return name;
151 }
152
153 /**
154 * Return the original {@link Format} of the {@link Card}.
155 *
156 * @return the {@link Format}
157 */
158 public Format getFormat() {
159 return format;
160 }
161
162 /**
163 * Return the {@link File} which was used to open this {@link Card}.
164 *
165 * @return the input
166 */
167 public File getFile() {
168 return file;
169 }
170
171 /**
172 * Break the link between this {@link Card} and he {@link File} which was
173 * used to open it if any.
174 */
175 public void unlink() {
176 file = null;
177 lastModified = -1;
178 }
179
180 /**
181 * Return the date of the last modification for this {@link Card} (or -1 if
182 * unknown/new).
183 *
184 * @return the last modified date
185 */
186 public long getLastModified() {
187 return lastModified;
188 }
189
190 @Override
191 public String toString() {
192 return "[Card: " + name + "]";
193 }
194
195 @Override
196 public String getId() {
197 return "" + name;
198 }
199
200 @Override
201 public String getState() {
202 return ("" + name + format).replace(' ', '_');
203 }
204 }