net.wimpi.pim.contact.model
Interface Sound

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DataContainer

public interface Sound
extends java.io.Serializable

An interface modeling a sound based on the types and information of the vCard Mime directory profile standard specification.

For reference see RFC 2426:
3.6.6 SOUND Type Definition

Note that an Image might be either inlined as encoded binary data (MimeBase64 Encoding) or represented by an URI reference.
Should refer to or contain data of an IANA registered sound format for maximum compatibility.

Version:
0.1 (22/07/2003)
Author:
Dieter Wimberger

Method Summary
 java.lang.String getContentType()
          Returns the content type of this Sound.
 byte[] getData()
          Returns the non-encoded binary data representing this Sound.
 byte[] getDataFromURI()
          Returns the data obtained from the uri of this Sound.
 java.io.InputStream getInputStream()
          Returns an InputStream providing access to the data of this Sound.
 java.lang.String getURI()
          Returns the URI reference representing this Sound.
 boolean isData()
          Tests if this Sound is given as binary data.
 boolean isURI()
          Tests if this Sound is given as an URI reference.
 void setContentType(java.lang.String ctype)
          Sets the content type of this Sound.
 void setData(byte[] data)
          Sets the non-encoded binary data representing this Sound.
 void setData(java.lang.String uri)
          Sets the non-encoded binary data as obtained from the given uri.
 void setURI(java.lang.String uri)
          Sets the URI reference representing this Sound.
 

Method Detail

isURI

public boolean isURI()
Tests if this Sound is given as an URI reference.

Returns:
true if given as URI, false otherwise.

getURI

public java.lang.String getURI()
Returns the URI reference representing this Sound.

Returns:
the URI reference as String.

setURI

public void setURI(java.lang.String uri)
Sets the URI reference representing this Sound.

Parameters:
uri - the URI reference as String.

isData

public boolean isData()
Tests if this Sound is given as binary data.

Returns:
true if given as binary data, false otherwise.

getContentType

public java.lang.String getContentType()
Returns the content type of this Sound.

Returns:
the content type as String.

setContentType

public void setContentType(java.lang.String ctype)
Sets the content type of this Sound.

Parameters:
ctype - the content type as String.

getData

public byte[] getData()
Returns the non-encoded binary data representing this Sound.

Returns:
the non-encoded binary data as byte[].

setData

public void setData(byte[] data)
Sets the non-encoded binary data representing this Sound.

Parameters:
data - the non-encoded binary data as byte[].

setData

public void setData(java.lang.String uri)
             throws java.io.IOException,
                    java.net.MalformedURLException
Sets the non-encoded binary data as obtained from the given uri.

Parameters:
uri - an URI as String.
java.io.IOException
java.net.MalformedURLException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException,
                                          java.net.MalformedURLException
Returns an InputStream providing access to the data of this Sound.

An implementation might use a ByteArrayInputStream for inlined data, or return the input stream which can be obtained from the URI (i.e. using java.net.URL).

Returns:
an InputStream instance.
java.io.IOException
java.net.MalformedURLException

getDataFromURI

public byte[] getDataFromURI()
                      throws java.io.IOException,
                             java.net.MalformedURLException
Returns the data obtained from the uri of this Sound.

Returns:
a byte[].
java.io.IOException
java.net.MalformedURLException


Copyright © 2001-2003 jpim team.