X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Fjvcard%2FCard.java;h=53ae972a5803d38482333acae7e7fe565e45e34d;hb=176a83279a5aafb7e44cc7c34bf78f0bc35225fe;hp=e82ce7cc933ebb864a2b7b405875d09865d12cf9;hpb=bcb54330afff6a443ab43ee3d38cc7f863c701b7;p=jvcard.git diff --git a/src/be/nikiroo/jvcard/Card.java b/src/be/nikiroo/jvcard/Card.java index e82ce7c..53ae972 100644 --- a/src/be/nikiroo/jvcard/Card.java +++ b/src/be/nikiroo/jvcard/Card.java @@ -3,10 +3,11 @@ package be.nikiroo.jvcard; import java.io.BufferedReader; import java.io.BufferedWriter; import java.io.File; -import java.io.FileReader; +import java.io.FileInputStream; import java.io.FileWriter; import java.io.IOException; -import java.util.ArrayList; +import java.io.InputStreamReader; +import java.security.InvalidParameterException; import java.util.Arrays; import java.util.LinkedList; import java.util.List; @@ -28,15 +29,28 @@ public class Card { private String name; private Format format; + /** + * Create a new {@link Card} from the given {@link File} and {@link Format}. + * + * @param file + * the file containing the {@link Card} data, must not be NULL + * @param format + * the {@link Format} to use to parse it + * + * @throws IOException + * in case of IO error + * @throws NullPointerException + * if file is NULL + * @throws InvalidParameterException + * if format is NULL + */ public Card(File file, Format format) throws IOException { this.file = file; this.format = format; + this.name = file.getName(); - if (file != null) { - name = file.getName(); - } - - BufferedReader buffer = new BufferedReader(new FileReader(file)); + BufferedReader buffer = new BufferedReader(new InputStreamReader( + new FileInputStream(file), "UTF-8")); List lines = new LinkedList(); for (String line = buffer.readLine(); line != null; line = buffer .readLine()) { @@ -50,34 +64,68 @@ public class Card { } /** - * Return the full list of {@link Contact}s. Please use responsibly (this is - * the original list, do not modify the list itself). + * Return the number of {@link Contact} present in this {@link Card}. * - * @return the list of {@link Contact}s + * @return the number of {@link Contact}s */ - public List getContactsList() { - return contacts; + public int size() { + return contacts.size(); } /** - * Return the list of {@link Contact}s. Note that this list is a copy. + * Return the {@link Contact} at index index. + * + * @param index + * the index of the {@link Contact} to find * - * @return the list of {@link Contact}s + * @return the {@link Contact} + * + * @throws IndexOutOfBoundsException + * if the index is < 0 or >= {@link Card#size()} */ - public List getContacts() { - ArrayList list = new ArrayList(size()); - list.addAll(contacts); - return list; + public Contact get(int index) { + return contacts.get(index); } - - public int size() { - return contacts.size(); + + /** + * Add a new {@link Contact} in this {@link Card}. + * + * @param contact + * the new contact + */ + public void add(Contact contact) { + contact.setParent(this); + contact.setDirty(); + contacts.add(contact); } - public Contact get(int index) { - return contacts.get(index); + /** + * Remove the given {@link Contact} from its this {@link Card} if it is in. + * + * @return TRUE in case of success + */ + public boolean remove(Contact contact) { + if (contacts.remove(contact)) { + setDirty(); + } + + return false; } + /** + * Save the {@link Card} to the given {@link File} with the given + * {@link Format}. + * + * @param file + * the {@link File} to save to + * @param format + * the {@link Format} to use + * + * @return TRUE if it was saved + * + * @throws IOException + * in case of IO errors + */ public boolean saveAs(File file, Format format) throws IOException { if (file == null) return false; @@ -93,24 +141,77 @@ public class Card { return true; } + /** + * Save the {@link Card} to the original {@link File} it was open from. + * + * @return TRUE if it was saved + * + * @throws IOException + * in case of IO errors + */ public boolean save() throws IOException { return saveAs(file, format); } + /** + * Return a {@link String} representation of this {@link Card} in the given + * {@link Format}. + * + * @param format + * the {@link Format} to use + * + * @return the {@link String} + */ public String toString(Format format) { return Parser.toString(this, format); } + /** + * Check if this {@link Card} has unsaved changes. + * + * @return TRUE if it has + */ + public boolean isDirty() { + return dirty; + } + + /** + * Return the name of this card (the name of the {@link File} which it was + * opened from). + * + * @return the name + */ + public String getName() { + return name; + } + + @Override public String toString() { return toString(Format.VCard21); } + /** + * Load the given data from the given {@link Format} in this {@link Card}. + * + * @param serializedContent + * the data + * @param format + * the {@link Format} + */ protected void load(String serializedContent, Format format) { // note: fixed size array List lines = Arrays.asList(serializedContent.split("\n")); load(lines, format); } + /** + * Load the given data from the given {@link Format} in this {@link Card}. + * + * @param lines + * the data + * @param format + * the {@link Format} + */ protected void load(List lines, Format format) { this.contacts = Parser.parse(lines, format); setDirty(); @@ -120,19 +221,6 @@ public class Card { } } - public boolean isDirty() { - return dirty; - } - - /** - * Return the name of this card. - * - * @return the name - */ - public String getName() { - return name; - } - /** * Notify that this element has unsaved changes. */