Update lanterna, fix bugs, implement save...
[jvcard.git] / src / be / nikiroo / jvcard / Contact.java
index 08d5eee0fdcfe25588d37f466293225af6c17217..643631314d0adbbdb06356991238e2195647fd8a 100644 (file)
@@ -151,15 +151,129 @@ public class Contact {
         * 
         * @param format
         *            the format to use
+        * 
+        * @return the {@link String} representation
+        */
+       public String toString(String format) {
+               return toString(format, "|", null, -1);
+       }
+
+       /**
+        * Return a {@link String} representation of this contact formated
+        * accordingly to the given format.
+        * 
+        * The format is basically a list of field names separated by a pipe and
+        * optionally parametrised. The parameters allows you to:
+        * <ul>
+        * <li>@x: show only a present/not present info</li>
+        * <li>@n: limit the size to a fixed value 'n'</li>
+        * <li>@+: expand the size of this field as much as possible</li>
+        * </ul>
+        * 
+        * Example: "N@10|FN@20|NICK@+|PHOTO@x"
+        * 
+        * @param format
+        *            the format to use
+        * @param separator
+        *            the separator {@link String} to use between fields
+        * @param padding
+        *            the {@link String} to use for left and right padding
+        * @param width
+        *            a fixed width or -1 for "as long as needed"
+        * 
+        * @return the {@link String} representation
+        */
+       public String toString(String format, String separator, String padding,
+                       int width) {
+               StringBuilder builder = new StringBuilder();
+
+               for (String str : toStringArray(format, separator, padding, width)) {
+                       builder.append(str);
+               }
+
+               return builder.toString();
+       }
+
+       /**
+        * Return a {@link String} representation of this contact formated
+        * accordingly to the given format, part by part.
+        * 
+        * The format is basically a list of field names separated by a pipe and
+        * optionally parametrised. The parameters allows you to:
+        * <ul>
+        * <li>@x: show only a present/not present info</li>
+        * <li>@n: limit the size to a fixed value 'n'</li>
+        * <li>@+: expand the size of this field as much as possible</li>
+        * </ul>
+        * 
+        * Example: "N@10|FN@20|NICK@+|PHOTO@x"
+        * 
+        * @param format
+        *            the format to use
         * @param separator
         *            the separator {@link String} to use between fields
+        * @param padding
+        *            the {@link String} to use for left and right padding
+        * @param width
+        *            a fixed width or -1 for "as long as needed"
+        * 
+        * @return the {@link String} representation
+        */
+       public String[] toStringArray(String format, String separator,
+                       String padding, int width) {
+               if (width > -1) {
+                       int numOfFields = format.split("\\|").length;
+                       if (separator != null)
+                               width -= (numOfFields - 1) * separator.length();
+                       if (padding != null)
+                               width -= (numOfFields) * (2 * padding.length());
+
+                       if (width < 0)
+                               width = 0;
+               }
+
+               List<String> str = new LinkedList<String>();
+
+               boolean first = true;
+               for (String s : toStringArray(format, width)) {
+                       if (!first) {
+                               str.add(separator);
+                       }
+
+                       if (padding != null)
+                               str.add(padding + s + padding);
+                       else
+                               str.add(s);
+
+                       first = false;
+               }
+
+               return str.toArray(new String[] {});
+       }
+
+       /**
+        * Return a {@link String} representation of this contact formated
+        * accordingly to the given format, part by part.
+        * 
+        * The format is basically a list of field names separated by a pipe and
+        * optionally parametrised. The parameters allows you to:
+        * <ul>
+        * <li>@x: show only a present/not present info</li>
+        * <li>@n: limit the size to a fixed value 'n'</li>
+        * <li>@+: expand the size of this field as much as possible</li>
+        * </ul>
+        * 
+        * Example: "N@10|FN@20|NICK@+|PHOTO@x"
+        * 
+        * @param format
+        *            the format to use
         * @param width
         *            a fixed width or -1 for "as long as needed"
         * 
         * @return the {@link String} representation
         */
-       public String toString(String format, String separator, int width) {
-               String str = null;
+       public String[] toStringArray(String format, int width) {
+               List<String> str = new LinkedList<String>();
 
                String[] formatFields = format.split("\\|");
                String[] values = new String[formatFields.length];
@@ -169,22 +283,11 @@ public class Contact {
                int totalSize = 0;
 
                if (width == 0) {
-                       return "";
-               }
-
-               if (width > -1 && separator != null && separator.length() > 0
-                               && formatFields.length > 1) {
-                       int swidth = (formatFields.length - 1) * separator.length();
-                       if (swidth >= width) {
-                               str = separator;
-                               while (str.length() < width) {
-                                       str += separator;
-                               }
-
-                               return str.substring(0, width);
+                       for (int i = 0; i < formatFields.length; i++) {
+                               str.add("");
                        }
 
-                       width -= swidth;
+                       return str.toArray(new String[] {});
                }
 
                for (int i = 0; i < formatFields.length; i++) {
@@ -236,7 +339,7 @@ public class Contact {
                                totalSize += value.length();
                        }
                }
-               
+
                if (width > -1 && totalSize > width) {
                        int toDo = totalSize - width;
                        for (int i = fixedsizeFields.length - 1; toDo > 0 && i >= 0; i--) {
@@ -257,7 +360,7 @@ public class Contact {
 
                        totalSize = width + toDo;
                }
-               
+
                if (width > -1 && numOfFieldsToExpand > 0) {
                        int availablePadding = width - totalSize;
 
@@ -268,15 +371,11 @@ public class Contact {
                                for (int i = 0; i < values.length; i++) {
                                        if (expandedFields[i]) {
                                                if (remainder > 0) {
-                                                       values[i] = values[i]
-                                                                       + new String(new char[remainder]).replace(
-                                                                                       '\0', ' ');
+                                                       values[i] = values[i] + fixedString("", remainder);
                                                        remainder = 0;
                                                }
                                                if (padPerItem > 0) {
-                                                       values[i] = values[i]
-                                                                       + new String(new char[padPerItem]).replace(
-                                                                                       '\0', ' ');
+                                                       values[i] = values[i] + fixedString("", padPerItem);
                                                }
                                        }
                                }
@@ -284,23 +383,13 @@ public class Contact {
                                totalSize = width;
                        }
                }
-               
-               for (String field : values) {
-                       if (str == null) {
-                               str = field;
-                       } else {
-                               str += separator + field;
-                       }
-               }
-
-               if (str == null)
-                       str = "";
 
-               if (width > -1) {
-                       str = fixedString(str, width);
+               int currentSize = 0;
+               for (int i = 0; i < values.length; i++) {
+                       currentSize += addToList(str, values[i], currentSize, width);
                }
 
-               return str;
+               return str.toArray(new String[] {});
        }
 
        /**
@@ -317,15 +406,48 @@ public class Contact {
        static private String fixedString(String string, int size) {
                int length = string.length();
 
-               if (length > size)
+               if (length > size) {
                        string = string.substring(0, size);
-               else if (length < size)
+               } else if (length < size) {
                        string = string
                                        + new String(new char[size - length]).replace('\0', ' ');
+               }
 
                return 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.
@@ -404,10 +526,41 @@ public class Contact {
                        this.parent.setDirty();
        }
 
-       public void setParent(Card parent) {
+       void setParent(Card parent) {
                this.parent = parent;
                for (Data data : datas) {
                        data.setParent(this);
                }
        }
+       
+       /**
+        * 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;
+       }
+
+       /**
+        * 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();
+               }
+       }
 }