jdoc + some fixes

[jvcard.git] / src / be / nikiroo / jvcard / Contact.java

diff --git a/src/be/nikiroo/jvcard/Contact.java b/src/be/nikiroo/jvcard/Contact.java
index 553ca7680f486f34b1a38e9753dff0b4f06edb99..8142c29a830c4d6dfc82c6a01f0dddc718e62c62 100644 (file)
--- a/src/be/nikiroo/jvcard/Contact.java
+++ b/src/be/nikiroo/jvcard/Contact.java
@@ -58,12 +58,27 @@ public class Contact {
        }
 
        /**
-        * Return the informations (note: this is the actual list, be careful).
+        * Return the number of {@link Data} present in this {@link Contact}.
         * 
-        * @return the list of data anout this contact
+        * @return the number of {@link Data}s
         */
-       public List<Data> getContent() {
-               return datas;
+       public int size() {
+               return datas.size();
+       }
+
+       /**
+        * Return the {@link Data} at index <i>index</i>.
+        * 
+        * @param index
+        *            the index of the {@link Data} to find
+        * 
+        * @return the {@link Data}
+        * 
+        * @throws IndexOutOfBoundsException
+        *             if the index is < 0 or >= {@link Contact#size()}
+        */
+       public Data get(int index) {
+               return datas.get(index);
        }
 
        /**
@@ -78,7 +93,8 @@ public class Contact {
                for (Data data : getData(name)) {
                        if (first == null)
                                first = data;
-                       for (TypeInfo type : data.getTypes()) {
+                       for (int index = 0; index < data.size(); index++) {
+                               TypeInfo type = data.get(index);
                                if (type.getName().equals("TYPE")
                                                && type.getValue().equals("pref")) {
                                        return data;
@@ -407,48 +423,6 @@ public class Contact {
                return str.toArray(new String[] {});
        }
 
-       /**
-        * Add a {@link String} to the given {@link List}, but make sure it does not
-        * exceed the maximum size, and truncate it if needed to fit.
-        * 
-        * @param list
-        * @param add
-        * @param currentSize
-        * @param maxSize
-        * @return
-        */
-       static private int addToList(List<String> list, String add,
-                       int currentSize, int maxSize) {
-               if (add == null || add.length() == 0) {
-                       if (add != null)
-                               list.add(add);
-                       return 0;
-               }
-
-               if (maxSize > -1) {
-                       if (currentSize < maxSize) {
-                               if (currentSize + add.length() >= maxSize) {
-                                       add = add.substring(0, maxSize - currentSize);
-                               }
-                       } else {
-                               add = "";
-                       }
-               }
-
-               list.add(add);
-               return add.length();
-       }
-
-       /**
-        * Return a {@link String} representation of this contact, in vCard 2.1,
-        * without BKeys.
-        * 
-        * @return the {@link String} representation
-        */
-       public String toString() {
-               return toString(Format.VCard21, -1);
-       }
-
        /**
         * Update the information from this contact with the information in the
         * given contact. Non present fields will be removed, new fields will be
@@ -479,6 +453,46 @@ public class Contact {
                setDirty();
        }
 
+       /**
+        * Delete this {@link Contact} from its parent {@link Card} if any.
+        * 
+        * @return TRUE in case of success
+        */
+       public boolean delete() {
+               if (parent != null) {
+                       List<Contact> list = parent.getContactsList();
+                       for (int i = 0; i < list.size(); i++) {
+                               if (list.get(i) == this) {
+                                       list.remove(i);
+                                       parent.setDirty();
+                                       return true;
+                               }
+                       }
+               }
+
+               return false;
+       }
+
+       /**
+        * Check if this {@link Contact} has unsaved changes.
+        * 
+        * @return TRUE if it has
+        */
+       public boolean isDirty() {
+               return dirty;
+       }
+
+       /**
+        * Return a {@link String} representation of this contact, in vCard 2.1,
+        * without BKeys.
+        * 
+        * @return the {@link String} representation
+        */
+       @Override
+       public String toString() {
+               return toString(Format.VCard21, -1);
+       }
+
        /**
         * Mark all the binary fields with a BKey number.
         * 
@@ -503,10 +517,6 @@ public class Contact {
                }
        }
 
-       public boolean isDirty() {
-               return dirty;
-       }
-
        /**
         * Notify that this element has unsaved changes, and notify its parent of
         * the same if any.
@@ -517,6 +527,23 @@ public class Contact {
                        this.parent.setDirty();
        }
 
+       /**
+        * Notify this element <i>and all its descendants</i> that it is in pristine
+        * state (as opposed to dirty).
+        */
+       void setPristine() {
+               dirty = false;
+               for (Data data : datas) {
+                       data.setPristine();
+               }
+       }
+
+       /**
+        * Set the parent of this {@link Contact} <i>and all its descendants</i>.
+        * 
+        * @param parent
+        *            the new parent
+        */
        void setParent(Card parent) {
                this.parent = parent;
                for (Data data : datas) {
@@ -525,33 +552,35 @@ public class Contact {
        }
 
        /**
-        * Delete this {@link Contact} from its parent {@link Card} if any.
+        * Add a {@link String} to the given {@link List}, but make sure it does not
+        * exceed the maximum size, and truncate it if needed to fit.
         * 
-        * @return TRUE in case of success
+        * @param list
+        * @param add
+        * @param currentSize
+        * @param maxSize
+        * @return
         */
-       public boolean delete() {
-               if (parent != null) {
-                       List<Contact> list = parent.getContactsList();
-                       for (int i = 0; i < list.size(); i++) {
-                               if (list.get(i) == this) {
-                                       list.remove(i);
-                                       parent.setDirty();
-                                       return true;
+       static private int addToList(List<String> list, String add,
+                       int currentSize, int maxSize) {
+               if (add == null || add.length() == 0) {
+                       if (add != null)
+                               list.add(add);
+                       return 0;
+               }
+
+               if (maxSize > -1) {
+                       if (currentSize < maxSize) {
+                               if (currentSize + add.length() >= maxSize) {
+                                       add = add.substring(0, maxSize - currentSize);
                                }
+                       } else {
+                               add = "";
                        }
                }
 
-               return false;
+               list.add(add);
+               return add.length();
        }
 
-       /**
-        * Notify this element <i>and all its descendants</i> that it is in pristine
-        * state (as opposed to dirty).
-        */
-       void setPristine() {
-               dirty = false;
-               for (Data data : datas) {
-                       data.setPristine();
-               }
-       }
 }