ezvcard.property

Class Logo

java.lang.Object

ezvcard.property.VCardProperty

ezvcard.property.BinaryProperty<ImageType>

ezvcard.property.ImageProperty

ezvcard.property.Logo

All Implemented Interfaces:

HasAltId, Comparable<VCardProperty>

public class Logo
extends ImageProperty

Defines a company logo.

Code sample (creating)

 VCard vcard = new VCard();
 
 //URL
 Logo logo = new Logo("http://www.ourcompany.com/our-logo.png", ImageType.PNG);
 vcard.addLogo(logo);
 
 //binary data
 byte data[] = ...
 logo = new Logo(data, ImageType.PNG);
 vcard.addLogo(logo);
 

Code sample (retrieving)

 VCard vcard = ...
 for (Logo logo : vcard.getLogos()) {
   ImageType contentType = logo.getContentType(); //e.g. "image/png"
 
   String url = logo.getUrl();
   if (url != null) {
     //property value is a URL
     continue;
   }
   
   byte[] data = logo.getData();
   if (data != null) {
     //property value is binary data
     continue;
   }
 }
 

Property name: LOGO

Supported versions: 2.1, 3.0, 4.0

Author:

Michael Angstadt

See Also:

RFC 6350 p.40, RFC 2426 p.18, vCard 2.1 p.17

Field Summary

Fields inherited from class ezvcard.property.BinaryProperty

contentType, data, url

Fields inherited from class ezvcard.property.VCardProperty

group, parameters

Constructor Summary

Constructors

Constructor and Description
Logo(byte[] data, ImageType type) Creates a logo property.
Logo(InputStream in, ImageType type) Creates a logo property.
Logo(Logo original) Copy constructor.
Logo(Path file, ImageType type) Creates a logo property.
Logo(String url, ImageType type) Creates a logo property.

Method Summary

Modifier and Type	Method and Description
Logo	copy() Creates a copy of this property object.
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 ezvcard.property.BinaryProperty

_validate, equals, getAltId, getContentType, getData, getPids, getPref, getType, getUrl, hashCode, setAltId, setContentType, setData, setPref, setType, setUrl, toStringValues

Methods inherited from class ezvcard.property.VCardProperty

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Logo

public Logo(String url,
            ImageType type)

Creates a logo property.

Parameters:

url - the URL to the logo

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

Logo

public Logo(byte[] data,
            ImageType type)

Creates a logo property.

Parameters:

data - the binary data of the logo

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

Logo

public Logo(InputStream in,
            ImageType type)
     throws IOException

Creates a logo property.

Parameters:

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

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

Throws:

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

Logo

public Logo(Path file,
            ImageType type)
     throws IOException

Creates a logo property.

Parameters:

file - the image file

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

Throws:

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

Logo

public Logo(Logo original)

Copy constructor.

Parameters:

original - the property to make a copy of

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

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

copy

public Logo copy()

Description copied from class: VCardProperty

Creates a copy of this property object.

The default implementation of this method uses reflection to look for a copy constructor. Child classes SHOULD override this method to avoid the performance overhead involved in using reflection.

The child class's copy constructor, if present, MUST invoke the VCardProperty.VCardProperty(VCardProperty) super constructor to ensure that the group name and parameters are also copied.

This method MUST be overridden by the child class if the child class does not have a copy constructor. Otherwise, an UnsupportedOperationException will be thrown when an attempt is made to copy the property (such as in the VCard class's copy constructor).

Overrides:

copy in class VCardProperty

Returns:

the copy