org.opencrx.application.uses.ezvcard.property

Class Photo

java.lang.Object

org.opencrx.application.uses.ezvcard.property.VCardProperty

org.opencrx.application.uses.ezvcard.property.BinaryProperty<ImageType>

org.opencrx.application.uses.ezvcard.property.ImageProperty

org.opencrx.application.uses.ezvcard.property.Photo

All Implemented Interfaces:

java.lang.Comparable<VCardProperty>, HasAltId

public class Photo
extends ImageProperty

Defines a photo, such as the person's portrait.

Code sample (creating)

 VCard vcard = new VCard();
 
 //URL
 Photo photo = new Photo("http://www.mywebsite.com/my-photo.jpg", ImageType.JPEG);
 vcard.addPhoto(photo);
 
 //binary data
 byte data[] = ...
 photo = new Photo(data, ImageType.JPEG);
 vcard.addPhoto(photo);
 

Code sample (retrieving)

 VCard vcard = ...
 for (Photo photo : vcard.getPhotos()){
   PhotoType contentType = photo.getContentType(); //e.g. "image/jpeg"
 
   String url = photo.getUrl();
   if (url != null){
     //property value is a URL
     continue;
   }
   
   byte[] data = photo.getData();
   if (data != null){
     //property value is binary data
     continue;
   }
 }
 

Property name: PHOTO

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

Field Summary

Fields inherited from class org.opencrx.application.uses.ezvcard.property.BinaryProperty

contentType, data, url

Fields inherited from class org.opencrx.application.uses.ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Photo(byte[] data, ImageType type) Creates a photo property.
Photo(java.io.File file, ImageType type) Creates a photo property.
Photo(java.io.InputStream in, ImageType type) Creates a photo property.
Photo(java.lang.String url, ImageType type) Creates a photo property.

Method Summary

Methods inherited from class org.opencrx.application.uses.ezvcard.property.BinaryProperty

_validate, addPid, getAltId, getContentType, getData, getPids, getPref, getType, getUrl, removePids, setAltId, setContentType, setData, setPref, setType, setUrl

Methods inherited from class org.opencrx.application.uses.ezvcard.property.VCardProperty

_supportedVersions, addParameter, compareTo, getGroup, getParameter, getParameters, getParameters, getSupportedVersions, removeParameter, setGroup, setParameter, setParameters, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Photo

public Photo(java.lang.String url,
             ImageType type)

Creates a photo property.

Parameters:

url - the URL to the photo

type - the content type (e.g. JPEG)

Photo

public Photo(byte[] data,
             ImageType type)

Creates a photo property.

Parameters:

data - the binary data of the photo

type - the content type (e.g. JPEG)

Photo

public Photo(java.io.InputStream in,
             ImageType type)
      throws java.io.IOException

Creates a photo property.

Parameters:

in - an input stream to the binary data (will be closed)

type - the content type (e.g. JPEG)

Throws:

java.io.IOException - if there's a problem reading from the input stream

Photo

public Photo(java.io.File file,
             ImageType type)
      throws java.io.IOException

Creates a photo property.

Parameters:

file - the image file

type - the content type (e.g. JPEG)

Throws:

java.io.IOException - if there's a problem reading from the file