org.opencrx.application.uses.ezvcard.property

Class Sound

java.lang.Object

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

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

org.opencrx.application.uses.ezvcard.property.Sound

All Implemented Interfaces:

Comparable<VCardProperty>, HasAltId

public class Sound
extends BinaryProperty<SoundType>

Defines a sound, such as the correct pronunciation of the person's name.

Code sample (creating)

 VCard vcard = new VCard();
 
 //URL
 Sound sound = new Sound("http://www.mywebsite.com/my-name.ogg", SoundType.OGG);
 vcard.addSound(sound);
 
 //binary data
 byte data[] = ...
 sound = new Sound(data, SoundType.OGG);
 vcard.addSound(sound);
 

Code sample (retrieving)

 VCard vcard = ...
 for (Sound sound : vcard.getSounds()){
   SoundType contentType = sound.getContentType(); //e.g. "audio/ogg"
 
   String url = sound.getUrl();
   if (url != null){
     //property value is a URL
     continue;
   }
   
   byte[] data = sound.getData();
   if (data != null){
     //property value is binary data
     continue;
   }
 }
 

Property name: SOUND

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
Sound(byte[] data, SoundType type) Creates a sound property.
Sound(File file, SoundType type) Creates a sound property.
Sound(InputStream in, SoundType type) Creates a sound property.
Sound(String url, SoundType type) Creates a sound property.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLanguage() Gets the language that the property value is written in.
void	setLanguage(String language) Sets the language that the property value is written in.

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

Sound

public Sound(String url,
     SoundType type)

Creates a sound property.

Parameters:

url - the URL to the sound file

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

Sound

public Sound(byte[] data,
     SoundType type)

Creates a sound property.

Parameters:

data - the binary data of the sound file

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

Sound

public Sound(InputStream in,
     SoundType type)
      throws IOException

Creates a sound property.

Parameters:

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

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

Throws:

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

Sound

public Sound(File file,
     SoundType type)
      throws IOException

Creates a sound property.

Parameters:

file - the sound file

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

Throws:

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

Method Detail

getLanguage

public String getLanguage()

Description copied from class: VCardProperty

Gets the language that the property value is written in.

Returns:

the language or null if not set

See Also:

VCardParameters.getLanguage()

setLanguage

public void setLanguage(String language)

Description copied from class: VCardProperty

Sets the language that the property value is written in.

Parameters:

language - the language or null to remove

See Also:

VCardParameters.setLanguage(java.lang.String)