X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;ds=sidebyside;f=src%2Fbe%2Fnikiroo%2Fjvcard%2FData.java;h=0484adef9c5b339d270c7b8ad6256a80625299d3;hb=f04a32e97c847d7e2551037a4d5f6a070879215c;hp=fa9e7c25223d5563ce12693708b24f36b90bcbe9;hpb=812124d18d08bfc270adab0cd1e289dc6126563b;p=jvcard.git diff --git a/src/be/nikiroo/jvcard/Data.java b/src/be/nikiroo/jvcard/Data.java index fa9e7c2..0484ade 100644 --- a/src/be/nikiroo/jvcard/Data.java +++ b/src/be/nikiroo/jvcard/Data.java @@ -5,19 +5,21 @@ import java.util.LinkedList; import java.util.List; /** - * A data is a piece of information present in a {@link Contact}. It is + * A {@link Data} is a piece of information present in a {@link Contact}. It is * basically a key/value pair with optional types and an optional group name. + *
+ * A {@link Data} can also be binary encoded: in this case, it has an associated
+ * BKey number to identify it.
*
* @author niki
- *
*/
public class Data extends BaseClass
+ * For binary data, as long as the BKey is not processed, it will be 0.
*
- * @return the bkey or -1
+ * @return the bkey, 0 or -1
*/
public int getB64Key() {
return b64;
}
/**
- * Check if this {@link Data} is binary
+ * Check if this {@link Data} is binary (in this case, the BKey will be
+ * present).
*
* @return TRUE if it is
*/
@@ -228,6 +233,9 @@ public class Data extends BaseClass
+ * Will take the backslash character into account (i.e., a backslash can
+ * escape the given separator).
*
* @param value
* the data